B4X
B4X
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 B4X Downloads
Dim success As Boolean = False
' 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
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If success <> True Then
Log("Failed to load googleContacts.json")
Return
End If
Dim gAuth As ChilkatAuthGoogle
gAuth.Initialize("gAuth")
gAuth.AccessToken = jsonToken.StringOf("access_token")
Dim rest As ChilkatRest
rest.Initialize("rest")
' Connect using TLS.
Dim bAutoReconnect As Boolean = 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
' GData-Version: 3.0
rest.AddHeader("GData-Version", "3.0")
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
success = rest.FullRequestNoBodySb("GET", "/m8/feeds/contacts/default/full", sbResponseBody)
If success <> True Then
Log(rest.LastErrorText)
Return
End If
' A successful response will have a status code equal to 200.
If rest.ResponseStatusCode <> 200 Then
Log("response status code = " & rest.ResponseStatusCode)
Log("response status text = " & rest.ResponseStatusText)
Log("response header: " & rest.ResponseHeader)
Log("response body: " & sbResponseBody.GetAsString)
Return
End If
' If the 200 response was received, then the contacts XML is contained
' in the response body.
Dim xml As ChilkatXml
xml.Initialize
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.
Dim totalResults As Int = xml.GetChildIntValue("openSearch:totalResults")
Dim startIndex As Int = xml.GetChildIntValue("openSearch:startIndex")
Dim itemsPerPage As Int = xml.GetChildIntValue("openSearch:itemsPerPage")
Log("totalResults = " & totalResults)
Log("startIndex = " & startIndex)
Log("itemsPerPage = " & itemsPerPage)
' We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
Dim fac As ChilkatFileAccess
fac.Initialize
' Iterate over each contact.
Dim numEntries As Int = xml.NumChildrenHavingTag("entry")
Dim i As Int = 0
Do While i < numEntries
xml.I = i
Log((i + 1) & " ----")
Log("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..
Dim idUrl As String = xml.GetChildContent("entry[i]|id")
Log("id: " & idUrl)
' Use the parsing ability of GetFileName to get the contactId
Dim contactId As String = fac.GetFileName(idUrl)
Log("contactId: " & contactId)
Dim fullName As String = xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
If xml.LastMethodSuccess = True Then
Log("fullName: " & fullName)
End If
Dim emailAddress As String = xml.ChilkatPath("entry[i]|gd:email|(address)")
If xml.LastMethodSuccess = True Then
Log("email address: " & emailAddress)
End If
i = i + 1
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>
'