DataFlex
DataFlex
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 DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoJsonToken
Variant vGAuth
Handle hoGAuth
Handle hoRest
Boolean iBAutoReconnect
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoXml
Integer iTotalResults
Integer iStartIndex
Integer iItemsPerPage
Handle hoFac
Integer iNumEntries
Integer i
String sIdUrl
String sContactId
String sFullName
String sEmailAddress
String sTemp1
Integer iTemp1
Boolean bTemp1
Move False To iSuccess
// 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
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
Get ComLoadFile Of hoJsonToken "qa_data/tokens/googleContacts.json" To iSuccess
If (iSuccess <> True) Begin
Showln "Failed to load googleContacts.json"
Procedure_Return
End
Get Create (RefClass(cComChilkatAuthGoogle)) To hoGAuth
If (Not(IsComObjectCreated(hoGAuth))) Begin
Send CreateComObject of hoGAuth
End
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Set ComAccessToken Of hoGAuth To sTemp1
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
// Connect using TLS.
Move True To iBAutoReconnect
Get ComConnect Of hoRest "www.google.com" 443 True iBAutoReconnect To iSuccess
// Provide the authentication credentials (i.e. the access token)
Get pvComObject of hoGAuth to vGAuth
Get ComSetAuthGoogle Of hoRest vGAuth To iSuccess
// ----------------------------------------------
// 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
Get ComAddHeader Of hoRest "GData-Version" "3.0" To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComFullRequestNoBodySb Of hoRest "GET" "/m8/feeds/contacts/default/full" vSbResponseBody To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
// A successful response will have a status code equal to 200.
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 200) Begin
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "response status code = " iTemp1
Get ComResponseStatusText Of hoRest To sTemp1
Showln "response status text = " sTemp1
Get ComResponseHeader Of hoRest To sTemp1
Showln "response header: " sTemp1
Get ComGetAsString Of hoSbResponseBody To sTemp1
Showln "response body: " sTemp1
Procedure_Return
End
// If the 200 response was received, then the contacts XML is contained
// in the response body.
Get Create (RefClass(cComChilkatXml)) To hoXml
If (Not(IsComObjectCreated(hoXml))) Begin
Send CreateComObject of hoXml
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoXml vSbResponseBody False To iSuccess
// See below for a sample response body.
Get ComSaveXml Of hoXml "qa_output/google_contacts.xml" To iSuccess
// 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.
Get ComGetChildIntValue Of hoXml "openSearch:totalResults" To iTotalResults
Get ComGetChildIntValue Of hoXml "openSearch:startIndex" To iStartIndex
Get ComGetChildIntValue Of hoXml "openSearch:itemsPerPage" To iItemsPerPage
Showln "totalResults = " iTotalResults
Showln "startIndex = " iStartIndex
Showln "itemsPerPage = " iItemsPerPage
// We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
Get Create (RefClass(cComCkFileAccess)) To hoFac
If (Not(IsComObjectCreated(hoFac))) Begin
Send CreateComObject of hoFac
End
// Iterate over each contact.
Get ComNumChildrenHavingTag Of hoXml "entry" To iNumEntries
Move 0 To i
While (i < iNumEntries)
Set ComI Of hoXml To i
Showln (i + 1) " ----"
Get ComGetChildContent Of hoXml "entry[i]|title" To sTemp1
Showln "title: " sTemp1
// 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..
Get ComGetChildContent Of hoXml "entry[i]|id" To sIdUrl
Showln "id: " sIdUrl
// Use the parsing ability of GetFileName to get the contactId
Get ComGetFileName Of hoFac sIdUrl To sContactId
Showln "contactId: " sContactId
Get ComChilkatPath Of hoXml "entry[i]|gd:name|gd:fullName|*" To sFullName
Get ComLastMethodSuccess Of hoXml To bTemp1
If (bTemp1 = True) Begin
Showln "fullName: " sFullName
End
Get ComChilkatPath Of hoXml "entry[i]|gd:email|(address)" To sEmailAddress
Get ComLastMethodSuccess Of hoXml To bTemp1
If (bTemp1 = True) Begin
Showln "email address: " sEmailAddress
End
Move (i + 1) To i
Loop
// 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>
//
End_Procedure