(CkPython) Page Through All Contacts

Demonstrates how to page through the entire list of Google Contacts.

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

# 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 = chilkat.CkJsonObject()
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
if (success != True):
    print("Failed to load googleContacts.json")
    sys.exit()

gAuth = chilkat.CkAuthGoogle()
gAuth.put_AccessToken(jsonToken.stringOf("access_token"))

rest = chilkat.CkRest()

# Connect using TLS.
bAutoReconnect = True
success = rest.Connect("www.google.com",443,True,bAutoReconnect)

# Provide the authentication credentials (i.e. the access token)
rest.SetAuthGoogle(gAuth)

# ----------------------------------------------
# OK, the REST connection setup is completed..
# ----------------------------------------------

startIndex = 1
maxResults = 25
# The totalResults will get updated with the correct value in the 1st loop iteration..
totalResults = 100
# To retrieve the contacts in pages of 25 each, we need to send the following for each page.

# 	GET /m8/feeds/contacts/default/full?max-results=25&start-index=<startIndex>
# 	GData-Version: 3.0

sbMaxResults = chilkat.CkStringBuilder()
sbMaxResults.AppendInt(maxResults)
sbStartIndex = chilkat.CkStringBuilder()

loopIteration = 0
while startIndex <= totalResults :

    sbStartIndex.Clear()
    sbStartIndex.AppendInt(startIndex)

    rest.ClearAllHeaders()
    rest.ClearAllQueryParams()
    rest.AddHeader("GData-Version","3.0")
    rest.AddQueryParam("start-index",sbStartIndex.getAsString())
    rest.AddQueryParam("max-results",sbMaxResults.getAsString())

    sbResponseBody = chilkat.CkStringBuilder()
    success = rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",sbResponseBody)
    if (success != True):
        print(rest.lastErrorText())
        sys.exit()

    # A successful response will have a status code equal to 200.
    if (rest.get_ResponseStatusCode() != 200):
        print("response status code = " + str(rest.get_ResponseStatusCode()))
        print("response status text = " + rest.responseStatusText())
        print("response header: " + rest.responseHeader())
        print("response body: " + sbResponseBody.getAsString())
        sys.exit()

    # If the 200 response was received, then the contacts XML is contained
    # in the response body.
    xml = chilkat.CkXml()
    xml.LoadSb(sbResponseBody,False)

    # 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 = xml.GetChildIntValue("openSearch:totalResults")
    startIndex2 = xml.GetChildIntValue("openSearch:startIndex")
    itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
    print("totalResults = " + str(totalResults))
    print("startIndex = " + str(startIndex2))
    print("itemsPerPage = " + str(itemsPerPage))

    # Iterate over each contact.
    numEntries = xml.NumChildrenHavingTag("entry")
    i = 0
    while i < numEntries :
        xml.put_I(i)
        print(str(loopIteration * maxResults + i + 1) + " ----")
        print("title: " + xml.getChildContent("entry[i]|title"))

        idUrl = xml.getChildContent("entry[i]|id")
        print("id: " + idUrl)

        fullName = xml.chilkatPath("entry[i]|gd:name|gd:fullName|*")
        if (xml.get_LastMethodSuccess() == True):
            print("fullName: " + fullName)

        emailAddress = xml.chilkatPath("entry[i]|gd:email|(address)")
        if (xml.get_LastMethodSuccess() == True):
            print("email address: " + emailAddress)

        # Find the photo link and check to see if this contact has a photo.
        # xLink is a CkXml
        xLink = xml.GetChildWithAttr("link","rel","http://schemas.google.com/contacts/2008/rel#photo")
        if (xml.get_LastMethodSuccess() == True):
            # Get the photo etag.
            bHasPhoto = xLink.HasAttribute("gd:etag")
            if (bHasPhoto == True):
                print("This contact has a photo.")

        i = i + 1

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1