Tcl

Update a Google Contact

See more Google APIs Examples

Demonstrates how to update a Google Contact. Tcl

load ./chilkat.dll

set success 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

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/googleContacts.json"]
if {$success != 1} then {
    puts "Failed to load googleContacts.json"
    delete_CkJsonObject $jsonToken
    exit
}

set gAuth [new_CkAuthGoogle]

CkAuthGoogle_put_AccessToken $gAuth [CkJsonObject_stringOf $jsonToken "access_token"]

set rest [new_CkRest]

# Connect using TLS.
set bAutoReconnect 1
set success [CkRest_Connect $rest "www.google.com" 443 1 $bAutoReconnect]

# Provide the authentication credentials (i.e. the access token)
CkRest_SetAuthGoogle $rest $gAuth

# ----------------------------------------------
# OK, the REST connection setup is completed..
# ----------------------------------------------

# To update a contact, we'll first get the contact information,
# then we'll make changes to the XML and then PUT the update.

# To retrieve the contact, send the following:
# 	GET /m8/feeds/contacts/default/full/{contactId}
# 	GData-Version: 3.0

CkRest_AddHeader $rest "GData-Version" "3.0"

set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/m8/feeds/contacts/default/full/{contactId}"
# Get the contact having contactId = "5b6d64980b1ed462"
set numReplacements [CkStringBuilder_Replace $sbPath "{contactId}" "5b6d64980b1ed462"]

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" [CkStringBuilder_getAsString $sbPath] $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbResponseBody
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body: [CkStringBuilder_getAsString $sbResponseBody]"
    delete_CkJsonObject $jsonToken
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbResponseBody
    exit
}

# If the 200 response was received, then the contacts XML is contained
# in the response body.
set xml [new_CkXml]

CkXml_LoadSb $xml $sbResponseBody 0

# Get the etag:
set lastKnownEtag [CkXml_getAttrValue $xml "gd:etag"]
puts "lastKnownEtag = $lastKnownEtag"

# Update the XML.
# We're going to add or update with the following information:

# 	  <gd:name>
# 	    <gd:givenName>Joe</gd:givenName>
# 	    <gd:familyName>Sample</gd:familyName>
# 	    <gd:fullName>Joe Sample</gd:fullName>
# 	  </gd:name>
# 	  <content type="text">RIP Joe Sample, a great musician...</content>
# 	  <gd:extendedProperty name="pet" value="hamster"/>

CkXml_UpdateChildContent $xml "gd:name|gd:givenName" "Joe"
CkXml_UpdateChildContent $xml "gd:name|gd:familyName" "Sample"
CkXml_UpdateChildContent $xml "gd:name|gd:fullName" "Joe Sample"
CkXml_UpdateChildContent $xml "content" "RIP Joe Sample, a great musician..."
CkXml_UpdateAttrAt $xml "content" 1 "type" "text"
CkXml_UpdateAttrAt $xml "gd:extendedProperty" 1 "name" "pet"
CkXml_UpdateAttrAt $xml "gd:extendedProperty" 1 "value" "hamster"

# Send the following:

# 	PUT /m8/feeds/contacts/default/full/{contactId}
# 	If-Match: {lastKnownEtag}
# 	GData-Version: 3.0
# 	Content-Type: application/atom+xml

CkRest_ClearAllHeaders $rest
CkRest_AddHeader $rest "If-Match" $lastKnownEtag
CkRest_AddHeader $rest "GData-Version" "3.0"
CkRest_AddHeader $rest "Content-Type" "application/atom+xml"

set sbRequestBody [new_CkStringBuilder]

CkXml_GetXmlSb $xml $sbRequestBody

# The sbPath already contains the correct path..
set success [CkRest_FullRequestSb $rest "PUT" [CkStringBuilder_getAsString $sbPath] $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbResponseBody
    delete_CkXml $xml
    delete_CkStringBuilder $sbRequestBody
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body: [CkStringBuilder_getAsString $sbResponseBody]"
    delete_CkJsonObject $jsonToken
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbResponseBody
    delete_CkXml $xml
    delete_CkStringBuilder $sbRequestBody
    exit
}

# If the 200 response was received, then the updated contact XML is contained
# in the response body.
CkXml_LoadSb $xml $sbResponseBody 0

puts "Response Body:"
puts [CkXml_getXml $xml]
puts "Success."

delete_CkJsonObject $jsonToken
delete_CkAuthGoogle $gAuth
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbResponseBody
delete_CkXml $xml
delete_CkStringBuilder $sbRequestBody