Delphi ActiveX

batchGet (Read Multiple Ranges)

See more Google Sheets Examples

Reads multiple ranges from a Google Sheets spreadsheet in one GET request. Delphi ActiveX

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
jsonToken: TChilkatJsonObject;
req: TChilkatHttpRequest;
http: TChilkatHttp;
resp: TChilkatHttpResponse;
json: TChilkatJsonObject;
i: Integer;
count_i: Integer;
j: Integer;
count_j: Integer;
k: Integer;
count_k: Integer;
spreadsheetId: WideString;
range: WideString;
majorDimension: WideString;
strVal: WideString;

begin
success := 0;

// 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 := TChilkatJsonObject.Create(Self);
success := jsonToken.LoadFile('qa_data/tokens/googleSheets.json');
if (jsonToken.HasMember('access_token') = 0) then
  begin
    Memo1.Lines.Add('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 := TChilkatHttpRequest.Create(Self);
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 := TChilkatHttp.Create(Self);
http.AuthToken := jsonToken.StringOf('access_token');

// 443 is the SSL/TLS port for HTTPS.
resp := TChilkatHttpResponse.Create(Self);
success := http.HttpSReq('sheets.googleapis.com',443,1,req.ControlInterface,resp.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(resp.BodyStr);

json := TChilkatJsonObject.Create(Self);
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;
end;