AutoIt
AutoIt
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 AutoIt Downloads
Local $bSuccess = 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
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If ($bSuccess <> True) Then
ConsoleWrite("Failed to load googleContacts.json" & @CRLF)
Exit
EndIf
$oGAuth = ObjCreate("Chilkat.AuthGoogle")
$oGAuth.AccessToken = $oJsonToken.StringOf("access_token")
$oRest = ObjCreate("Chilkat.Rest")
; Connect using TLS.
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("www.google.com",443,True,$bAutoReconnect)
; Provide the authentication credentials (i.e. the access token)
$oRest.SetAuthGoogle($oGAuth)
; ----------------------------------------------
; 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
$oRest.AddHeader("GData-Version","3.0")
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oRest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",$oSbResponseBody)
If ($bSuccess <> True) Then
ConsoleWrite($oRest.LastErrorText & @CRLF)
Exit
EndIf
; A successful response will have a status code equal to 200.
If ($oRest.ResponseStatusCode <> 200) Then
ConsoleWrite("response status code = " & $oRest.ResponseStatusCode & @CRLF)
ConsoleWrite("response status text = " & $oRest.ResponseStatusText & @CRLF)
ConsoleWrite("response header: " & $oRest.ResponseHeader & @CRLF)
ConsoleWrite("response body: " & $oSbResponseBody.GetAsString() & @CRLF)
Exit
EndIf
; If the 200 response was received, then the contacts XML is contained
; in the response body.
$oXml = ObjCreate("Chilkat.Xml")
$oXml.LoadSb($oSbResponseBody,False)
; See below for a sample response body.
$oXml.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.
Local $iTotalResults = $oXml.GetChildIntValue("openSearch:totalResults")
Local $iStartIndex = $oXml.GetChildIntValue("openSearch:startIndex")
Local $itemsPerPage = $oXml.GetChildIntValue("openSearch:itemsPerPage")
ConsoleWrite("totalResults = " & $iTotalResults & @CRLF)
ConsoleWrite("startIndex = " & $iStartIndex & @CRLF)
ConsoleWrite("itemsPerPage = " & $itemsPerPage & @CRLF)
; We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
$oFac = ObjCreate("Chilkat.FileAccess")
; Iterate over each contact.
Local $iNumEntries = $oXml.NumChildrenHavingTag("entry")
Local $i = 0
While $i < $iNumEntries
$oXml.I = $i
ConsoleWrite(($i + 1) & " ----" & @CRLF)
ConsoleWrite("title: " & $oXml.GetChildContent("entry[i]|title") & @CRLF)
; 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..
Local $sIdUrl = $oXml.GetChildContent("entry[i]|id")
ConsoleWrite("id: " & $sIdUrl & @CRLF)
; Use the parsing ability of GetFileName to get the contactId
Local $sContactId = $oFac.GetFileName($sIdUrl)
ConsoleWrite("contactId: " & $sContactId & @CRLF)
Local $sFullName = $oXml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
If ($oXml.LastMethodSuccess = True) Then
ConsoleWrite("fullName: " & $sFullName & @CRLF)
EndIf
Local $sEmailAddress = $oXml.ChilkatPath("entry[i]|gd:email|(address)")
If ($oXml.LastMethodSuccess = True) Then
ConsoleWrite("email address: " & $sEmailAddress & @CRLF)
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>
;