apps-script-samples
apps-script-samples copied to clipboard
Sheets API appendValues does not use newAppendCellsRequest() and range parameter need clarification.
The Google Apps Script snippet for Sheets API Snippets.prototype.appendValues() does not use the provided Sheets.newAppendCellsRequest() sheetId and rows properties.
See
Further, the parameter range JSdoc definition is unclear. It is recommended that the definition be copied from the documentation:
The A1 notation of a range to search for a logical table of data
There are a number of issues with the Sheets.newAppendCellsRequest() that I have raised in the issue tracker here.
Two possible solutions
Both include updated JSDoc descriptions
1. Includes newAppendCellsRequest() correctly in request.
/**
* Appends values to the specified range
* @param {string} spreadsheetId spreadsheet's ID
* @param {string} range The A1 notation of a range to search for a logical table of data.
* @param valueInputOption determines how the input should be interpreted
* @see
* https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption
* @param {*[][]} _values list of rows of values to input
* @returns {*} spreadsheet with appended values
*/
Snippets.prototype.appendValues = (spreadsheetId, range,
valueInputOption, _values) => {
let values = [
[
// Cell values ...
]
// Additional rows ...
];
// [START_EXCLUDE silent]
values = _values;
// [END_EXCLUDE]
try {
let valueRange = Sheets.newRowData();
valueRange.values = values;
let appendRequest = Sheets.newAppendCellsRequest();
appendRequest.sheetId = spreadsheetId;
appendRequest.rows = valueRange;
const result = Sheets.Spreadsheets.Values.append(
appendRequest.rows,
appendRequest.sheetId,
range,
{ valueInputOption: valueInputOption }
);
return result;
} catch (err) {
// TODO (developer) - Handle exception
console.log('Failed with error %s', err.message);
}
};
2. Without newAppendCellsRequest()
/**
* Appends values to the specified range
* @param {string} spreadsheetId spreadsheet's ID
* @param {string} range The A1 notation of a range to search for a logical table of data.
* @param valueInputOption determines how the input should be interpreted
* @see
* https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption
* @param {*[][]} _values list of rows of values to input
* @returns {*} spreadsheet with appended values
*/
Snippets.prototype.appendValues = (spreadsheetId, range,
valueInputOption, _values) => {
let values = [
[
// Cell values ...
]
// Additional rows ...
];
// [START_EXCLUDE silent]
values = _values;
// [END_EXCLUDE]
try {
let valueRange = Sheets.newRowData();
valueRange.values = values;
const result = Sheets.Spreadsheets.Values.append(valueRange, spreadsheetId,
range, {valueInputOption: valueInputOption});
return result;
} catch (err) {
// TODO (developer) - Handle exception
console.log('Failed with error %s', err.message);
}
};