Lua

batchGet (Read Multiple Ranges)

See more Google Sheets Examples

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

local chilkat = require("chilkat")

-- 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..
local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/googleSheets.json")
if not jsonToken:has_member("access_token") then
    print("No access token found.")
    return
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"
local req = chilkat.HttpRequest.new()
req.path = "/v4/spreadsheets/spreadsheetId/values:batchGet"
req.http_verb = "GET"
-- Add each range to fetch.
req:add_param("ranges", "Sheet1!A1:A2")
req:add_param("ranges", "Sheet1!B1:B2")

local http = chilkat.Http.new()
http.auth_token = jsonToken:string_of("access_token")

-- 443 is the SSL/TLS port for HTTPS.
local resp = chilkat.HttpResponse.new()
success = http:http_sreq("sheets.googleapis.com", 443, true, req, resp)
if not success then
    print(http.last_error_text)
    return
end

print(resp.body_str)

local json = chilkat.JsonObject.new()
json:load(resp.body_str)

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

local j = 0
local count_j = 0
local k = 0
local count_k = 0

local spreadsheetId = json:string_of("spreadsheetId")
local i = 0
local count_i = json:size_of_array("valueRanges")
while i < count_i do
    json.i = i
    local range = json:string_of("valueRanges[i].range")
    local majorDimension = json:string_of("valueRanges[i].majorDimension")
    j = 0
    count_j = json:size_of_array("valueRanges[i].values")
    while j < count_j do
        json.j = j
        k = 0
        count_k = json:size_of_array("valueRanges[i].values[j]")
        while k < count_k do
            json.k = k
            local strVal = json:string_of("valueRanges[i].values[j][k]")
            k = k + 1
        end

        j = j + 1
    end

    i = i + 1
end