Pascal (Lazarus/Delphi)

Google Sheets - Append Values to an Existing Spreadsheet

See more Google Sheets Examples

Appends values to an existing Google spreadsheet. 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;
  json: TJsonObject;
  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');

  //  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 := TJsonObject.Create;
  json.UpdateString('range','Sheet1!A1:B5');
  json.UpdateString('majorDimension','ROWS');

  json.I := 0;
  json.J := 1;
  json.UpdateString('values[i][j]','Paint');
  json.J := 1;
  json.UpdateString('values[i][j]','$100');

  json.I := 1;
  json.J := 0;
  json.UpdateString('values[i][j]','Brakes');
  json.J := 1;
  json.UpdateString('values[i][j]','$100');

  json.I := 2;
  json.J := 0;
  json.UpdateString('values[i][j]','Totals');
  json.J := 1;
  json.UpdateString('values[i][j]','$335.50');

  json.EmitCompact := False;
  WriteLn(json.Emit());

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

  http.SetUrlVar('spreadsheetId','1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA');
  http.SetUrlVar('range','Sheet1!A1:B5');
  resp := THttpResponse.Create;
  success := http.HttpJson('POST','https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}:append?valueInputOption=USER_ENTERED',json,'application/json',resp);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  WriteLn('response status code = ' + resp.StatusCode);
  WriteLn('response JSON = ' + resp.BodyStr);

  //  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:
  //  


  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.