C
C
Google Contacts - Retrieve All Contacts
See more Google APIs Examples
Demonstrates how to retrieve the full list of contacts for the Google Contacts API.Chilkat C Downloads
#include <C_CkJsonObject.h>
#include <C_CkAuthGoogle.h>
#include <C_CkRest.h>
#include <C_CkStringBuilder.h>
#include <C_CkXml.h>
#include <C_CkFileAccess.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObject jsonToken;
HCkAuthGoogle gAuth;
HCkRest rest;
BOOL bAutoReconnect;
HCkStringBuilder sbResponseBody;
HCkXml xml;
int totalResults;
int startIndex;
int itemsPerPage;
HCkFileAccess fac;
int numEntries;
int i;
const char *idUrl;
const char *contactId;
const char *fullName;
const char *emailAddress;
success = FALSE;
// 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 = CkJsonObject_Create();
success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/googleContacts.json");
if (success != TRUE) {
printf("Failed to load googleContacts.json\n");
CkJsonObject_Dispose(jsonToken);
return;
}
gAuth = CkAuthGoogle_Create();
CkAuthGoogle_putAccessToken(gAuth,CkJsonObject_stringOf(jsonToken,"access_token"));
rest = CkRest_Create();
// Connect using TLS.
bAutoReconnect = TRUE;
success = CkRest_Connect(rest,"www.google.com",443,TRUE,bAutoReconnect);
// Provide the authentication credentials (i.e. the access token)
CkRest_SetAuthGoogle(rest,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
CkRest_AddHeader(rest,"GData-Version","3.0");
sbResponseBody = CkStringBuilder_Create();
success = CkRest_FullRequestNoBodySb(rest,"GET","/m8/feeds/contacts/default/full",sbResponseBody);
if (success != TRUE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkAuthGoogle_Dispose(gAuth);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
// A successful response will have a status code equal to 200.
if (CkRest_getResponseStatusCode(rest) != 200) {
printf("response status code = %d\n",CkRest_getResponseStatusCode(rest));
printf("response status text = %s\n",CkRest_responseStatusText(rest));
printf("response header: %s\n",CkRest_responseHeader(rest));
printf("response body: %s\n",CkStringBuilder_getAsString(sbResponseBody));
CkJsonObject_Dispose(jsonToken);
CkAuthGoogle_Dispose(gAuth);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
// If the 200 response was received, then the contacts XML is contained
// in the response body.
xml = CkXml_Create();
CkXml_LoadSb(xml,sbResponseBody,FALSE);
// See below for a sample response body.
CkXml_SaveXml(xml,"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 = CkXml_GetChildIntValue(xml,"openSearch:totalResults");
startIndex = CkXml_GetChildIntValue(xml,"openSearch:startIndex");
itemsPerPage = CkXml_GetChildIntValue(xml,"openSearch:itemsPerPage");
printf("totalResults = %d\n",totalResults);
printf("startIndex = %d\n",startIndex);
printf("itemsPerPage = %d\n",itemsPerPage);
// We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
fac = CkFileAccess_Create();
// Iterate over each contact.
numEntries = CkXml_NumChildrenHavingTag(xml,"entry");
i = 0;
while (i < numEntries) {
CkXml_putI(xml,i);
printf("%d ----\n",i + 1);
printf("title: %s\n",CkXml_getChildContent(xml,"entry[i]|title"));
// 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 = CkXml_getChildContent(xml,"entry[i]|id");
printf("id: %s\n",idUrl);
// Use the parsing ability of GetFileName to get the contactId
contactId = CkFileAccess_getFileName(fac,idUrl);
printf("contactId: %s\n",contactId);
fullName = CkXml_chilkatPath(xml,"entry[i]|gd:name|gd:fullName|*");
if (CkXml_getLastMethodSuccess(xml) == TRUE) {
printf("fullName: %s\n",fullName);
}
emailAddress = CkXml_chilkatPath(xml,"entry[i]|gd:email|(address)");
if (CkXml_getLastMethodSuccess(xml) == TRUE) {
printf("email address: %s\n",emailAddress);
}
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>
//
CkJsonObject_Dispose(jsonToken);
CkAuthGoogle_Dispose(gAuth);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbResponseBody);
CkXml_Dispose(xml);
CkFileAccess_Dispose(fac);
}