(Tcl) Google People API - Update an Existing Contact

To update an existing contact, you must include the person.metadata.sources.etag field in the person for the contact to be updated to make sure the contact has not changed since your last read.

For more information, see https://developers.google.com/people/v1/contacts#update-an-existing-contact

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# It is assumed we previously obtained an OAuth2 access token.
# This example loads the JSON access token file 

# originally obtained by this example: Get Google People API OAuth2 Access Token
# or refreshed by this example: Refresh Google People API OAuth2 Access Token

set jsonToken [new_CkJsonObject]

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

set http [new_CkHttp]

CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

# Implements the following CURL command:

# curl -X PATCH https://people.googleapis.com/v1/resource_name:updateContact?updatePersonFields=emailAddresses \
#   -H "Content-Type: application/json" \
#   -d '{
#     "resourceName": "resource_name",
#     "etag": "#eyZ0Gu5HVas=",
#     "emailAddresses": [{ "value": "john.doe@gmail.com" }],
# }'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "resourceName": "resource_name",
#   "etag": "#eyZ0Gu5HVas=",
#   "emailAddresses": [
#     {
#       "value": "john.doe@gmail.com"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "resourceName" "people/c172365763025317520"
CkJsonObject_UpdateString $json "etag" "%EigBAj0DBAUGBwgJPgoLPwwNDg8QQBESExQVFhc1GTQ3HyEiIyQlJicuGgQBAgUHIgxleVowR3U1SFZhcz0="
CkJsonObject_UpdateString $json "emailAddresses[0].value" "john.doe@gmail.com"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# Notice that the resource name is part of the URL...
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PATCH" "https://people.googleapis.com/v1/people/c172365763025317520:updateContact?updatePersonFields=emailAddresses" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkJsonObject $jsonToken
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkJsonObject $jsonToken
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "resourceName": "people/c172365763025317520",
#   "etag": "%EigBAj0DBAUGBwgJPgoLPwwNDg8QQBESExQVFhc1GTQ3HyEiIyQlJicuGgQBAgUHIgxtQnhyR2MzMGU4Yz0=",
#   "metadata": {
#     "sources": [
#       {
#         "type": "CONTACT",
#         "id": "2645dbf8c902e90",
#         "etag": "#mBxrGc30e8c=",
#         "updateTime": "2020-08-03T23:01:23.539Z"
#       }
#     ],
#     "objectType": "PERSON"
#   },
#   "names": [
#     {
#       "metadata": {
#         "primary": true,
#         "source": {
#           "type": "CONTACT",
#           "id": "2645dbf8c902e90"
#         }
#       },
#       "displayName": "John Doe",
#       "familyName": "Doe",
#       "givenName": "John",
#       "displayNameLastFirst": "Doe, John",
#       "unstructuredName": "John Doe"
#     }
#   ],
#   "photos": [
#     {
#       "metadata": {
#         "primary": true,
#         "source": {
#           "type": "CONTACT",
#           "id": "2645dbf8c902e90"
#         }
#       },
#       "url": "https://lh3.googleusercontent.com/-XdUIqeMkCWA/AAAAAAAAAAI/AAAAAAAAAAA/V8BNOaftJmYG2hHugNzYued7G9QFdeZOACLcDEAEiGQoBShD___________8BGNvwiP7______wE/s100/photo.jpg",
#       "default": true
#     }
#   ],
#   "emailAddresses": [
#     {
#       "metadata": {
#         "primary": true,
#         "source": {
#           "type": "CONTACT",
#           "id": "2645def8c902e90"
#         }
#       },
#       "value": "john.doe@gmail.com"
#     }
#   ],
#   "memberships": [
#     {
#       "metadata": {
#         "source": {
#           "type": "CONTACT",
#           "id": "2645dbf8c902e90"
#         }
#       },
#       "contactGroupMembership": {
#         "contactGroupId": "myContacts",
#         "contactGroupResourceName": "contactGroups/myContacts"
#       }
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set resourceName [CkJsonObject_stringOf $jResp "resourceName"]
set etag [CkJsonObject_stringOf $jResp "etag"]
set metadataObjectType [CkJsonObject_stringOf $jResp "metadata.objectType"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "metadata.sources"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_type [CkJsonObject_stringOf $jResp "metadata.sources[i].type"]
    set id [CkJsonObject_stringOf $jResp "metadata.sources[i].id"]
    set etag [CkJsonObject_stringOf $jResp "metadata.sources[i].etag"]
    set updateTime [CkJsonObject_stringOf $jResp "metadata.sources[i].updateTime"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "names"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set metadataPrimary [CkJsonObject_BoolOf $jResp "names[i].metadata.primary"]
    set metadataSourceType [CkJsonObject_stringOf $jResp "names[i].metadata.source.type"]
    set metadataSourceId [CkJsonObject_stringOf $jResp "names[i].metadata.source.id"]
    set displayName [CkJsonObject_stringOf $jResp "names[i].displayName"]
    set familyName [CkJsonObject_stringOf $jResp "names[i].familyName"]
    set givenName [CkJsonObject_stringOf $jResp "names[i].givenName"]
    set displayNameLastFirst [CkJsonObject_stringOf $jResp "names[i].displayNameLastFirst"]
    set unstructuredName [CkJsonObject_stringOf $jResp "names[i].unstructuredName"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "photos"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set metadataPrimary [CkJsonObject_BoolOf $jResp "photos[i].metadata.primary"]
    set metadataSourceType [CkJsonObject_stringOf $jResp "photos[i].metadata.source.type"]
    set metadataSourceId [CkJsonObject_stringOf $jResp "photos[i].metadata.source.id"]
    set url [CkJsonObject_stringOf $jResp "photos[i].url"]
    set default [CkJsonObject_BoolOf $jResp "photos[i].default"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "emailAddresses"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set metadataPrimary [CkJsonObject_BoolOf $jResp "emailAddresses[i].metadata.primary"]
    set metadataSourceType [CkJsonObject_stringOf $jResp "emailAddresses[i].metadata.source.type"]
    set metadataSourceId [CkJsonObject_stringOf $jResp "emailAddresses[i].metadata.source.id"]
    set value [CkJsonObject_stringOf $jResp "emailAddresses[i].value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "memberships"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set metadataSourceType [CkJsonObject_stringOf $jResp "memberships[i].metadata.source.type"]
    set metadataSourceId [CkJsonObject_stringOf $jResp "memberships[i].metadata.source.id"]
    set contactGroupMembershipContactGroupId [CkJsonObject_stringOf $jResp "memberships[i].contactGroupMembership.contactGroupId"]
    set contactGroupMembershipContactGroupResourceName [CkJsonObject_stringOf $jResp "memberships[i].contactGroupMembership.contactGroupResourceName"]
    set i [expr $i + 1]
}

delete_CkJsonObject $jsonToken
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp