Xojo Plugin

batchGet (Read Multiple Ranges)

See more Google Sheets Examples

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

Dim success As Boolean
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..
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/googleSheets.json")
If (jsonToken.HasMember("access_token") = False) Then
    System.DebugLog("No access token found.")
    Return
End If

// 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"
Dim req As New Chilkat.HttpRequest
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"

Dim http As New Chilkat.Http
http.AuthToken = jsonToken.StringOf("access_token")

// 443 is the SSL/TLS port for HTTPS.
Dim resp As New Chilkat.HttpResponse
success = http.HttpSReq("sheets.googleapis.com",443,True,req,resp)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(resp.BodyStr)

Dim json As New Chilkat.JsonObject
success = 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"
//         ]
//       ]
//     }
//   ]
// }

Dim i As Int32
Dim count_i As Int32
Dim j As Int32
Dim count_j As Int32
Dim k As Int32
Dim count_k As Int32

Dim spreadsheetId As String
spreadsheetId = json.StringOf("spreadsheetId")
i = 0
count_i = json.SizeOfArray("valueRanges")
While i < count_i
    json.I = i
    Dim range As String
    range = json.StringOf("valueRanges[i].range")
    Dim majorDimension As String
    majorDimension = json.StringOf("valueRanges[i].majorDimension")
    j = 0
    count_j = json.SizeOfArray("valueRanges[i].values")
    While j < count_j
        json.J = j
        k = 0
        count_k = json.SizeOfArray("valueRanges[i].values[j]")
        While k < count_k
            json.K = k
            Dim strVal As String
            strVal = json.StringOf("valueRanges[i].values[j][k]")
            k = k + 1
        Wend
        j = j + 1
    Wend
    i = i + 1
Wend