Pascal (Lazarus/Delphi)

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. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Http,
  Chilkat.HttpResponse,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  jsonToken: TJsonObject;
  http: THttp;
  jsonResponse: string;
  json: TJsonObject;
  urlToUpdate: string;
  xyz: string;
  resp: THttpResponse;

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 := TJsonObject.Create;
  success := jsonToken.LoadFile('qa_data/tokens/googleSheets.json');
  if (jsonToken.HasMember('access_token') = False) then
    begin
      WriteLn('No access token found.');
      Exit;
    end;
  http := THttp.Create;
  http.AuthToken := jsonToken.StringOf('access_token');

  //  First get the cells in the range A1:B5
  http.SetUrlVar('range','Sheet1!A1:B5');
  http.SetUrlVar('spreadsheetId','1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA');
  jsonResponse := http.QuickGetStr('https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}');
  if (http.LastMethodSuccess = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  WriteLn(jsonResponse);

  json := TJsonObject.Create;
  json.EmitCompact := False;
  json.Load(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

  json.I := 3;
  json.J := 1;
  json.UpdateString('values[i][j]','$120');
  json.I := 4;
  json.UpdateString('values[i][j]','$155.50');

  //  Show the updated JSON.
  WriteLn(json.Emit());

  //  Update the Google Sheet using a PUT request.
  json.EmitCompact := True;
  urlToUpdate := 'https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}?valueInputOption=USER_ENTERED';
  xyz := http.QuickGetStr(urlToUpdate);
  resp := THttpResponse.Create;
  success := http.HttpJson('PUT',urlToUpdate,json,'application/json',resp);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  //  Examine the response..
  WriteLn('response status code = ' + resp.StatusCode);
  WriteLn('response body:');
  WriteLn(resp.BodyStr);

  //  A sample response body:

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


  jsonToken.Free;
  http.Free;
  json.Free;
  resp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.