(CkPython) Find Contact Having Email Address

Demonstrates how to fetch the Google Contact for a given email address.

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..
# ----------------------------------------------

# To retrieve the contacts, we need to send the following:

# 	GET /m8/feeds/contacts/default/full?q=<emailAddress>
# 	GData-Version: 3.0

# Get the contact (or contacts) with this email address:
emailAddressToFind = "admin@chilkatsoft.com"

rest.AddHeader("GData-Version","3.0")
rest.AddQueryParam("q",emailAddressToFind)

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)

# See below for a sample response body.
xml.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.
totalResults = xml.GetChildIntValue("openSearch:totalResults")
startIndex = xml.GetChildIntValue("openSearch:startIndex")
itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
print("totalResults = " + str(totalResults))
print("startIndex = " + str(startIndex))
print("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 = chilkat.CkFileAccess()

# Iterate over each contact.
numEntries = xml.NumChildrenHavingTag("entry")
i = 0
while i < numEntries :
    xml.put_I(i)
    print(str(i + 1) + " ----")
    print("title: " + xml.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..
    idUrl = xml.getChildContent("entry[i]|id")
    print("id: " + idUrl)

    # Use the parsing ability of GetFileName to get the contactId
    contactId = fac.getFileName(idUrl)
    print("contactId: " + contactId)

    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)

    i = i + 1