VB.NET

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. VB.NET

Dim success As Boolean = 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
    Debug.WriteLine("No access token found.")
    Exit Sub
End If

Dim http As New Chilkat.Http
http.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")
Dim jsonResponse As String = http.QuickGetStr("https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}")
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(jsonResponse)

Dim json As New Chilkat.JsonObject
json.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.I = 3
json.J = 1
json.UpdateString("values[i][j]","$120")
json.I = 4
json.UpdateString("values[i][j]","$155.50")

' Show the updated JSON.
Debug.WriteLine(json.Emit())

' Update the Google Sheet using a PUT request.
json.EmitCompact = True
Dim urlToUpdate As String = "https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}?valueInputOption=USER_ENTERED"
Dim xyz As String = http.QuickGetStr(urlToUpdate)
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("PUT",urlToUpdate,json,"application/json",resp)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


' Examine the response..
Debug.WriteLine("response status code = " & resp.StatusCode)
Debug.WriteLine("response body:")
Debug.WriteLine(resp.BodyStr)

' A sample response body:

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