(Delphi DLL) Google Contacts - Retrieve All Contacts

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

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, AuthGoogle, FileAccess, Rest, JsonObject, StringBuilder, Xml;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
success: Boolean;
gAuth: HCkAuthGoogle;
rest: HCkRest;
bAutoReconnect: Boolean;
sbResponseBody: HCkStringBuilder;
xml: HCkXml;
totalResults: Integer;
startIndex: Integer;
itemsPerPage: Integer;
fac: HCkFileAccess;
numEntries: Integer;
i: Integer;
idUrl: PWideChar;
contactId: PWideChar;
fullName: PWideChar;
emailAddress: PWideChar;

begin
// 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) then
  begin
    Memo1.Lines.Add('Failed to load googleContacts.json');
    Exit;
  end;

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) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// A successful response will have a status code equal to 200.
if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add('response status code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('response status text = ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('response header: ' + CkRest__responseHeader(rest));
    Memo1.Lines.Add('response body: ' + CkStringBuilder__getAsString(sbResponseBody));
    Exit;
  end;

// 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');
Memo1.Lines.Add('totalResults = ' + IntToStr(totalResults));
Memo1.Lines.Add('startIndex = ' + IntToStr(startIndex));
Memo1.Lines.Add('itemsPerPage = ' + IntToStr(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 do
  begin
    CkXml_putI(xml,i);
    Memo1.Lines.Add(IntToStr(i + 1) + ' ----');
    Memo1.Lines.Add('title: ' + 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');
    Memo1.Lines.Add('id: ' + idUrl);

    // Use the parsing ability of GetFileName to get the contactId
    contactId := CkFileAccess__getFileName(fac,idUrl);
    Memo1.Lines.Add('contactId: ' + contactId);

    fullName := CkXml__chilkatPath(xml,'entry[i]|gd:name|gd:fullName|*');
    if (CkXml_getLastMethodSuccess(xml) = True) then
      begin
        Memo1.Lines.Add('fullName: ' + fullName);
      end;

    emailAddress := CkXml__chilkatPath(xml,'entry[i]|gd:email|(address)');
    if (CkXml_getLastMethodSuccess(xml) = True) then
      begin
        Memo1.Lines.Add('email address: ' + emailAddress);
      end;

    i := i + 1;
  end;

// 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);

end;