(PureBasic) Google Sheets - Append Values to an Existing Spreadsheet

Appends values to an existing Google spreadsheet.

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

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

    ; This example uses a previously obtained access token having permission for the 
    ; Google Sheets scope.

    ; In this example, Get Google Sheets OAuth2 Access Token, the access
    ; token was saved to a JSON file.  This example fetches the access token from the file..
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleSheets.json")
    If CkJsonObject::ckHasMember(jsonToken,"access_token") = 0
        Debug "No access token found."
        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"))

    ; To append values to an existing spreadsheet, our HTTP request body will
    ; contain JSON in the format of a "ValueRange".  For example, the spreadsheet we'll be
    ; adding to in this example looks like this:

    ; 

    ; The JSON ValueRange for the cells in the above spreadsheet is:
    ; {
    ;   "range": "Sheet1!A1:B5",
    ;   "majorDimension": "ROWS",
    ;   "values": [
    ;     [
    ;       "Item",
    ;       "Cost"
    ;     ],
    ;     [
    ;       "Wheel",
    ;       "$20.50"
    ;     ],
    ;     [
    ;       "Door",
    ;       "$15"
    ;     ],
    ;     [
    ;       "Engine",
    ;       "$100"
    ;     ],
    ;     [
    ;       "Totals",
    ;       "$135.50"
    ;     ]
    ;   ]
    ; }

    ; This example will append 6 cells (3 rows / 2 columns).
    ; We'll be appending the following:
    ; 
    ; "Paint", "$100"
    ; "Brakes", "$100"
    ; "New Total", "$335.50"
    ; 

    ; The range of cells we'll be appending is A1:B5
    ; Therefore, the ValueRange JSON we'll be sending in our POST body is:

    ; {
    ;   "range": "Sheet1!A1:B5",
    ;   "majorDimension": "ROWS",
    ;   "values": [
    ;     [
    ;       "Paint",
    ;       "$100"
    ;     ],
    ;     [
    ;       "Brakes",
    ;       "$100"
    ;     ],
    ;     [
    ;       "New Total",
    ;       "$335.50"
    ;     ]
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"range","Sheet1!A1:B5")
    CkJsonObject::ckUpdateString(json,"majorDimension","ROWS")

    CkJsonObject::setCkI(json, 0)
    CkJsonObject::setCkJ(json, 1)
    CkJsonObject::ckUpdateString(json,"values[i][j]","Paint")
    CkJsonObject::setCkJ(json, 1)
    CkJsonObject::ckUpdateString(json,"values[i][j]","$100")

    CkJsonObject::setCkI(json, 1)
    CkJsonObject::setCkJ(json, 0)
    CkJsonObject::ckUpdateString(json,"values[i][j]","Brakes")
    CkJsonObject::setCkJ(json, 1)
    CkJsonObject::ckUpdateString(json,"values[i][j]","$100")

    CkJsonObject::setCkI(json, 2)
    CkJsonObject::setCkJ(json, 0)
    CkJsonObject::ckUpdateString(json,"values[i][j]","Totals")
    CkJsonObject::setCkJ(json, 1)
    CkJsonObject::ckUpdateString(json,"values[i][j]","$335.50")

    CkJsonObject::setCkEmitCompact(json, 0)
    Debug CkJsonObject::ckEmit(json)

    ; Send the POST to:
    ; https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}:append?valueInputOption=USER_ENTERED

    CkHttp::ckSetUrlVar(http,"spreadsheetId","1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA")
    CkHttp::ckSetUrlVar(http,"range","Sheet1!A1:B5")
    resp.i = CkHttp::ckPostJson(http,"https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}:append?valueInputOption=USER_ENTERED",CkJsonObject::ckEmit(json))
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug "response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
    Debug "response JSON = " + CkHttpResponse::ckBodyStr(resp)

    CkHttpResponse::ckDispose(resp)

    ; Sample output:
    ; 
    ; response status code = 200
    ; response JSON = {
    ;   "spreadsheetId": "1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA",
    ;   "tableRange": "Sheet1!A1:B5",
    ;   "updates": {
    ;     "spreadsheetId": "1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA",
    ;     "updatedRange": "Sheet1!A6:B8",
    ;     "updatedRows": 3,
    ;     "updatedColumns": 2,
    ;     "updatedCells": 6
    ;   }
    ; }
    ; 

    ; Our Google Spreadsheet now looks like this:
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure