(Perl) Google Contacts - Retrieve as JSON

Demonstrates how to retrieve Google Contacts as JSON.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# 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 = chilkat::CkJsonObject->new();
$success = $jsonToken->LoadFile("qa_data/tokens/googleContacts.json");
if ($success != 1) {
    print "Failed to load googleContacts.json" . "\r\n";
    exit;
}

$gAuth = chilkat::CkAuthGoogle->new();
$gAuth->put_AccessToken($jsonToken->stringOf("access_token"));

$rest = chilkat::CkRest->new();

# Connect using TLS.
$bAutoReconnect = 1;
$success = $rest->Connect("www.google.com",443,1,$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

# To get the contacts data in JSON format, set the "alt" query parameter to "json"
$rest->AddQueryParam("alt","json");
$rest->AddHeader("GData-Version","3.0");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# A successful response will have a status code equal to 200.
if ($rest->get_ResponseStatusCode() != 200) {
    print "response status code = " . $rest->get_ResponseStatusCode() . "\r\n";
    print "response status text = " . $rest->responseStatusText() . "\r\n";
    print "response header: " . $rest->responseHeader() . "\r\n";
    print "response body: " . $sbResponseBody->getAsString() . "\r\n";
    exit;
}

# If the 200 response was received, then the contacts JSON is contained
# in the response body.
$json = chilkat::CkJsonObject->new();
$json->LoadSb($sbResponseBody);
$json->put_EmitCompact(0);

# Save the pretty-printed JSON response to a file.
$sbResponseBody->Clear();
$json->EmitSb($sbResponseBody);
$sbResponseBody->WriteFile("qa_output/google_contacts.json","utf-8",0);

# Parse the Google Contacts JSON, and iterate over the contacts..
$totalResults = $json->IntOf("feed.openSearch$totalResults.$t");
$startIndex = $json->IntOf("feed.openSearch$startIndex.$t");
$itemsPerPage = $json->IntOf("feed.openSearch$itemsPerPage.$t");
print "totalResults = " . $totalResults . "\r\n";
print "startIndex = " . $startIndex . "\r\n";
print "itemsPerPage = " . $itemsPerPage . "\r\n";

$numEntries = $json->SizeOfArray("feed.entry");
$i = 0;
while ($i < $numEntries) {
    $json->put_I($i);
    print ($i + 1) . " ----" . "\r\n";
    print "title: " . $json->stringOf("feed.entry[i].title.$t") . "\r\n";

    $fullName = $json->stringOf("feed.entry[i].gd$name.gd$fullName.$t");
    if ($json->get_LastMethodSuccess() == 1) {
        print "fullName: " . $fullName . "\r\n";
    }

    # There can be multiple email addresses, so it's stored as a JSON array..
    $numEmailAddresses = $json->SizeOfArray("feed.entry[i].gd$email");
    $j = 0;
    while ($j < $numEmailAddresses) {
        $emailAddress = $json->stringOf("feed.entry[i].gd$email[j].address");
        if ($json->get_LastMethodSuccess() == 1) {
            print "email address: " . $emailAddress . "\r\n";
        }

        $j = $j + 1;
    }

    $i = $i + 1;
}

# 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 ...
#