Lua Requires Chilkat v11.0.0+

Google Sheets - Update (Set Values in a Range)

See more Google Sheets Examples

Sets values in a range of a spreadsheet. This example will demonstrate by first getting a range, then changing some values in the JSON, and then HTTPS PUT the changes back to the Google Sheet. 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

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

-- First get the cells in the range A1:B5
http:set_url_var("range", "Sheet1!A1:B5")
http:set_url_var("spreadsheetId", "1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA")
local jsonResponse = http:quick_get_str("https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}")
if not http.last_method_success then
    print(http.last_error_text)
    return
end

print(jsonResponse)

local json = chilkat.JsonObject.new()
json.emit_compact = false
json:load(jsonResponse)

-- A sample response is shown below.

-- {
--   "range": "Sheet1!A1:B5",
--   "majorDimension": "ROWS",
--   "values": [
--     [
--       "Item",
--       "Cost"
--     ],
--     [
--       "Wheel",
--       "$20.50"
--     ],
--     [
--       "Door",
--       "$15"
--     ],
--     [
--       "Engine",
--       "$100"
--     ],
--     [
--       "Totals",
--       "$135.50"
--     ]
--   ]
-- }

-- We're going to change the cost of the Engine to $120, and the Totals to $155.50

json.i = 3
json.j = 1
json:update_string("values[i][j]", "$120")
json.i = 4
json:update_string("values[i][j]", "$155.50")

-- Show the updated JSON.
print(json:emit())

-- Update the Google Sheet using a PUT request.
json.emit_compact = true
local urlToUpdate = "https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}?valueInputOption=USER_ENTERED"
local xyz = http:quick_get_str(urlToUpdate)
local resp = chilkat.HttpResponse.new()
success = http:http_json("PUT", urlToUpdate, json, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

-- Examine the response..
print("response status code = " .. resp.status_code)
print("response body:")
print(resp.body_str)

-- A sample response body:

-- {
--   "spreadsheetId": "1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA",
--   "updatedRange": "Sheet1!A1:B5",
--   "updatedRows": 5,
--   "updatedColumns": 2,
--   "updatedCells": 10
-- }