Pascal (Lazarus/Delphi)

batchGet (Read Multiple Ranges)

See more Google Sheets Examples

Reads multiple ranges from a Google Sheets spreadsheet in one GET request. 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.HttpRequest,
  Chilkat.HttpResponse,
  Chilkat.JsonObject;

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

procedure RunDemo;
var
  success: Boolean;
  jsonToken: TJsonObject;
  req: THttpRequest;
  http: THttp;
  resp: THttpResponse;
  json: TJsonObject;
  i: Integer;
  count_i: Integer;
  j: Integer;
  count_j: Integer;
  k: Integer;
  count_k: Integer;
  spreadsheetId: string;
  range: string;
  majorDimension: string;
  strVal: string;

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;

  //  We'll be sending a GET request with query params to this URL:  https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId/values:batchGet?ranges=Sheet1!A1:A2&ranges=Sheet1!B1:B2
  //  The domain is "sheets.googleapis.com"
  //  The path is "/v4/spreadsheets/spreadsheetId/values:batchGet"
  req := THttpRequest.Create;
  req.Path := '/v4/spreadsheets/spreadsheetId/values:batchGet';
  req.HttpVerb := 'GET';
  //  Add each range to fetch.
  req.AddParam('ranges','Sheet1!A1:A2');
  req.AddParam('ranges','Sheet1!B1:B2');

  http := THttp.Create;
  http.AuthToken := jsonToken.StringOf('access_token');

  //  443 is the SSL/TLS port for HTTPS.
  resp := THttpResponse.Create;
  success := http.HttpSReq('sheets.googleapis.com',443,True,req,resp);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  WriteLn(resp.BodyStr);

  json := TJsonObject.Create;
  json.Load(resp.BodyStr);

  //  A sample response is shown below.
  //  To generate the parsing source code for a JSON response, paste
  //  the JSON into this online tool: Generate JSON parsing code

  //  {
  //    "spreadsheetId": "1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA",
  //    "valueRanges": [
  //      {
  //        "range": "Sheet1!A1:A2",
  //        "majorDimension": "ROWS",
  //        "values": [
  //          [
  //            "Item"
  //          ],
  //          [
  //            "Wheel"
  //          ]
  //        ]
  //      },
  //      {
  //        "range": "Sheet1!B1:B2",
  //        "majorDimension": "ROWS",
  //        "values": [
  //          [
  //            "Cost"
  //          ],
  //          [
  //            "$20.50"
  //          ]
  //        ]
  //      }
  //    ]
  //  }

  spreadsheetId := json.StringOf('spreadsheetId');
  i := 0;
  count_i := json.SizeOfArray('valueRanges');
  while i < count_i do
    begin
      json.I := i;
      range := json.StringOf('valueRanges[i].range');
      majorDimension := json.StringOf('valueRanges[i].majorDimension');
      j := 0;
      count_j := json.SizeOfArray('valueRanges[i].values');
      while j < count_j do
        begin
          json.J := j;
          k := 0;
          count_k := json.SizeOfArray('valueRanges[i].values[j]');
          while k < count_k do
            begin
              json.K := k;
              strVal := json.StringOf('valueRanges[i].values[j][k]');
              k := k + 1;
            end;

          j := j + 1;
        end;

      i := i + 1;
    end;



  jsonToken.Free;
  req.Free;
  http.Free;
  resp.Free;
  json.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.