DataFlex
DataFlex
Google Contacts - Retrieve as JSON
See more Google APIs Examples
Demonstrates how to retrieve Google Contacts as JSON.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Token Handle hoJsonToken
Variant vGAuth
Handle hoGAuth
Handle hoRest
Boolean iBAutoReconnect
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJson
Integer iTotalResults
Integer iStartIndex
Integer iItemsPerPage
Integer iNumEntries
Integer i
String sFullName
Integer iNumEmailAddresses
Integer j
String sEmailAddress
String sTemp1
Integer iTemp1
Boolean bTemp1
Move False To iSuccess
// 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
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
Get ComLoadFile Of hoJsonToken "qa_data/tokens/googleContacts.json" To iSuccess
If (iSuccess <> True) Begin
Showln "Failed to load googleContacts.json"
Procedure_Return
End
Get Create (RefClass(cComChilkatAuthGoogle)) To hoGAuth
If (Not(IsComObjectCreated(hoGAuth))) Begin
Send CreateComObject of hoGAuth
End
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Set ComAccessToken Of hoGAuth To sTemp1
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
// Connect using TLS.
Move True To iBAutoReconnect
Get ComConnect Of hoRest "www.google.com" 443 True iBAutoReconnect To iSuccess
// Provide the authentication credentials (i.e. the access token)
Get pvComObject of hoGAuth to vGAuth
Get ComSetAuthGoogle Of hoRest vGAuth To iSuccess
// ----------------------------------------------
// 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
// To get the contacts data in JSON format, set the "alt" query parameter to "json"
Get ComAddQueryParam Of hoRest "alt" "json" To iSuccess
Get ComAddHeader Of hoRest "GData-Version" "3.0" To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComFullRequestNoBodySb Of hoRest "GET" "/m8/feeds/contacts/default/full" vSbResponseBody To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
// A successful response will have a status code equal to 200.
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 200) Begin
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "response status code = " iTemp1
Get ComResponseStatusText Of hoRest To sTemp1
Showln "response status text = " sTemp1
Get ComResponseHeader Of hoRest To sTemp1
Showln "response header: " sTemp1
Get ComGetAsString Of hoSbResponseBody To sTemp1
Showln "response body: " sTemp1
Procedure_Return
End
// If the 200 response was received, then the contacts JSON is contained
// in the response body.
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJson vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJson To False
// Save the pretty-printed JSON response to a file.
Send ComClear To hoSbResponseBody
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComEmitSb Of hoJson vSbResponseBody To iSuccess
Get ComWriteFile Of hoSbResponseBody "qa_output/google_contacts.json" "utf-8" False To iSuccess
// Parse the Google Contacts JSON, and iterate over the contacts..
Get ComIntOf Of hoJson "feed.openSearch$totalResults.$t" To iTotalResults
Get ComIntOf Of hoJson "feed.openSearch$startIndex.$t" To iStartIndex
Get ComIntOf Of hoJson "feed.openSearch$itemsPerPage.$t" To iItemsPerPage
Showln "totalResults = " iTotalResults
Showln "startIndex = " iStartIndex
Showln "itemsPerPage = " iItemsPerPage
Get ComSizeOfArray Of hoJson "feed.entry" To iNumEntries
Move 0 To i
While (i < iNumEntries)
Set ComI Of hoJson To i
Showln (i + 1) " ----"
Get ComStringOf Of hoJson "feed.entry[i].title.$t" To sTemp1
Showln "title: " sTemp1
Get ComStringOf Of hoJson "feed.entry[i].gd$name.gd$fullName.$t" To sFullName
Get ComLastMethodSuccess Of hoJson To bTemp1
If (bTemp1 = True) Begin
Showln "fullName: " sFullName
End
// There can be multiple email addresses, so it's stored as a JSON array..
Get ComSizeOfArray Of hoJson "feed.entry[i].gd$email" To iNumEmailAddresses
Move 0 To j
While (j < iNumEmailAddresses)
Get ComStringOf Of hoJson "feed.entry[i].gd$email[j].address" To sEmailAddress
Get ComLastMethodSuccess Of hoJson To bTemp1
If (bTemp1 = True) Begin
Showln "email address: " sEmailAddress
End
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
// A sample Google Contacts JSON response:
// {
// "version": "1.0",
// "encoding": "UTF-8",
// "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": "\"QHw5eTVSLyt7I2A9XRFaE0kNTwI.\"",
// "id": {
// "$t": "chilkat.support@gmail.com"
// },
// "updated": {
// "$t": "2016-11-17T01:57:41.221Z"
// },
// "category": [
// {
// "scheme": "http://schemas.google.com/g/2005#kind",
// "term": "http://schemas.google.com/contact/2008#contact"
// }
// ],
// "title": {
// "$t": "Chilkat Support's Contacts"
// },
// "link": [
// {
// "rel": "alternate",
// "type": "text/html",
// "href": "https://www.googleapis.com/"
// },
// {
// "rel": "http://schemas.google.com/g/2005#feed",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full"
// },
// {
// "rel": "http://schemas.google.com/g/2005#post",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full"
// },
// {
// "rel": "http://schemas.google.com/g/2005#batch",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full/batch"
// },
// {
// "rel": "self",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full?max-results=25&alt=json"
// },
// {
// "rel": "next",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full?max-results=25&alt=json&start-index=26"
// }
// ],
// "author": [
// {
// "name": {
// "$t": "Chilkat Support"
// },
// "email": {
// "$t": "chilkat.support@gmail.com"
// }
// }
// ],
// "generator": {
// "version": "1.0",
// "uri": "http://www.google.com/m8/feeds",
// "$t": "Contacts"
// },
// "openSearch$totalResults": {
// "$t": "350"
// },
// "openSearch$startIndex": {
// "$t": "1"
// },
// "openSearch$itemsPerPage": {
// "$t": "25"
// },
// "entry": [
// {
// "id": {
// "$t": "http://www.google.com/m8/feeds/contacts/chilkat.support%40gmail.com/base/0"
// },
// "gd$etag": "\"SX8zcTVSLyt7I2A9WxBXFU4MQwI.\"",
// "updated": {
// "$t": "2010-01-26T20:07:48.189Z"
// },
// "app$edited": {
// "xmlns$app": "http://www.w3.org/2007/app",
// "$t": "2010-01-26T20:07:48.189Z"
// },
// "category": [
// {
// "scheme": "http://schemas.google.com/g/2005#kind",
// "term": "http://schemas.google.com/contact/2008#contact"
// }
// ],
// "title": {
// "$t": "Joe Sample"
// },
// "link": [
// {
// "rel": "http://schemas.google.com/contacts/2008/rel#photo",
// "type": "image/*",
// "href": "https://www.googleapis.com/m8/feeds/photos/media/chilkat.support%40gmail.com/0"
// },
// {
// "rel": "self",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full/0"
// },
// {
// "rel": "edit",
// "type": "application/atom+xml",
// "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full/0"
// }
// ],
// "gd$name": {
// "gd$fullName": {
// "$t": "Joe Sample"
// },
// "gd$givenName": {
// "$t": "Joe"
// },
// "gd$familyName": {
// "$t": "Sample"
// }
// },
// "gd$email": [
// {
// "address": "somebody@gmail.com",
// "primary": "true",
// "rel": "http://schemas.google.com/g/2005#other"
// }
// ]
// },
// ... more entries ...
//
End_Procedure