Lua

Find Contact Having Email Address

See more Google APIs Examples

Demonstrates how to fetch the Google Contact for a given email address. Lua

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?q=<emailAddress>
--     GData-Version: 3.0

-- Get the contact (or contacts) with this email address:
local emailAddressToFind = "admin@chilkatsoft.com"

rest:add_header("GData-Version", "3.0")
rest:add_query_param("q", emailAddressToFind)

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 XML is contained
-- in the response body.
local xml = chilkat.Xml.new()
xml:load_sb(sbResponseBody, false)

-- See below for a sample response body.
xml:save_xml("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.
local totalResults = xml:get_child_int_value("openSearch:totalResults")
local startIndex = xml:get_child_int_value("openSearch:startIndex")
local itemsPerPage = xml:get_child_int_value("openSearch:itemsPerPage")
print("totalResults = " .. totalResults)
print("startIndex = " .. startIndex)
print("itemsPerPage = " .. itemsPerPage)

-- We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
local fac = chilkat.FileAccess.new()

-- Iterate over each contact.
local numEntries = xml:num_children_having_tag("entry")
local i = 0
while i < numEntries do
    xml.i = i
    print((i + 1) .. " ----")
    print("title: " .. xml:get_child_content("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..
    local idUrl = xml:get_child_content("entry[i]|id")
    print("id: " .. idUrl)

    -- Use the parsing ability of GetFileName to get the contactId
    local contactId = fac:get_file_name(idUrl)
    print("contactId: " .. contactId)

    local fullName = xml:chilkat_path("entry[i]|gd:name|gd:fullName|*")
    if xml.last_method_success then
        print("fullName: " .. fullName)
    end

    local emailAddress = xml:chilkat_path("entry[i]|gd:email|(address)")
    if xml.last_method_success then
        print("email address: " .. emailAddress)
    end

    i = i + 1
end