PowerBuilder
PowerBuilder
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 PowerBuilder Downloads
integer li_rc
integer li_Success
oleobject loo_JsonToken
oleobject loo_GAuth
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_SbResponseBody
oleobject loo_Xml
integer li_TotalResults
integer li_StartIndex
integer li_ItemsPerPage
oleobject loo_Fac
integer li_NumEntries
integer i
string ls_IdUrl
string ls_ContactId
string ls_FullName
string ls_EmailAddress
li_Success = 0
// 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
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
destroy loo_JsonToken
MessageBox("Error","Connecting to COM object failed")
return
end if
li_Success = loo_JsonToken.LoadFile("qa_data/tokens/googleContacts.json")
if li_Success <> 1 then
Write-Debug "Failed to load googleContacts.json"
destroy loo_JsonToken
return
end if
loo_GAuth = create oleobject
li_rc = loo_GAuth.ConnectToNewObject("Chilkat.AuthGoogle")
loo_GAuth.AccessToken = loo_JsonToken.StringOf("access_token")
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
// Connect using TLS.
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("www.google.com",443,1,li_BAutoReconnect)
// Provide the authentication credentials (i.e. the access token)
loo_Rest.SetAuthGoogle(loo_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
loo_Rest.AddHeader("GData-Version","3.0")
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",loo_SbResponseBody)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_GAuth
destroy loo_Rest
destroy loo_SbResponseBody
return
end if
// A successful response will have a status code equal to 200.
if loo_Rest.ResponseStatusCode <> 200 then
Write-Debug "response status code = " + string(loo_Rest.ResponseStatusCode)
Write-Debug "response status text = " + loo_Rest.ResponseStatusText
Write-Debug "response header: " + loo_Rest.ResponseHeader
Write-Debug "response body: " + loo_SbResponseBody.GetAsString()
destroy loo_JsonToken
destroy loo_GAuth
destroy loo_Rest
destroy loo_SbResponseBody
return
end if
// If the 200 response was received, then the contacts XML is contained
// in the response body.
loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")
loo_Xml.LoadSb(loo_SbResponseBody,0)
// See below for a sample response body.
loo_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.
li_TotalResults = loo_Xml.GetChildIntValue("openSearch:totalResults")
li_StartIndex = loo_Xml.GetChildIntValue("openSearch:startIndex")
li_ItemsPerPage = loo_Xml.GetChildIntValue("openSearch:itemsPerPage")
Write-Debug "totalResults = " + string(li_TotalResults)
Write-Debug "startIndex = " + string(li_StartIndex)
Write-Debug "itemsPerPage = " + string(li_ItemsPerPage)
// We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
loo_Fac = create oleobject
li_rc = loo_Fac.ConnectToNewObject("Chilkat.FileAccess")
// Iterate over each contact.
li_NumEntries = loo_Xml.NumChildrenHavingTag("entry")
i = 0
do while i < li_NumEntries
loo_Xml.I = i
Write-Debug string(i + 1) + " ----"
Write-Debug "title: " + loo_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..
ls_IdUrl = loo_Xml.GetChildContent("entry[i]|id")
Write-Debug "id: " + ls_IdUrl
// Use the parsing ability of GetFileName to get the contactId
ls_ContactId = loo_Fac.GetFileName(ls_IdUrl)
Write-Debug "contactId: " + ls_ContactId
ls_FullName = loo_Xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
if loo_Xml.LastMethodSuccess = 1 then
Write-Debug "fullName: " + ls_FullName
end if
ls_EmailAddress = loo_Xml.ChilkatPath("entry[i]|gd:email|(address)")
if loo_Xml.LastMethodSuccess = 1 then
Write-Debug "email address: " + ls_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>
//
destroy loo_JsonToken
destroy loo_GAuth
destroy loo_Rest
destroy loo_SbResponseBody
destroy loo_Xml
destroy loo_Fac