PureBasic
PureBasic
Retrieve a Single Contact
See more Google APIs Examples
Demonstrates how to retrieve a single contact (by contactId) for the Google Contacts API.Chilkat PureBasic Downloads
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthGoogle.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
success.i = 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
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleContacts.json")
If success <> 1
Debug "Failed to load googleContacts.json"
CkJsonObject::ckDispose(jsonToken)
ProcedureReturn
EndIf
gAuth.i = CkAuthGoogle::ckCreate()
If gAuth.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthGoogle::setCkAccessToken(gAuth, CkJsonObject::ckStringOf(jsonToken,"access_token"))
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Connect using TLS.
bAutoReconnect.i = 1
success = CkRest::ckConnect(rest,"www.google.com",443,1,bAutoReconnect)
; Provide the authentication credentials (i.e. the access token)
CkRest::ckSetAuthGoogle(rest,gAuth)
; ----------------------------------------------
; OK, the REST connection setup is completed..
; ----------------------------------------------
; To retrieve the contact, send the following:
; GET /m8/feeds/contacts/default/full/{contactId}
; GData-Version: 3.0
CkRest::ckAddHeader(rest,"GData-Version","3.0")
sbPath.i = CkStringBuilder::ckCreate()
If sbPath.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbPath,"/m8/feeds/contacts/default/full/{contactId}")
; Get the contact having contactId = "7b1c7b6409e718a0"
numReplacements.i = CkStringBuilder::ckReplace(sbPath,"{contactId}","7b1c7b6409e718a0")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestNoBodySb(rest,"GET",CkStringBuilder::ckGetAsString(sbPath),sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkAuthGoogle::ckDispose(gAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
; A successful response will have a status code equal to 200.
If CkRest::ckResponseStatusCode(rest) <> 200
Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
Debug "response status text = " + CkRest::ckResponseStatusText(rest)
Debug "response header: " + CkRest::ckResponseHeader(rest)
Debug "response body: " + CkStringBuilder::ckGetAsString(sbResponseBody)
CkJsonObject::ckDispose(jsonToken)
CkAuthGoogle::ckDispose(gAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
; If the 200 response was received, then the contacts XML is contained
; in the response body.
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckLoadSb(xml,sbResponseBody,0)
; See below for a sample response body.
CkXml::ckSaveXml(xml,"qa_output/google_contact.xml")
; Now let's parse the XML...
Debug "title: " + CkXml::ckGetChildContent(xml,"title")
emailAddress.s = CkXml::ckChilkatPath(xml,"gd:email|(address)")
If CkXml::ckLastMethodSuccess(xml) = 1
Debug "email address: " + emailAddress
EndIf
; The response body XML looks something like this:
; <?xml version="1.0" encoding="UTF-8" ?>
; <entry gd:etag=""R3kzezVSLit7I2A9XRFaFE8DQAU."" xmlns="http://www.w3.org/2005/Atom" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gContact="http://schemas.google.com/contact/2008" xmlns:gd="http://schemas.google.com/g/2005">
; <id>http://www.google.com/m8/feeds/contacts/support%40chilkatcloud.com/base/7b1c7b6409e718a0</id>
; <updated>2016-11-18T00:41:56.783Z</updated>
; <app:edited xmlns:app="http://www.w3.org/2007/app">2016-11-18T00:41:56.783Z</app:edited>
; <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact" />
; <title>Chilkat Cloud</title>
; <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*" href="https://www.googleapis.com/m8/feeds/photos/media/support%40chilkatcloud.com/7b1c7b6409e718a0" gd:etag=""fgVhPls4Sit7I2BWHUlTWkQMKHUZKHkkaiw."" />
; <link rel="self" type="application/atom+xml" href="https://www.googleapis.com/m8/feeds/contacts/support%40chilkatcloud.com/full/7b1c7b6409e718a0" />
; <link rel="edit" type="application/atom+xml" href="https://www.googleapis.com/m8/feeds/contacts/support%40chilkatcloud.com/full/7b1c7b6409e718a0" />
; <gd:name>
; <gd:fullName>Chilkat Cloud</gd:fullName>
; <gd:givenName>Chilkat</gd:givenName>
; <gd:familyName>Cloud</gd:familyName>
; </gd:name>
; <gd:email rel="http://schemas.google.com/g/2005#other" address="support@chilkatcloud.com" primary="true" />
; <gContact:groupMembershipInfo deleted="false" href="http://www.google.com/m8/feeds/groups/support%40chilkatcloud.com/base/6" />
; </entry>
CkJsonObject::ckDispose(jsonToken)
CkAuthGoogle::ckDispose(gAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbResponseBody)
CkXml::ckDispose(xml)
ProcedureReturn
EndProcedure