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

var 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..
var jsonToken = new CkJsonObject();
success = jsonToken.LoadFile("qa_data/tokens/googleSheets.json");
if (jsonToken.HasMember("access_token") == false) {
    console.log("No access token found.");
    return;
}

var http = new CkHttp();
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");
var jsonResponse = http.QuickGetStr("https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}");
if (http.LastMethodSuccess == false) {
    console.log(http.LastErrorText);
    return;
}

console.log(jsonResponse);

var json = new CkJsonObject();
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.
console.log(json.Emit());

//  Update the Google Sheet using a PUT request.
json.EmitCompact = true;
var urlToUpdate = "https://sheets.googleapis.com/v4/spreadsheets/{$spreadsheetId}/values/{$range}?valueInputOption=USER_ENTERED";
var xyz = http.QuickGetStr(urlToUpdate);
var resp = new CkHttpResponse();
success = http.HttpJson("PUT",urlToUpdate,json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

//  Examine the response..
console.log("response status code = " + resp.StatusCode);
console.log("response body:");
console.log(resp.BodyStr);

//  A sample response body:

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