(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; 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

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googlePeople.json")
    If success <> 1
        Debug "Failed to load googleContacts.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(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"
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"resourceName","people/c172365763025317520")
    CkJsonObject::ckUpdateString(json,"etag","%EigBAj0DBAUGBwgJPgoLPwwNDg8QQBESExQVFhc1GTQ3HyEiIyQlJicuGgQBAgUHIgxleVowR3U1SFZhcz0=")
    CkJsonObject::ckUpdateString(json,"emailAddresses[0].value","john.doe@gmail.com")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    ; Notice that the resource name is part of the URL...
    resp.i = CkHttp::ckPTextSb(http,"PATCH","https://people.googleapis.com/v1/people/c172365763025317520:updateContact?updatePersonFields=emailAddresses",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkJsonObject::ckDispose(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    v_type.s
    id.s
    updateTime.s
    metadataPrimary.i
    metadataSourceType.s
    metadataSourceId.s
    displayName.s
    familyName.s
    givenName.s
    displayNameLastFirst.s
    unstructuredName.s
    url.s
    default.i
    value.s
    contactGroupMembershipContactGroupId.s
    contactGroupMembershipContactGroupResourceName.s

    resourceName.s = CkJsonObject::ckStringOf(jResp,"resourceName")
    etag.s = CkJsonObject::ckStringOf(jResp,"etag")
    metadataObjectType.s = CkJsonObject::ckStringOf(jResp,"metadata.objectType")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"metadata.sources")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        v_type = CkJsonObject::ckStringOf(jResp,"metadata.sources[i].type")
        id = CkJsonObject::ckStringOf(jResp,"metadata.sources[i].id")
        etag = CkJsonObject::ckStringOf(jResp,"metadata.sources[i].etag")
        updateTime = CkJsonObject::ckStringOf(jResp,"metadata.sources[i].updateTime")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"names")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        metadataPrimary = CkJsonObject::ckBoolOf(jResp,"names[i].metadata.primary")
        metadataSourceType = CkJsonObject::ckStringOf(jResp,"names[i].metadata.source.type")
        metadataSourceId = CkJsonObject::ckStringOf(jResp,"names[i].metadata.source.id")
        displayName = CkJsonObject::ckStringOf(jResp,"names[i].displayName")
        familyName = CkJsonObject::ckStringOf(jResp,"names[i].familyName")
        givenName = CkJsonObject::ckStringOf(jResp,"names[i].givenName")
        displayNameLastFirst = CkJsonObject::ckStringOf(jResp,"names[i].displayNameLastFirst")
        unstructuredName = CkJsonObject::ckStringOf(jResp,"names[i].unstructuredName")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"photos")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        metadataPrimary = CkJsonObject::ckBoolOf(jResp,"photos[i].metadata.primary")
        metadataSourceType = CkJsonObject::ckStringOf(jResp,"photos[i].metadata.source.type")
        metadataSourceId = CkJsonObject::ckStringOf(jResp,"photos[i].metadata.source.id")
        url = CkJsonObject::ckStringOf(jResp,"photos[i].url")
        default = CkJsonObject::ckBoolOf(jResp,"photos[i].default")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"emailAddresses")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        metadataPrimary = CkJsonObject::ckBoolOf(jResp,"emailAddresses[i].metadata.primary")
        metadataSourceType = CkJsonObject::ckStringOf(jResp,"emailAddresses[i].metadata.source.type")
        metadataSourceId = CkJsonObject::ckStringOf(jResp,"emailAddresses[i].metadata.source.id")
        value = CkJsonObject::ckStringOf(jResp,"emailAddresses[i].value")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"memberships")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        metadataSourceType = CkJsonObject::ckStringOf(jResp,"memberships[i].metadata.source.type")
        metadataSourceId = CkJsonObject::ckStringOf(jResp,"memberships[i].metadata.source.id")
        contactGroupMembershipContactGroupId = CkJsonObject::ckStringOf(jResp,"memberships[i].contactGroupMembership.contactGroupId")
        contactGroupMembershipContactGroupResourceName = CkJsonObject::ckStringOf(jResp,"memberships[i].contactGroupMembership.contactGroupResourceName")
        i = i + 1
    Wend


    CkJsonObject::ckDispose(jsonToken)
    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure