(Lianja) batchGet (Read Multiple Ranges)

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

//  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..
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/googleSheets.json")
if (loJsonToken.HasMember("access_token") = .F.) then
    ? "No access token found."
    release loJsonToken
    return
endif

//  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"
loReq = createobject("CkHttpRequest")
loReq.Path = "/v4/spreadsheets/spreadsheetId/values:batchGet"
loReq.HttpVerb = "GET"
//  Add each range to fetch.
loReq.AddParam("ranges","Sheet1!A1:A2")
loReq.AddParam("ranges","Sheet1!B1:B2")

loHttp = createobject("CkHttp")
loHttp.AuthToken = loJsonToken.StringOf("access_token")

//  443 is the SSL/TLS port for HTTPS.
loResp = loHttp.SynchronousRequest("sheets.googleapis.com",443,.T.,loReq)
if (loHttp.LastMethodSuccess <> .T.) then
    ? loHttp.LastErrorText
    release loJsonToken
    release loReq
    release loHttp
    return
endif

? loResp.BodyStr

loJson = createobject("CkJsonObject")
loJson.Load(loResp.BodyStr)

release loResp

//  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"
//          ]
//        ]
//      }
//    ]
//  }

lcSpreadsheetId = loJson.StringOf("spreadsheetId")
i = 0
lnCount_i = loJson.SizeOfArray("valueRanges")
do while i < lnCount_i
    loJson.I = i
    lcRange = loJson.StringOf("valueRanges[i].range")
    lcMajorDimension = loJson.StringOf("valueRanges[i].majorDimension")
    j = 0
    lnCount_j = loJson.SizeOfArray("valueRanges[i].values")
    do while j < lnCount_j
        loJson.J = j
        k = 0
        lnCount_k = loJson.SizeOfArray("valueRanges[i].values[j]")
        do while k < lnCount_k
            loJson.K = k
            lcStrVal = loJson.StringOf("valueRanges[i].values[j][k]")
            k = k + 1
        enddo
        j = j + 1
    enddo
    i = i + 1
enddo


release loJsonToken
release loReq
release loHttp
release loJson