(Visual FoxPro) Google Contacts - Retrieve All Contacts

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loGAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL loSbResponseBody
LOCAL loXml
LOCAL lnTotalResults
LOCAL lnStartIndex
LOCAL lnItemsPerPage
LOCAL loFac
LOCAL lnNumEntries
LOCAL i
LOCAL lcIdUrl
LOCAL lcContactId
LOCAL lcFullName
LOCAL lcEmailAddress

* 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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/googleContacts.json")
IF (lnSuccess <> 1) THEN
    ? "Failed to load googleContacts.json"
    RELEASE loJsonToken
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.AuthGoogle')
loGAuth = CreateObject('Chilkat.AuthGoogle')
loGAuth.AccessToken = loJsonToken.StringOf("access_token")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')

* Connect using TLS.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("www.google.com",443,1,lnBAutoReconnect)

* Provide the authentication credentials (i.e. the access token)
loRest.SetAuthGoogle(loGAuth)

* ----------------------------------------------
* 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

loRest.AddHeader("GData-Version","3.0")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",loSbResponseBody)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loGAuth
    RELEASE loRest
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* A successful response will have a status code equal to 200.
IF (loRest.ResponseStatusCode <> 200) THEN
    ? "response status code = " + STR(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body: " + loSbResponseBody.GetAsString()
    RELEASE loJsonToken
    RELEASE loGAuth
    RELEASE loRest
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* If the 200 response was received, then the contacts XML is contained
* in the response body.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loXml = CreateObject('Chilkat.Xml')
loXml.LoadSb(loSbResponseBody,0)

* See below for a sample response body.
loXml.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.
lnTotalResults = loXml.GetChildIntValue("openSearch:totalResults")
lnStartIndex = loXml.GetChildIntValue("openSearch:startIndex")
lnItemsPerPage = loXml.GetChildIntValue("openSearch:itemsPerPage")
? "totalResults = " + STR(lnTotalResults)
? "startIndex = " + STR(lnStartIndex)
? "itemsPerPage = " + STR(lnItemsPerPage)

* We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.FileAccess')
loFac = CreateObject('Chilkat.FileAccess')

* Iterate over each contact.
lnNumEntries = loXml.NumChildrenHavingTag("entry")
i = 0
DO WHILE i < lnNumEntries
    loXml.I = i
    ? STR(i + 1) + " ----"
    ? "title: " + loXml.GetChildContent("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..
    lcIdUrl = loXml.GetChildContent("entry[i]|id")
    ? "id: " + lcIdUrl

    * Use the parsing ability of GetFileName to get the contactId
    lcContactId = loFac.GetFileName(lcIdUrl)
    ? "contactId: " + lcContactId

    lcFullName = loXml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
    IF (loXml.LastMethodSuccess = 1) THEN
        ? "fullName: " + lcFullName
    ENDIF

    lcEmailAddress = loXml.ChilkatPath("entry[i]|gd:email|(address)")
    IF (loXml.LastMethodSuccess = 1) THEN
        ? "email address: " + lcEmailAddress
    ENDIF

    i = i + 1
ENDDO

* 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>
* 

RELEASE loJsonToken
RELEASE loGAuth
RELEASE loRest
RELEASE loSbResponseBody
RELEASE loXml
RELEASE loFac