Perl

Google Contacts - Retrieve All Contacts

See more Google APIs Examples

Demonstrates how to retrieve the full list of contacts for the Google Contacts API. Perl

use chilkat();

$success = 0;

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# --------------------------------------------------------------------------------------------------------
# Note: The code for setting up the Chilkat REST object and making the initial connection can be done once.
# Once connected, the REST object may be re-used for many REST API calls.
# (It's a good idea to put the connection setup code in a separate function/subroutine.)
# --------------------------------------------------------------------------------------------------------

# It is assumed we previously obtained an OAuth2 access token.
# This example loads the JSON access token file 
# saved by this example: Get Google Contacts OAuth2 Access Token

$jsonToken = chilkat::CkJsonObject->new();
$success = $jsonToken->LoadFile("qa_data/tokens/googleContacts.json");
if ($success != 1) {
    print "Failed to load googleContacts.json" . "\r\n";
    exit;
}

$gAuth = chilkat::CkAuthGoogle->new();
$gAuth->put_AccessToken($jsonToken->stringOf("access_token"));

$rest = chilkat::CkRest->new();

# Connect using TLS.
$bAutoReconnect = 1;
$success = $rest->Connect("www.google.com",443,1,$bAutoReconnect);

# Provide the authentication credentials (i.e. the access token)
$rest->SetAuthGoogle($gAuth);

# ----------------------------------------------
# OK, the REST connection setup is completed..
# ----------------------------------------------

# To retrieve the contacts, we need to send the following:

# 	GET /m8/feeds/contacts/default/full
# 	GData-Version: 3.0

$rest->AddHeader("GData-Version","3.0");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# A successful response will have a status code equal to 200.
if ($rest->get_ResponseStatusCode() != 200) {
    print "response status code = " . $rest->get_ResponseStatusCode() . "\r\n";
    print "response status text = " . $rest->responseStatusText() . "\r\n";
    print "response header: " . $rest->responseHeader() . "\r\n";
    print "response body: " . $sbResponseBody->getAsString() . "\r\n";
    exit;
}

# If the 200 response was received, then the contacts XML is contained
# in the response body.
$xml = chilkat::CkXml->new();
$xml->LoadSb($sbResponseBody,0);

# See below for a sample response body.
$xml->SaveXml("qa_output/google_contacts.xml");

# Now let's parse the XML...

# Get the the total number of results, the start index, and the items per page.
# We'll likely NOT get the full list, but will instead get the 1st page.
$totalResults = $xml->GetChildIntValue("openSearch:totalResults");
$startIndex = $xml->GetChildIntValue("openSearch:startIndex");
$itemsPerPage = $xml->GetChildIntValue("openSearch:itemsPerPage");
print "totalResults = " . $totalResults . "\r\n";
print "startIndex = " . $startIndex . "\r\n";
print "itemsPerPage = " . $itemsPerPage . "\r\n";

# We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
$fac = chilkat::CkFileAccess->new();

# Iterate over each contact.
$numEntries = $xml->NumChildrenHavingTag("entry");
$i = 0;
while ($i < $numEntries) {
    $xml->put_I($i);
    print ($i + 1) . " ----" . "\r\n";
    print "title: " . $xml->getChildContent("entry[i]|title") . "\r\n";

    # The entry "id" child contains a URL having this format:
    # <id>http://www.google.com/m8/feeds/contacts/{userEmail}/base/{contactId}</id>
    # Let's get the URL and parse the contactId from it..
    $idUrl = $xml->getChildContent("entry[i]|id");
    print "id: " . $idUrl . "\r\n";

    # Use the parsing ability of GetFileName to get the contactId
    $contactId = $fac->getFileName($idUrl);
    print "contactId: " . $contactId . "\r\n";

    $fullName = $xml->chilkatPath("entry[i]|gd:name|gd:fullName|*");
    if ($xml->get_LastMethodSuccess() == 1) {
        print "fullName: " . $fullName . "\r\n";
    }

    $emailAddress = $xml->chilkatPath("entry[i]|gd:email|(address)");
    if ($xml->get_LastMethodSuccess() == 1) {
        print "email address: " . $emailAddress . "\r\n";
    }

    $i = $i + 1;
}

# The response body XML looks something like this:

# 	<feed xmlns="http://www.w3.org/2005/Atom"
# 	    xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/"
# 	    xmlns:gContact="http://schemas.google.com/contact/2008"
# 	    xmlns:batch="http://schemas.google.com/gdata/batch"
# 	    xmlns:gd="http://schemas.google.com/g/2005"
# 	    gd:etag="feedEtag">
# 	  <id>userEmail</id>
# 	  <updated>2008-12-10T10:04:15.446Z</updated>
# 	  <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>
# 	  <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml"
# 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full"/>
# 	  <link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml"
# 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full"/>
# 	  <link rel="http://schemas.google.com/g/2005#batch" type="application/atom+xml"
# 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full/batch"/>
# 	  <link rel="self" type="application/atom+xml"
# 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full?max-results=25"/>
# 	  <author>
# 	    <name>User</name>
# 	    <email>userEmail</email>
# 	  </author>
# 	  <generator version="1.0" uri="http://www.google.com/m8/feeds">
# 	    Contacts
# 	  </generator>
# 	  <openSearch:totalResults>349</openSearch:totalResults>
# 	  <openSearch:startIndex>1</openSearch:startIndex>
# 	  <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
# 	  <entry gd:etag="contactEtag">
# 	    <id>
# 	      http://www.google.com/m8/feeds/contacts/userEmail/base/contactId
# 	    </id>
# 	    <updated>2008-12-10T04:45:03.331Z</updated>
# 	    <app:edited xmlns:app="http://www.w3.org/2007/app">2008-12-10T04:45:03.331Z</app:edited>
# 	    <category scheme="http://schemas.google.com/g/2005#kind"
# 	        term="http://schemas.google.com/contact/2008#contact"/>
# 	    <title>Fitzwilliam Darcy</title>
# 	    <gd:name>
# 	      <gd:fullName>Fitzwilliam Darcy</gd:fullName>
# 	    </gd:name>
# 	    <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*"
# 	        href="https://www.google.com/m8/feeds/photos/media/userEmail/contactId"
# 	        gd:etag="photoEtag"/>
# 	    <link rel="self" type="application/atom+xml"
# 	        href="https://www.google.com/m8/feeds/contacts/userEmail/full/contactId"/>
# 	    <link rel="edit" type="application/atom+xml"
# 	        href="https://www.google.com/m8/feeds/contacts/userEmail/full/contactId"/>
# 	    <gd:phoneNumber rel="http://schemas.google.com/g/2005#home"
# 	        primary="true">
# 	      456
# 	    </gd:phoneNumber>
# 	    <gd:extendedProperty name="pet" value="hamster"/>
# 	    <gContact:groupMembershipInfo deleted="false"
# 	        href="http://www.google.com/m8/feeds/groups/userEmail/base/groupId"/>
#         <gd:email rel="http://schemas.google.com/g/2005#other" address="darcyf@example.com" primary="true" />
# 	  </entry>
# 	  <!-- Other entries ... -->
# 	</feed>
#