CkPython 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. CkPython

import sys
import chilkat

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 = chilkat.CkJsonObject()
success = jsonToken.LoadFile("qa_data/tokens/googleSheets.json")
if (jsonToken.HasMember("access_token") == False):
    print("No access token found.")
    sys.exit()

http = chilkat.CkHttp()
http.put_AuthToken(jsonToken.stringOf("access_token"))

#  First get the cells in the range A1:B5
http.SetUrlVar("range","Sheet1!A1:B5")
http.SetUrlVar("spreadsheetId","1_SO2L-Y6nCayNpNppJLF0r9yHB2UnaCleGCKeE4O0SA")
jsonResponse = http.quickGetStr("https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}")
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

print(jsonResponse)

json = chilkat.CkJsonObject()
json.put_EmitCompact(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.put_I(3)
json.put_J(1)
json.UpdateString("values[i][j]","$120")
json.put_I(4)
json.UpdateString("values[i][j]","$155.50")

#  Show the updated JSON.
print(json.emit())

#  Update the Google Sheet using a PUT request.
json.put_EmitCompact(True)
urlToUpdate = "https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}?valueInputOption=USER_ENTERED"
xyz = http.quickGetStr(urlToUpdate)
resp = chilkat.CkHttpResponse()
success = http.HttpJson("PUT",urlToUpdate,json,"application/json",resp)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

#  Examine the response..
print("response status code = " + str(resp.get_StatusCode()))
print("response body:")
print(resp.bodyStr())

#  A sample response body:

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