Delphi DLL Requires Chilkat v11.0.0+

Google Sheets - Update (Set Values in a Range)

See more Google Sheets Examples

Sets values in a range of a spreadsheet. This example will demonstrate by first getting a range, then changing some values in the JSON, and then HTTPS PUT the changes back to the Google Sheet. Delphi DLL

var
success: Boolean;
jsonToken: HCkJsonObject;
http: HCkHttp;
jsonResponse: PWideChar;
json: HCkJsonObject;
urlToUpdate: PWideChar;
xyz: PWideChar;
resp: HCkHttpResponse;

begin
success := False;

//  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 := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/googleSheets.json');
if (CkJsonObject_HasMember(jsonToken,'access_token') = False) then
  begin
    Memo1.Lines.Add('No access token found.');
    Exit;
  end;
http := CkHttp_Create();
CkHttp_putAuthToken(http,CkJsonObject__stringOf(jsonToken,'access_token'));

//  First get the cells in the range A1:B5
CkHttp_SetUrlVar(http,'range','Sheet1!A1:B5');
CkHttp_SetUrlVar(http,'spreadsheetId','1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA');
jsonResponse := CkHttp__quickGetStr(http,'https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(jsonResponse);

json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);
CkJsonObject_Load(json,jsonResponse);

//  A sample response is shown below.

//  {
//    "range": "Sheet1!A1:B5",
//    "majorDimension": "ROWS",
//    "values": [
//      [
//        "Item",
//        "Cost"
//      ],
//      [
//        "Wheel",
//        "$20.50"
//      ],
//      [
//        "Door",
//        "$15"
//      ],
//      [
//        "Engine",
//        "$100"
//      ],
//      [
//        "Totals",
//        "$135.50"
//      ]
//    ]
//  }

//  We're going to change the cost of the Engine to $120, and the Totals to $155.50

CkJsonObject_putI(json,3);
CkJsonObject_putJ(json,1);
CkJsonObject_UpdateString(json,'values[i][j]','$120');
CkJsonObject_putI(json,4);
CkJsonObject_UpdateString(json,'values[i][j]','$155.50');

//  Show the updated JSON.
Memo1.Lines.Add(CkJsonObject__emit(json));

//  Update the Google Sheet using a PUT request.
CkJsonObject_putEmitCompact(json,True);
urlToUpdate := 'https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}?valueInputOption=USER_ENTERED';
xyz := CkHttp__quickGetStr(http,urlToUpdate);
resp := CkHttpResponse_Create();
success := CkHttp_HttpJson(http,'PUT',urlToUpdate,json,'application/json',resp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

//  Examine the response..
Memo1.Lines.Add('response status code = ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add('response body:');
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));

//  A sample response body:

//  {
//    "spreadsheetId": "1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA",
//    "updatedRange": "Sheet1!A1:B5",
//    "updatedRows": 5,
//    "updatedColumns": 2,
//    "updatedCells": 10
//  }

CkJsonObject_Dispose(jsonToken);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkHttpResponse_Dispose(resp);