Lua
Lua
Google Contacts - Retrieve as JSON
See more Google APIs Examples
Demonstrates how to retrieve Google Contacts as JSON.Chilkat Lua Downloads
local chilkat = require("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
local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/googleContacts.json")
if not success then
print("Failed to load googleContacts.json")
return
end
local gAuth = chilkat.AuthGoogle.new()
gAuth.access_token = jsonToken:string_of("access_token")
local rest = chilkat.Rest.new()
-- Connect using TLS.
local bAutoReconnect = true
success = rest:connect("www.google.com", 443, true, bAutoReconnect)
-- Provide the authentication credentials (i.e. the access token)
rest:set_auth_google(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:add_query_param("alt", "json")
rest:add_header("GData-Version", "3.0")
local sbResponseBody = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", "/m8/feeds/contacts/default/full", sbResponseBody)
if not success then
print(rest.last_error_text)
return
end
-- A successful response will have a status code equal to 200.
if rest.response_status_code ~= 200 then
print("response status code = " .. rest.response_status_code)
print("response status text = " .. rest.response_status_text)
print("response header: " .. rest.response_header)
print("response body: " .. sbResponseBody:get_as_string())
return
end
-- If the 200 response was received, then the contacts JSON is contained
-- in the response body.
local json = chilkat.JsonObject.new()
json:load_sb(sbResponseBody)
json.emit_compact = false
-- Save the pretty-printed JSON response to a file.
sbResponseBody:clear()
json:emit_sb(sbResponseBody)
sbResponseBody:write_file("qa_output/google_contacts.json", "utf-8", false)
-- Parse the Google Contacts JSON, and iterate over the contacts..
local totalResults = json:int_of("feed.openSearch$totalResults.$t")
local startIndex = json:int_of("feed.openSearch$startIndex.$t")
local itemsPerPage = json:int_of("feed.openSearch$itemsPerPage.$t")
print("totalResults = " .. totalResults)
print("startIndex = " .. startIndex)
print("itemsPerPage = " .. itemsPerPage)
local numEntries = json:size_of_array("feed.entry")
local i = 0
while i < numEntries do
json.i = i
print((i + 1) .. " ----")
print("title: " .. json:string_of("feed.entry[i].title.$t"))
local fullName = json:string_of("feed.entry[i].gd$name.gd$fullName.$t")
if json.last_method_success then
print("fullName: " .. fullName)
end
-- There can be multiple email addresses, so it's stored as a JSON array..
local numEmailAddresses = json:size_of_array("feed.entry[i].gd$email")
local j = 0
while j < numEmailAddresses do
local emailAddress = json:string_of("feed.entry[i].gd$email[j].address")
if json.last_method_success then
print("email address: " .. emailAddress)
end
j = j + 1
end
i = i + 1
end
-- 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 ...
-- }