(PureBasic) Google Contacts - Retrieve All Contacts

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"
IncludeFile "CkFileAccess.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthGoogle.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; 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.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleContacts.json")
    If success <> 1
        Debug "Failed to load googleContacts.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    gAuth.i = CkAuthGoogle::ckCreate()
    If gAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthGoogle::setCkAccessToken(gAuth, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect using TLS.
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"www.google.com",443,1,bAutoReconnect)

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthGoogle(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::ckAddHeader(rest,"GData-Version","3.0")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/m8/feeds/contacts/default/full",sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body: " + CkStringBuilder::ckGetAsString(sbResponseBody)
        CkJsonObject::ckDispose(jsonToken)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; If the 200 response was received, then the contacts XML is contained
    ; in the response body.
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadSb(xml,sbResponseBody,0)

    ; See below for a sample response body.
    CkXml::ckSaveXml(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.i = CkXml::ckGetChildIntValue(xml,"openSearch:totalResults")
    startIndex.i = CkXml::ckGetChildIntValue(xml,"openSearch:startIndex")
    itemsPerPage.i = CkXml::ckGetChildIntValue(xml,"openSearch:itemsPerPage")
    Debug "totalResults = " + Str(totalResults)
    Debug "startIndex = " + Str(startIndex)
    Debug "itemsPerPage = " + Str(itemsPerPage)

    ; We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Iterate over each contact.
    numEntries.i = CkXml::ckNumChildrenHavingTag(xml,"entry")
    i.i = 0
    While i < numEntries
        CkXml::setCkI(xml, i)
        Debug Str(i + 1) + " ----"
        Debug "title: " + CkXml::ckGetChildContent(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.s = CkXml::ckGetChildContent(xml,"entry[i]|id")
        Debug "id: " + idUrl

        ; Use the parsing ability of GetFileName to get the contactId
        contactId.s = CkFileAccess::ckGetFileName(fac,idUrl)
        Debug "contactId: " + contactId

        fullName.s = CkXml::ckChilkatPath(xml,"entry[i]|gd:name|gd:fullName|*")
        If CkXml::ckLastMethodSuccess(xml) = 1
            Debug "fullName: " + fullName
        EndIf

        emailAddress.s = CkXml::ckChilkatPath(xml,"entry[i]|gd:email|(address)")
        If CkXml::ckLastMethodSuccess(xml) = 1
            Debug "email address: " + emailAddress
        EndIf

        i = i + 1
    Wend

    ; 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::ckDispose(jsonToken)
    CkAuthGoogle::ckDispose(gAuth)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkXml::ckDispose(xml)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure