Delphi DLL

batchGet (Read Multiple Ranges)

See more Google Sheets Examples

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

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, HttpRequest, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
jsonToken: HCkJsonObject;
req: HCkHttpRequest;
http: HCkHttp;
resp: HCkHttpResponse;
json: HCkJsonObject;
i: Integer;
count_i: Integer;
j: Integer;
count_j: Integer;
k: Integer;
count_k: Integer;
spreadsheetId: PWideChar;
range: PWideChar;
majorDimension: PWideChar;
strVal: PWideChar;

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;

// 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 := CkHttpRequest_Create();
CkHttpRequest_putPath(req,'/v4/spreadsheets/spreadsheetId/values:batchGet');
CkHttpRequest_putHttpVerb(req,'GET');
// Add each range to fetch.
CkHttpRequest_AddParam(req,'ranges','Sheet1!A1:A2');
CkHttpRequest_AddParam(req,'ranges','Sheet1!B1:B2');

http := CkHttp_Create();
CkHttp_putAuthToken(http,CkJsonObject__stringOf(jsonToken,'access_token'));

// 443 is the SSL/TLS port for HTTPS.
resp := CkHttpResponse_Create();
success := CkHttp_HttpSReq(http,'sheets.googleapis.com',443,True,req,resp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));

json := CkJsonObject_Create();
CkJsonObject_Load(json,CkHttpResponse__bodyStr(resp));

// 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 := CkJsonObject__stringOf(json,'spreadsheetId');
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'valueRanges');
while i < count_i do
  begin
    CkJsonObject_putI(json,i);
    range := CkJsonObject__stringOf(json,'valueRanges[i].range');
    majorDimension := CkJsonObject__stringOf(json,'valueRanges[i].majorDimension');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(json,'valueRanges[i].values');
    while j < count_j do
      begin
        CkJsonObject_putJ(json,j);
        k := 0;
        count_k := CkJsonObject_SizeOfArray(json,'valueRanges[i].values[j]');
        while k < count_k do
          begin
            CkJsonObject_putK(json,k);
            strVal := CkJsonObject__stringOf(json,'valueRanges[i].values[j][k]');
            k := k + 1;
          end;

        j := j + 1;
      end;

    i := i + 1;
  end;

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

end;