senaduka/old-slucajna-televizija
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
Files
6beabc3cd0aa326d2f0fe8e8dccb2adba0110341
old-slucajna-televizija/backend/node_modules/googleapis/apis/sheets/v4.ts
GotPPay a75ea978f9 ..
2017-10-16 20:21:19 +02:00

3492 lines
147 KiB
TypeScript
Raw Blame History

/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* jshint maxlen: false */
import createAPIRequest from '../../lib/apirequest';
/**
* Google Sheets API
*
* Reads and writes Google Sheets.
*
* @example
* const google = require('googleapis');
* const sheets = google.sheets('v4');
*
* @namespace sheets
* @type {Function}
* @version v4
* @variation v4
* @param {object=} options Options for Sheets
*/
function Sheets(options) { // eslint-disable-line
const self = this;
self._options = options || {};
self.spreadsheets = {
/**
* sheets.spreadsheets.batchUpdate
*
* @desc Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The spreadsheet to apply the updates to.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // A list of updates to apply to the spreadsheet.
* // Requests will be applied in the order they are specified.
* // If any request is not valid, no requests will be applied.
* requests: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.batchUpdate(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.batchUpdate
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The spreadsheet to apply the updates to.
* @param {sheets(v4).BatchUpdateSpreadsheetRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}:batchUpdate').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.create
*
* @desc Creates a spreadsheet, returning the newly created spreadsheet.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.create(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.create
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {sheets(v4).Spreadsheet} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.get
*
* @desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The spreadsheet to request.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The ranges to retrieve from the spreadsheet.
* ranges: [], // TODO: Update placeholder value.
*
* // True if grid data should be returned.
* // This parameter is ignored if a field mask was set in the request.
* includeGridData: false, // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/drive.readonly'
* // 'https://www.googleapis.com/auth/spreadsheets'
* // 'https://www.googleapis.com/auth/spreadsheets.readonly'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.get
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeGridData True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
* @param {string=} params.ranges The ranges to retrieve from the spreadsheet.
* @param {string} params.spreadsheetId The spreadsheet to request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.getByDataFilter
*
* @desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.
*
* @alias sheets.spreadsheets.getByDataFilter
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The spreadsheet to request.
* @param {sheets(v4).GetSpreadsheetByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getByDataFilter: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}:getByDataFilter').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
developerMetadata: {
/**
* sheets.spreadsheets.developerMetadata.get
*
* @desc Returns the developer metadata with the specified id. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.
*
* @alias sheets.spreadsheets.developerMetadata.get
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {integer} params.metadataId The ID of the developer metadata to retrieve.
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve metadata from.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['spreadsheetId', 'metadataId'],
pathParams: ['metadataId', 'spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.developerMetadata.search
*
* @desc Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.
*
* @alias sheets.spreadsheets.developerMetadata.search
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve metadata from.
* @param {sheets(v4).SearchDeveloperMetadataRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/developerMetadata:search').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
}
},
sheets: {
/**
* sheets.spreadsheets.sheets.copyTo
*
* @desc Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet containing the sheet to copy.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The ID of the sheet to copy.
* sheetId: 0, // TODO: Update placeholder value.
*
* resource: {
* // The ID of the spreadsheet to copy the sheet to.
* destinationSpreadsheetId: '', // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.sheets.copyTo(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.sheets.copyTo
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {integer} params.sheetId The ID of the sheet to copy.
* @param {string} params.spreadsheetId The ID of the spreadsheet containing the sheet to copy.
* @param {sheets(v4).CopySheetToAnotherSpreadsheetRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
copyTo: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId', 'sheetId'],
pathParams: ['sheetId', 'spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
}
},
values: {
/**
* sheets.spreadsheets.values.append
*
* @desc Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of a range to search for a logical table of data.
* // Values will be appended after the last row of the table.
* range: 'my-range', // TODO: Update placeholder value.
*
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* // How the input data should be inserted.
* insertDataOption: '', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.append(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.append
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
* @param {string=} params.insertDataOption How the input data should be inserted.
* @param {string} params.range The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.
* @param {string=} params.responseDateTimeRenderOption Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.responseValueRenderOption Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {string=} params.valueInputOption How the input data should be interpreted.
* @param {sheets(v4).ValueRange} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
append: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values/{range}:append').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId', 'range'],
pathParams: ['range', 'spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.batchClear
*
* @desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // The ranges to clear, in A1 notation.
* ranges: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchClear(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.batchClear
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {sheets(v4).BatchClearValuesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchClear: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values:batchClear').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.batchClearByDataFilter
*
* @desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
*
* @alias sheets.spreadsheets.values.batchClearByDataFilter
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {sheets(v4).BatchClearValuesByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchClearByDataFilter: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.batchGet
*
* @desc Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve data from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to retrieve.
* ranges: [], // TODO: Update placeholder value.
*
* // How values should be represented in the output.
* // The default render option is ValueRenderOption.FORMATTED_VALUE.
* valueRenderOption: '', // TODO: Update placeholder value.
*
* // How dates, times, and durations should be represented in the output.
* // This is ignored if value_render_option is
* // FORMATTED_VALUE.
* // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* dateTimeRenderOption: '', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchGet(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/drive.readonly'
* // 'https://www.googleapis.com/auth/spreadsheets'
* // 'https://www.googleapis.com/auth/spreadsheets.readonly'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.batchGet
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string=} params.dateTimeRenderOption How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
* @param {string=} params.ranges The A1 notation of the values to retrieve.
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from.
* @param {string=} params.valueRenderOption How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchGet: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values:batchGet').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.batchGetByDataFilter
*
* @desc Returns one or more ranges of values from a spreadsheet that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.
*
* @alias sheets.spreadsheets.values.batchGetByDataFilter
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from.
* @param {sheets(v4).BatchGetValuesByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchGetByDataFilter: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.batchUpdate
*
* @desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* // The new values to apply to the spreadsheet.
* data: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchUpdate(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.batchUpdate
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {sheets(v4).BatchUpdateValuesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values:batchUpdate').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.batchUpdateByDataFilter
*
* @desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
*
* @alias sheets.spreadsheets.values.batchUpdateByDataFilter
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {sheets(v4).BatchUpdateValuesByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdateByDataFilter: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId'],
pathParams: ['spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.clear
*
* @desc Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to clear.
* range: 'my-range', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.clear(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.clear
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string} params.range The A1 notation of the values to clear.
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {sheets(v4).ClearValuesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
clear: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values/{range}:clear').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['spreadsheetId', 'range'],
pathParams: ['range', 'spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.get
*
* @desc Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve data from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to retrieve.
* range: 'my-range', // TODO: Update placeholder value.
*
* // How values should be represented in the output.
* // The default render option is ValueRenderOption.FORMATTED_VALUE.
* valueRenderOption: '', // TODO: Update placeholder value.
*
* // How dates, times, and durations should be represented in the output.
* // This is ignored if value_render_option is
* // FORMATTED_VALUE.
* // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* dateTimeRenderOption: '', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/drive.readonly'
* // 'https://www.googleapis.com/auth/spreadsheets'
* // 'https://www.googleapis.com/auth/spreadsheets.readonly'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.get
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {string=} params.dateTimeRenderOption How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
* @param {string} params.range The A1 notation of the values to retrieve.
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from.
* @param {string=} params.valueRenderOption How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values/{range}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['spreadsheetId', 'range'],
pathParams: ['range', 'spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* sheets.spreadsheets.values.update
*
* @desc Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
*
* @example
* // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to update.
* range: 'my-range', // TODO: Update placeholder value.
*
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.update(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
*
* @alias sheets.spreadsheets.values.update
* @memberOf! sheets(v4)
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).
* @param {string} params.range The A1 notation of the values to update.
* @param {string=} params.responseDateTimeRenderOption Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.responseValueRenderOption Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {string=} params.valueInputOption How the input data should be interpreted.
* @param {sheets(v4).ValueRange} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://sheets.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/v4/spreadsheets/{spreadsheetId}/values/{range}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PUT'
}, options),
params: params,
requiredParams: ['spreadsheetId', 'range'],
pathParams: ['range', 'spreadsheetId'],
context: self
};
return createAPIRequest(parameters, callback);
}
}
};
}
/**
* @typedef AddBandingRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BandedRange} bandedRange The banded range to add. The bandedRangeId
field is optional; if one is not set, an id will be randomly generated. (It
is an error to specify the ID of a range that already exists.)
*/
/**
* @typedef AddBandingResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BandedRange} bandedRange The banded range that was added.
*/
/**
* @typedef AddChartRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).EmbeddedChart} chart The chart that should be added to the spreadsheet, including the position
where it should be placed. The chartId
field is optional; if one is not set, an id will be randomly generated. (It
is an error to specify the ID of a chart that already exists.)
*/
/**
* @typedef AddChartResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).EmbeddedChart} chart The newly added chart.
*/
/**
* @typedef AddConditionalFormatRuleRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} index The zero-based index where the rule should be inserted.
* @property {sheets(v4).ConditionalFormatRule} rule The rule to add.
*/
/**
* @typedef AddFilterViewRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).FilterView} filter The filter to add. The filterViewId
field is optional; if one is not set, an id will be randomly generated. (It
is an error to specify the ID of a filter that already exists.)
*/
/**
* @typedef AddFilterViewResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).FilterView} filter The newly added filter view.
*/
/**
* @typedef AddNamedRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).NamedRange} namedRange The named range to add. The namedRangeId
field is optional; if one is not set, an id will be randomly generated. (It
is an error to specify the ID of a range that already exists.)
*/
/**
* @typedef AddNamedRangeResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).NamedRange} namedRange The named range to add.
*/
/**
* @typedef AddProtectedRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ProtectedRange} protectedRange The protected range to be added. The
protectedRangeId field is optional; if
one is not set, an id will be randomly generated. (It is an error to
specify the ID of a range that already exists.)
*/
/**
* @typedef AddProtectedRangeResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ProtectedRange} protectedRange The newly added protected range.
*/
/**
* @typedef AddSheetRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).SheetProperties} properties The properties the new sheet should have.
All properties are optional.
The sheetId field is optional; if one is not
set, an id will be randomly generated. (It is an error to specify the ID
of a sheet that already exists.)
*/
/**
* @typedef AddSheetResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).SheetProperties} properties The properties of the newly added sheet.
*/
/**
* @typedef AppendCellsRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields of CellData that should be updated.
At least one field must be specified.
The root is the CellData; 'row.values.' should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).RowData[]} rows The data to append.
* @property {integer} sheetId The sheet ID to append the data to.
*/
/**
* @typedef AppendDimensionRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} dimension Whether rows or columns should be appended.
* @property {integer} length The number of rows or columns to append.
* @property {integer} sheetId The sheet to append rows or columns to.
*/
/**
* @typedef AppendValuesResponse
* @memberOf! sheets(v4)
* @type object
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
* @property {string} tableRange The range (in A1 notation) of the table that values are being appended to
(before the values were appended).
Empty if no table was found.
* @property {sheets(v4).UpdateValuesResponse} updates Information about the updates that were applied.
*/
/**
* @typedef AutoFillRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range to autofill. This will examine the range and detect
the location that has data and automatically fill that data
in to the rest of the range.
* @property {sheets(v4).SourceAndDestination} sourceAndDestination The source and destination areas to autofill.
This explicitly lists the source of the autofill and where to
extend that data.
* @property {boolean} useAlternateSeries True if we should generate data with the "alternate" series.
This differs based on the type and amount of source data.
*/
/**
* @typedef AutoResizeDimensionsRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DimensionRange} dimensions The dimensions to automatically resize.
*/
/**
* @typedef BandedRange
* @memberOf! sheets(v4)
* @type object
* @property {integer} bandedRangeId The id of the banded range.
* @property {sheets(v4).BandingProperties} columnProperties Properties for column bands. These properties will be applied on a column-
by-column basis throughout all the columns in the range. At least one of
row_properties or column_properties must be specified.
* @property {sheets(v4).GridRange} range The range over which these properties are applied.
* @property {sheets(v4).BandingProperties} rowProperties Properties for row bands. These properties will be applied on a row-by-row
basis throughout all the rows in the range. At least one of
row_properties or column_properties must be specified.
*/
/**
* @typedef BandingProperties
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Color} firstBandColor The first color that is alternating. (Required)
* @property {sheets(v4).Color} footerColor The color of the last row or column. If this field is not set, the last
row or column will be filled with either first_band_color or
second_band_color, depending on the color of the previous row or
column.
* @property {sheets(v4).Color} headerColor The color of the first row or column. If this field is set, the first
row or column will be filled with this color and the colors will
alternate between first_band_color and second_band_color starting
from the second row or column. Otherwise, the first row or column will be
filled with first_band_color and the colors will proceed to alternate
as they normally would.
* @property {sheets(v4).Color} secondBandColor The second color that is alternating. (Required)
*/
/**
* @typedef BasicChartAxis
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).TextFormat} format The format of the title.
Only valid if the axis is not associated with the domain.
* @property {string} position The position of this axis.
* @property {string} title The title of this axis. If set, this overrides any title inferred
from headers of the data.
*/
/**
* @typedef BasicChartDomain
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartData} domain The data of the domain. For example, if charting stock prices over time,
this is the data representing the dates.
* @property {boolean} reversed True to reverse the order of the domain values (horizontal axis).
*/
/**
* @typedef BasicChartSeries
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartData} series The data being visualized in this chart series.
* @property {string} targetAxis The minor axis that will specify the range of values for this series.
For example, if charting stocks over time, the "Volume" series
may want to be pinned to the right with the prices pinned to the left,
because the scale of trading volume is different than the scale of
prices.
It is an error to specify an axis that isn't a valid minor axis
for the chart's type.
* @property {string} type The type of this series. Valid only if the
chartType is
COMBO.
Different types will change the way the series is visualized.
Only LINE, AREA,
and COLUMN are supported.
*/
/**
* @typedef BasicChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BasicChartAxis[]} axis The axis on the chart.
* @property {string} chartType The type of the chart.
* @property {sheets(v4).BasicChartDomain[]} domains The domain of data this is charting.
Only a single domain is supported.
* @property {integer} headerCount The number of rows or columns in the data that are "headers".
If not set, Google Sheets will guess how many rows are headers based
on the data.
(Note that BasicChartAxis.title may override the axis title
inferred from the header values.)
* @property {boolean} interpolateNulls If some values in a series are missing, gaps may appear in the chart (e.g,
segments of lines in a line chart will be missing). To eliminate these
gaps set this to true.
Applies to Line, Area, and Combo charts.
* @property {string} legendPosition The position of the chart legend.
* @property {boolean} lineSmoothing Gets whether all lines should be rendered smooth or straight by default.
Applies to Line charts.
* @property {sheets(v4).BasicChartSeries[]} series The data this chart is visualizing.
* @property {string} stackedType The stacked type for charts that support vertical stacking.
Applies to Area, Bar, Column, and Stepped Area charts.
* @property {boolean} threeDimensional True to make the chart 3D.
Applies to Bar and Column charts.
*/
/**
* @typedef BasicFilter
* @memberOf! sheets(v4)
* @type object
* @property {object} criteria The criteria for showing/hiding values per column.
The map's key is the column index, and the value is the criteria for
that column.
* @property {sheets(v4).GridRange} range The range the filter covers.
* @property {sheets(v4).SortSpec[]} sortSpecs The sort order per column. Later specifications are used when values
are equal in the earlier specifications.
*/
/**
* @typedef BatchClearValuesByDataFilterRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters The DataFilters used to determine which ranges to clear.
*/
/**
* @typedef BatchClearValuesByDataFilterResponse
* @memberOf! sheets(v4)
* @type object
* @property {string[]} clearedRanges The ranges that were cleared, in A1 notation.
(If the requests were for an unbounded range or a ranger larger
than the bounds of the sheet, this will be the actual ranges
that were cleared, bounded to the sheet's limits.)
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
*/
/**
* @typedef BatchClearValuesRequest
* @memberOf! sheets(v4)
* @type object
* @property {string[]} ranges The ranges to clear, in A1 notation.
*/
/**
* @typedef BatchClearValuesResponse
* @memberOf! sheets(v4)
* @type object
* @property {string[]} clearedRanges The ranges that were cleared, in A1 notation.
(If the requests were for an unbounded range or a ranger larger
than the bounds of the sheet, this will be the actual ranges
that were cleared, bounded to the sheet's limits.)
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
*/
/**
* @typedef BatchGetValuesByDataFilterRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters The data filters used to match the ranges of values to retrieve. Ranges
that match any of the specified data filters will be included in the
response.
* @property {string} dateTimeRenderOption How dates, times, and durations should be represented in the output.
This is ignored if value_render_option is
FORMATTED_VALUE.
The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @property {string} majorDimension The major dimension that results should use.
For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
then a request that selects that range and sets `majorDimension=ROWS` will
return `[[1,2],[3,4]]`,
whereas a request that sets `majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`.
* @property {string} valueRenderOption How values should be represented in the output.
The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
/**
* @typedef BatchGetValuesByDataFilterResponse
* @memberOf! sheets(v4)
* @type object
* @property {string} spreadsheetId The ID of the spreadsheet the data was retrieved from.
* @property {sheets(v4).MatchedValueRange[]} valueRanges The requested values with the list of data filters that matched them.
*/
/**
* @typedef BatchGetValuesResponse
* @memberOf! sheets(v4)
* @type object
* @property {string} spreadsheetId The ID of the spreadsheet the data was retrieved from.
* @property {sheets(v4).ValueRange[]} valueRanges The requested values. The order of the ValueRanges is the same as the
order of the requested ranges.
*/
/**
* @typedef BatchUpdateSpreadsheetRequest
* @memberOf! sheets(v4)
* @type object
* @property {boolean} includeSpreadsheetInResponse Determines if the update response should include the spreadsheet
resource.
* @property {sheets(v4).Request[]} requests A list of updates to apply to the spreadsheet.
Requests will be applied in the order they are specified.
If any request is not valid, no requests will be applied.
* @property {boolean} responseIncludeGridData True if grid data should be returned. Meaningful only if
if include_spreadsheet_response is 'true'.
This parameter is ignored if a field mask was set in the request.
* @property {string[]} responseRanges Limits the ranges included in the response spreadsheet.
Meaningful only if include_spreadsheet_response is 'true'.
*/
/**
* @typedef BatchUpdateSpreadsheetResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Response[]} replies The reply of the updates. This maps 1:1 with the updates, although
replies to some requests may be empty.
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
* @property {sheets(v4).Spreadsheet} updatedSpreadsheet The spreadsheet after updates were applied. This is only set if
[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.
*/
/**
* @typedef BatchUpdateValuesByDataFilterRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilterValueRange[]} data The new values to apply to the spreadsheet. If more than one range is
matched by the specified DataFilter the specified values will be
applied to all of of those ranges.
* @property {boolean} includeValuesInResponse Determines if the update response should include the values
of the cells that were updated. By default, responses
do not include the updated values. The `updatedData` field within
each of the BatchUpdateValuesResponse.responses will contain
the updated values. If the range to write was larger than than the range
actually written, the response will include all values in the requested
range (excluding trailing empty rows and columns).
* @property {string} responseDateTimeRenderOption Determines how dates, times, and durations in the response should be
rendered. This is ignored if response_value_render_option is
FORMATTED_VALUE.
The default dateTime render option is
DateTimeRenderOption.SERIAL_NUMBER.
* @property {string} responseValueRenderOption Determines how values in the response should be rendered.
The default render option is ValueRenderOption.FORMATTED_VALUE.
* @property {string} valueInputOption How the input data should be interpreted.
*/
/**
* @typedef BatchUpdateValuesByDataFilterResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).UpdateValuesByDataFilterResponse[]} responses The response for each range updated.
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
* @property {integer} totalUpdatedCells The total number of cells updated.
* @property {integer} totalUpdatedColumns The total number of columns where at least one cell in the column was
updated.
* @property {integer} totalUpdatedRows The total number of rows where at least one cell in the row was updated.
* @property {integer} totalUpdatedSheets The total number of sheets where at least one cell in the sheet was
updated.
*/
/**
* @typedef BatchUpdateValuesRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ValueRange[]} data The new values to apply to the spreadsheet.
* @property {boolean} includeValuesInResponse Determines if the update response should include the values
of the cells that were updated. By default, responses
do not include the updated values. The `updatedData` field within
each of the BatchUpdateValuesResponse.responses will contain
the updated values. If the range to write was larger than than the range
actually written, the response will include all values in the requested
range (excluding trailing empty rows and columns).
* @property {string} responseDateTimeRenderOption Determines how dates, times, and durations in the response should be
rendered. This is ignored if response_value_render_option is
FORMATTED_VALUE.
The default dateTime render option is
DateTimeRenderOption.SERIAL_NUMBER.
* @property {string} responseValueRenderOption Determines how values in the response should be rendered.
The default render option is ValueRenderOption.FORMATTED_VALUE.
* @property {string} valueInputOption How the input data should be interpreted.
*/
/**
* @typedef BatchUpdateValuesResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).UpdateValuesResponse[]} responses One UpdateValuesResponse per requested range, in the same order as
the requests appeared.
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
* @property {integer} totalUpdatedCells The total number of cells updated.
* @property {integer} totalUpdatedColumns The total number of columns where at least one cell in the column was
updated.
* @property {integer} totalUpdatedRows The total number of rows where at least one cell in the row was updated.
* @property {integer} totalUpdatedSheets The total number of sheets where at least one cell in the sheet was
updated.
*/
/**
* @typedef BooleanCondition
* @memberOf! sheets(v4)
* @type object
* @property {string} type The type of condition.
* @property {sheets(v4).ConditionValue[]} values The values of the condition. The number of supported values depends
on the condition type. Some support zero values,
others one or two values,
and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
*/
/**
* @typedef BooleanRule
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BooleanCondition} condition The condition of the rule. If the condition evaluates to true,
the format will be applied.
* @property {sheets(v4).CellFormat} format The format to apply.
Conditional formatting can only apply a subset of formatting:
bold, italic,
strikethrough,
foreground color &
background color.
*/
/**
* @typedef Border
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Color} color The color of the border.
* @property {string} style The style of the border.
* @property {integer} width The width of the border, in pixels.
Deprecated; the width is determined by the "style" field.
*/
/**
* @typedef Borders
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Border} bottom The bottom border of the cell.
* @property {sheets(v4).Border} left The left border of the cell.
* @property {sheets(v4).Border} right The right border of the cell.
* @property {sheets(v4).Border} top The top border of the cell.
*/
/**
* @typedef BubbleChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Color} bubbleBorderColor The bubble border color.
* @property {sheets(v4).ChartData} bubbleLabels The data containing the bubble labels. These do not need to be unique.
* @property {integer} bubbleMaxRadiusSize The max radius size of the bubbles, in pixels.
If specified, the field must be a positive value.
* @property {integer} bubbleMinRadiusSize The minimum radius size of the bubbles, in pixels.
If specific, the field must be a positive value.
* @property {number} bubbleOpacity The opacity of the bubbles between 0 and 1.0.
0 is fully transparent and 1 is fully opaque.
* @property {sheets(v4).ChartData} bubbleSizes The data contianing the bubble sizes. Bubble sizes are used to draw
the bubbles at different sizes relative to each other.
If specified, group_ids must also be specified. This field is
optional.
* @property {sheets(v4).TextFormat} bubbleTextStyle The format of the text inside the bubbles.
Underline and Strikethrough are not supported.
* @property {sheets(v4).ChartData} domain The data containing the bubble x-values. These values locate the bubbles
in the chart horizontally.
* @property {sheets(v4).ChartData} groupIds The data containing the bubble group IDs. All bubbles with the same group
ID will be drawn in the same color. If bubble_sizes is specified then
this field must also be specified but may contain blank values.
This field is optional.
* @property {string} legendPosition Where the legend of the chart should be drawn.
* @property {sheets(v4).ChartData} series The data contianing the bubble y-values. These values locate the bubbles
in the chart vertically.
*/
/**
* @typedef CandlestickChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).CandlestickData[]} data The Candlestick chart data.
Only one CandlestickData is supported.
* @property {sheets(v4).CandlestickDomain} domain The domain data (horizontal axis) for the candlestick chart. String data
will be treated as discrete labels, other data will be treated as
continuous values.
*/
/**
* @typedef CandlestickData
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).CandlestickSeries} closeSeries The range data (vertical axis) for the close/final value for each candle.
This is the top of the candle body. If greater than the open value the
candle will be filled. Otherwise the candle will be hollow.
* @property {sheets(v4).CandlestickSeries} highSeries The range data (vertical axis) for the high/maximum value for each
candle. This is the top of the candle's center line.
* @property {sheets(v4).CandlestickSeries} lowSeries The range data (vertical axis) for the low/minimum value for each candle.
This is the bottom of the candle's center line.
* @property {sheets(v4).CandlestickSeries} openSeries The range data (vertical axis) for the open/initial value for each
candle. This is the bottom of the candle body. If less than the close
value the candle will be filled. Otherwise the candle will be hollow.
*/
/**
* @typedef CandlestickDomain
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartData} data The data of the CandlestickDomain.
* @property {boolean} reversed True to reverse the order of the domain values (horizontal axis).
*/
/**
* @typedef CandlestickSeries
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartData} data The data of the CandlestickSeries.
*/
/**
* @typedef CellData
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataValidationRule} dataValidation A data validation rule on the cell, if any.
When writing, the new data validation rule will overwrite any prior rule.
* @property {sheets(v4).CellFormat} effectiveFormat The effective format being used by the cell.
This includes the results of applying any conditional formatting and,
if the cell contains a formula, the computed number format.
If the effective format is the default format, effective format will
not be written.
This field is read-only.
* @property {sheets(v4).ExtendedValue} effectiveValue The effective value of the cell. For cells with formulas, this will be
the calculated value. For cells with literals, this will be
the same as the user_entered_value.
This field is read-only.
* @property {string} formattedValue The formatted value of the cell.
This is the value as it's shown to the user.
This field is read-only.
* @property {string} hyperlink A hyperlink this cell points to, if any.
This field is read-only. (To set it, use a `=HYPERLINK` formula
in the userEnteredValue.formulaValue
field.)
* @property {string} note Any note on the cell.
* @property {sheets(v4).PivotTable} pivotTable A pivot table anchored at this cell. The size of pivot table itself
is computed dynamically based on its data, grouping, filters, values,
etc. Only the top-left cell of the pivot table contains the pivot table
definition. The other cells will contain the calculated values of the
results of the pivot in their effective_value fields.
* @property {sheets(v4).TextFormatRun[]} textFormatRuns Runs of rich text applied to subsections of the cell. Runs are only valid
on user entered strings, not formulas, bools, or numbers.
Runs start at specific indexes in the text and continue until the next
run. Properties of a run will continue unless explicitly changed
in a subsequent run (and properties of the first run will continue
the properties of the cell unless explicitly changed).
When writing, the new runs will overwrite any prior runs. When writing a
new user_entered_value, previous runs will be erased.
* @property {sheets(v4).CellFormat} userEnteredFormat The format the user entered for the cell.
When writing, the new format will be merged with the existing format.
* @property {sheets(v4).ExtendedValue} userEnteredValue The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
Note: Dates, Times and DateTimes are represented as doubles in
serial number format.
*/
/**
* @typedef CellFormat
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Color} backgroundColor The background color of the cell.
* @property {sheets(v4).Borders} borders The borders of the cell.
* @property {string} horizontalAlignment The horizontal alignment of the value in the cell.
* @property {string} hyperlinkDisplayType How a hyperlink, if it exists, should be displayed in the cell.
* @property {sheets(v4).NumberFormat} numberFormat A format describing how number values should be represented to the user.
* @property {sheets(v4).Padding} padding The padding of the cell.
* @property {string} textDirection The direction of the text in the cell.
* @property {sheets(v4).TextFormat} textFormat The format of the text in the cell (unless overridden by a format run).
* @property {sheets(v4).TextRotation} textRotation The rotation applied to text in a cell
* @property {string} verticalAlignment The vertical alignment of the value in the cell.
* @property {string} wrapStrategy The wrap strategy for the value in the cell.
*/
/**
* @typedef ChartData
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartSourceRange} sourceRange The source ranges of the data.
*/
/**
* @typedef ChartSourceRange
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange[]} sources The ranges of data for a series or domain.
Exactly one dimension must have a length of 1,
and all sources in the list must have the same dimension
with length 1.
The domain (if it exists) & all series must have the same number
of source ranges. If using more than one source range, then the source
range at a given offset must be contiguous across the domain and series.
For example, these are valid configurations:
domain sources: A1:A5
series1 sources: B1:B5
series2 sources: D6:D10
domain sources: A1:A5, C10:C12
series1 sources: B1:B5, D10:D12
series2 sources: C1:C5, E10:E12
*/
/**
* @typedef ChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {string} altText The alternative text that describes the chart. This is often used
for accessibility.
* @property {sheets(v4).Color} backgroundColor The background color of the entire chart.
Not applicable to Org charts.
* @property {sheets(v4).BasicChartSpec} basicChart A basic chart specification, can be one of many kinds of charts.
See BasicChartType for the list of all
charts this supports.
* @property {sheets(v4).BubbleChartSpec} bubbleChart A bubble chart specification.
* @property {sheets(v4).CandlestickChartSpec} candlestickChart A candlestick chart specification.
* @property {string} fontName The name of the font to use by default for all chart text (e.g. title,
axis labels, legend). If a font is specified for a specific part of the
chart it will override this font name.
* @property {string} hiddenDimensionStrategy Determines how the charts will use hidden rows or columns.
* @property {sheets(v4).HistogramChartSpec} histogramChart A histogram chart specification.
* @property {boolean} maximized True to make a chart fill the entire space in which it's rendered with
minimum padding. False to use the default padding.
(Not applicable to Geo and Org charts.)
* @property {sheets(v4).OrgChartSpec} orgChart An org chart specification.
* @property {sheets(v4).PieChartSpec} pieChart A pie chart specification.
* @property {string} title The title of the chart.
* @property {sheets(v4).TextFormat} titleTextFormat The title text format.
Strikethrough and underline are not supported.
*/
/**
* @typedef ClearBasicFilterRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} sheetId The sheet ID on which the basic filter should be cleared.
*/
/**
* @typedef ClearValuesRequest
* @memberOf! sheets(v4)
* @type object
*/
/**
* @typedef ClearValuesResponse
* @memberOf! sheets(v4)
* @type object
* @property {string} clearedRange The range (in A1 notation) that was cleared.
(If the request was for an unbounded range or a ranger larger
than the bounds of the sheet, this will be the actual range
that was cleared, bounded to the sheet's limits.)
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
*/
/**
* @typedef Color
* @memberOf! sheets(v4)
* @type object
* @property {number} alpha The fraction of this color that should be applied to the pixel. That is,
the final pixel color is defined by the equation:
pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
This means that a value of 1.0 corresponds to a solid color, whereas
a value of 0.0 corresponds to a completely transparent color. This
uses a wrapper message rather than a simple float scalar so that it is
possible to distinguish between a default value and the value being unset.
If omitted, this color object is to be rendered as a solid color
(as if the alpha value had been explicitly given with a value of 1.0).
* @property {number} blue The amount of blue in the color as a value in the interval [0, 1].
* @property {number} green The amount of green in the color as a value in the interval [0, 1].
* @property {number} red The amount of red in the color as a value in the interval [0, 1].
*/
/**
* @typedef ConditionValue
* @memberOf! sheets(v4)
* @type object
* @property {string} relativeDate A relative date (based on the current date).
Valid only if the type is
DATE_BEFORE,
DATE_AFTER,
DATE_ON_OR_BEFORE or
DATE_ON_OR_AFTER.
Relative dates are not supported in data validation.
They are supported only in conditional formatting and
conditional filters.
* @property {string} userEnteredValue A value the condition is based on.
The value will be parsed as if the user typed into a cell.
Formulas are supported (and must begin with an `=`).
*/
/**
* @typedef ConditionalFormatRule
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BooleanRule} booleanRule The formatting is either "on" or "off" according to the rule.
* @property {sheets(v4).GradientRule} gradientRule The formatting will vary based on the gradients in the rule.
* @property {sheets(v4).GridRange[]} ranges The ranges that will be formatted if the condition is true.
All the ranges must be on the same grid.
*/
/**
* @typedef CopyPasteRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} destination The location to paste to. If the range covers a span that's
a multiple of the source's height or width, then the
data will be repeated to fill in the destination range.
If the range is smaller than the source range, the entire
source data will still be copied (beyond the end of the destination range).
* @property {string} pasteOrientation How that data should be oriented when pasting.
* @property {string} pasteType What kind of data to paste.
* @property {sheets(v4).GridRange} source The source range to copy.
*/
/**
* @typedef CopySheetToAnotherSpreadsheetRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} destinationSpreadsheetId The ID of the spreadsheet to copy the sheet to.
*/
/**
* @typedef CreateDeveloperMetadataRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadata} developerMetadata The developer metadata to create.
*/
/**
* @typedef CreateDeveloperMetadataResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadata} developerMetadata The developer metadata that was created.
*/
/**
* @typedef CutPasteRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridCoordinate} destination The top-left coordinate where the data should be pasted.
* @property {string} pasteType What kind of data to paste. All the source data will be cut, regardless
of what is pasted.
* @property {sheets(v4).GridRange} source The source data to cut.
*/
/**
* @typedef DataFilter
* @memberOf! sheets(v4)
* @type object
* @property {string} a1Range Selects data that matches the specified A1 range.
* @property {sheets(v4).DeveloperMetadataLookup} developerMetadataLookup Selects data associated with the developer metadata matching the criteria
described by this DeveloperMetadataLookup.
* @property {sheets(v4).GridRange} gridRange Selects data that matches the range described by the GridRange.
*/
/**
* @typedef DataFilterValueRange
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter} dataFilter The data filter describing the location of the values in the spreadsheet.
* @property {string} majorDimension The major dimension of the values.
* @property {array[]} values The data to be written. If the provided values exceed any of the ranges
matched by the data filter then the request will fail. If the provided
values are less than the matched ranges only the specified values will be
written, existing values in the matched ranges will remain unaffected.
*/
/**
* @typedef DataValidationRule
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BooleanCondition} condition The condition that data in the cell must match.
* @property {string} inputMessage A message to show the user when adding data to the cell.
* @property {boolean} showCustomUi True if the UI should be customized based on the kind of condition.
If true, "List" conditions will show a dropdown.
* @property {boolean} strict True if invalid data should be rejected.
*/
/**
* @typedef DeleteBandingRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} bandedRangeId The ID of the banded range to delete.
*/
/**
* @typedef DeleteConditionalFormatRuleRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} index The zero-based index of the rule to be deleted.
* @property {integer} sheetId The sheet the rule is being deleted from.
*/
/**
* @typedef DeleteConditionalFormatRuleResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ConditionalFormatRule} rule The rule that was deleted.
*/
/**
* @typedef DeleteDeveloperMetadataRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter} dataFilter The data filter describing the criteria used to select which developer
metadata entry to delete.
*/
/**
* @typedef DeleteDeveloperMetadataResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadata[]} deletedDeveloperMetadata The metadata that was deleted.
*/
/**
* @typedef DeleteDimensionRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DimensionRange} range The dimensions to delete from the sheet.
*/
/**
* @typedef DeleteEmbeddedObjectRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} objectId The ID of the embedded object to delete.
*/
/**
* @typedef DeleteFilterViewRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} filterId The ID of the filter to delete.
*/
/**
* @typedef DeleteNamedRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} namedRangeId The ID of the named range to delete.
*/
/**
* @typedef DeleteProtectedRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} protectedRangeId The ID of the protected range to delete.
*/
/**
* @typedef DeleteRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range of cells to delete.
* @property {string} shiftDimension The dimension from which deleted cells will be replaced with.
If ROWS, existing cells will be shifted upward to
replace the deleted cells. If COLUMNS, existing cells
will be shifted left to replace the deleted cells.
*/
/**
* @typedef DeleteSheetRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} sheetId The ID of the sheet to delete.
*/
/**
* @typedef DeveloperMetadata
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadataLocation} location The location where the metadata is associated.
* @property {integer} metadataId The spreadsheet-scoped unique ID that identifies the metadata. IDs may be
specified when metadata is created, otherwise one will be randomly
generated and assigned. Must be positive.
* @property {string} metadataKey The metadata key. There may be multiple metadata in a spreadsheet with the
same key. Developer metadata must always have a key specified.
* @property {string} metadataValue Data associated with the metadata's key.
* @property {string} visibility The metadata visibility. Developer metadata must always have a visibility
specified.
*/
/**
* @typedef DeveloperMetadataLocation
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DimensionRange} dimensionRange Represents the row or column when metadata is associated with
a dimension. The specified DimensionRange must represent a single row
or column; it cannot be unbounded or span multiple rows or columns.
* @property {string} locationType The type of location this object represents. This field is read-only.
* @property {integer} sheetId The ID of the sheet when metadata is associated with an entire sheet.
* @property {boolean} spreadsheet True when metadata is associated with an entire spreadsheet.
*/
/**
* @typedef DeveloperMetadataLookup
* @memberOf! sheets(v4)
* @type object
* @property {string} locationMatchingStrategy Determines how this lookup matches the location. If this field is
specified as EXACT, only developer metadata associated on the exact
location specified will be matched. If this field is specified to INTERSECTING,
developer metadata associated on intersecting locations will also be
matched. If left unspecified, this field will assume a default value of
INTERSECTING.
If this field is specified, a metadataLocation
must also be specified.
* @property {string} locationType Limits the selected developer metadata to those entries which are
associated with locations of the specified type. For example, specifying
this as ROW will only consider
developer metadata associated on rows. If left unspecified, all location
types will be considered. This field cannot be specified as
SPREADSHEET when the
locationMatchingStrategy is
specified as INTERSECTING or when the
metadataLocation is specified as a
non-spreadsheet location: spreadsheet metadata cannot intersect any other
developer metadata location. This field also must be left unspecified when the
locationMatchingStrategy is
specified as EXACT.
* @property {integer} metadataId Limits the selected developer metadata to that which has a matching
DeveloperMetadata.metadata_id.
* @property {string} metadataKey Limits the selected developer metadata to that which has a matching
DeveloperMetadata.metadata_key.
* @property {sheets(v4).DeveloperMetadataLocation} metadataLocation Limits the selected developer metadata to those entries associated with
the specified location. This field either matches exact locations or all
intersecting locations according the specified
locationMatchingStrategy.
* @property {string} metadataValue Limits the selected developer metadata to that which has a matching
DeveloperMetadata.metadata_value.
* @property {string} visibility Limits the selected developer metadata to that which has a matching
DeveloperMetadata.visibility. If left unspecified, all developer
metadata visibile to the requesting project will be considered.
*/
/**
* @typedef DimensionProperties
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadata[]} developerMetadata The developer metadata associated with a single row or column.
* @property {boolean} hiddenByFilter True if this dimension is being filtered.
This field is read-only.
* @property {boolean} hiddenByUser True if this dimension is explicitly hidden.
* @property {integer} pixelSize The height (if a row) or width (if a column) of the dimension in pixels.
*/
/**
* @typedef DimensionRange
* @memberOf! sheets(v4)
* @type object
* @property {string} dimension The dimension of the span.
* @property {integer} endIndex The end (exclusive) of the span, or not set if unbounded.
* @property {integer} sheetId The sheet this span is on.
* @property {integer} startIndex The start (inclusive) of the span, or not set if unbounded.
*/
/**
* @typedef DuplicateFilterViewRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} filterId The ID of the filter being duplicated.
*/
/**
* @typedef DuplicateFilterViewResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).FilterView} filter The newly created filter.
*/
/**
* @typedef DuplicateSheetRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} insertSheetIndex The zero-based index where the new sheet should be inserted.
The index of all sheets after this are incremented.
* @property {integer} newSheetId If set, the ID of the new sheet. If not set, an ID is chosen.
If set, the ID must not conflict with any existing sheet ID.
If set, it must be non-negative.
* @property {string} newSheetName The name of the new sheet. If empty, a new name is chosen for you.
* @property {integer} sourceSheetId The sheet to duplicate.
*/
/**
* @typedef DuplicateSheetResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).SheetProperties} properties The properties of the duplicate sheet.
*/
/**
* @typedef Editors
* @memberOf! sheets(v4)
* @type object
* @property {boolean} domainUsersCanEdit True if anyone in the document's domain has edit access to the protected
range. Domain protection is only supported on documents within a domain.
* @property {string[]} groups The email addresses of groups with edit access to the protected range.
* @property {string[]} users The email addresses of users with edit access to the protected range.
*/
/**
* @typedef EmbeddedChart
* @memberOf! sheets(v4)
* @type object
* @property {integer} chartId The ID of the chart.
* @property {sheets(v4).EmbeddedObjectPosition} position The position of the chart.
* @property {sheets(v4).ChartSpec} spec The specification of the chart.
*/
/**
* @typedef EmbeddedObjectPosition
* @memberOf! sheets(v4)
* @type object
* @property {boolean} newSheet If true, the embedded object will be put on a new sheet whose ID
is chosen for you. Used only when writing.
* @property {sheets(v4).OverlayPosition} overlayPosition The position at which the object is overlaid on top of a grid.
* @property {integer} sheetId The sheet this is on. Set only if the embedded object
is on its own sheet. Must be non-negative.
*/
/**
* @typedef ErrorValue
* @memberOf! sheets(v4)
* @type object
* @property {string} message A message with more information about the error
(in the spreadsheet's locale).
* @property {string} type The type of error.
*/
/**
* @typedef ExtendedValue
* @memberOf! sheets(v4)
* @type object
* @property {boolean} boolValue Represents a boolean value.
* @property {sheets(v4).ErrorValue} errorValue Represents an error.
This field is read-only.
* @property {string} formulaValue Represents a formula.
* @property {number} numberValue Represents a double value.
Note: Dates, Times and DateTimes are represented as doubles in
"serial number" format.
* @property {string} stringValue Represents a string value.
Leading single quotes are not included. For example, if the user typed
`'123` into the UI, this would be represented as a `stringValue` of
`"123"`.
*/
/**
* @typedef FilterCriteria
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BooleanCondition} condition A condition that must be true for values to be shown.
(This does not override hiddenValues -- if a value is listed there,
it will still be hidden.)
* @property {string[]} hiddenValues Values that should be hidden.
*/
/**
* @typedef FilterView
* @memberOf! sheets(v4)
* @type object
* @property {object} criteria The criteria for showing/hiding values per column.
The map's key is the column index, and the value is the criteria for
that column.
* @property {integer} filterViewId The ID of the filter view.
* @property {string} namedRangeId The named range this filter view is backed by, if any.
When writing, only one of range or named_range_id
may be set.
* @property {sheets(v4).GridRange} range The range this filter view covers.
When writing, only one of range or named_range_id
may be set.
* @property {sheets(v4).SortSpec[]} sortSpecs The sort order per column. Later specifications are used when values
are equal in the earlier specifications.
* @property {string} title The name of the filter view.
*/
/**
* @typedef FindReplaceRequest
* @memberOf! sheets(v4)
* @type object
* @property {boolean} allSheets True to find/replace over all sheets.
* @property {string} find The value to search.
* @property {boolean} includeFormulas True if the search should include cells with formulas.
False to skip cells with formulas.
* @property {boolean} matchCase True if the search is case sensitive.
* @property {boolean} matchEntireCell True if the find value should match the entire cell.
* @property {sheets(v4).GridRange} range The range to find/replace over.
* @property {string} replacement The value to use as the replacement.
* @property {boolean} searchByRegex True if the find value is a regex.
The regular expression and replacement should follow Java regex rules
at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
The replacement string is allowed to refer to capturing groups.
For example, if one cell has the contents `"Google Sheets"` and another
has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of
`"$1 Rocks"` would change the contents of the cells to
`"GSheets Rocks"` and `"GDocs Rocks"` respectively.
* @property {integer} sheetId The sheet to find/replace over.
*/
/**
* @typedef FindReplaceResponse
* @memberOf! sheets(v4)
* @type object
* @property {integer} formulasChanged The number of formula cells changed.
* @property {integer} occurrencesChanged The number of occurrences (possibly multiple within a cell) changed.
For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would
be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.
* @property {integer} rowsChanged The number of rows changed.
* @property {integer} sheetsChanged The number of sheets changed.
* @property {integer} valuesChanged The number of non-formula cells changed.
*/
/**
* @typedef GetSpreadsheetByDataFilterRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters The DataFilters used to select which ranges to retrieve from
the spreadsheet.
* @property {boolean} includeGridData True if grid data should be returned.
This parameter is ignored if a field mask was set in the request.
*/
/**
* @typedef GradientRule
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).InterpolationPoint} maxpoint The final interpolation point.
* @property {sheets(v4).InterpolationPoint} midpoint An optional midway interpolation point.
* @property {sheets(v4).InterpolationPoint} minpoint The starting interpolation point.
*/
/**
* @typedef GridCoordinate
* @memberOf! sheets(v4)
* @type object
* @property {integer} columnIndex The column index of the coordinate.
* @property {integer} rowIndex The row index of the coordinate.
* @property {integer} sheetId The sheet this coordinate is on.
*/
/**
* @typedef GridData
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DimensionProperties[]} columnMetadata Metadata about the requested columns in the grid, starting with the column
in start_column.
* @property {sheets(v4).RowData[]} rowData The data in the grid, one entry per row,
starting with the row in startRow.
The values in RowData will correspond to columns starting
at start_column.
* @property {sheets(v4).DimensionProperties[]} rowMetadata Metadata about the requested rows in the grid, starting with the row
in start_row.
* @property {integer} startColumn The first column this GridData refers to, zero-based.
* @property {integer} startRow The first row this GridData refers to, zero-based.
*/
/**
* @typedef GridProperties
* @memberOf! sheets(v4)
* @type object
* @property {integer} columnCount The number of columns in the grid.
* @property {integer} frozenColumnCount The number of columns that are frozen in the grid.
* @property {integer} frozenRowCount The number of rows that are frozen in the grid.
* @property {boolean} hideGridlines True if the grid isn't showing gridlines in the UI.
* @property {integer} rowCount The number of rows in the grid.
*/
/**
* @typedef GridRange
* @memberOf! sheets(v4)
* @type object
* @property {integer} endColumnIndex The end column (exclusive) of the range, or not set if unbounded.
* @property {integer} endRowIndex The end row (exclusive) of the range, or not set if unbounded.
* @property {integer} sheetId The sheet this range is on.
* @property {integer} startColumnIndex The start column (inclusive) of the range, or not set if unbounded.
* @property {integer} startRowIndex The start row (inclusive) of the range, or not set if unbounded.
*/
/**
* @typedef HistogramChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {number} bucketSize By default the bucket size (the range of values stacked in a single
column) is chosen automatically, but it may be overridden here.
E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.
Cannot be negative.
This field is optional.
* @property {string} legendPosition The position of the chart legend.
* @property {number} outlierPercentile The outlier percentile is used to ensure that outliers do not adversely
affect the calculation of bucket sizes. For example, setting an outlier
percentile of 0.05 indicates that the top and bottom 5% of values when
calculating buckets. The values are still included in the chart, they will
be added to the first or last buckets instead of their own buckets.
Must be between 0.0 and 0.5.
* @property {sheets(v4).HistogramSeries[]} series The series for a histogram may be either a single series of values to be
bucketed or multiple series, each of the same length, containing the name
of the series followed by the values to be bucketed for that series.
* @property {boolean} showItemDividers Whether horizontal divider lines should be displayed between items in each
column.
*/
/**
* @typedef HistogramSeries
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Color} barColor The color of the column representing this series in each bucket.
This field is optional.
* @property {sheets(v4).ChartData} data The data for this histogram series.
*/
/**
* @typedef InsertDimensionRequest
* @memberOf! sheets(v4)
* @type object
* @property {boolean} inheritFromBefore Whether dimension properties should be extended from the dimensions
before or after the newly inserted dimensions.
True to inherit from the dimensions before (in which case the start
index must be greater than 0), and false to inherit from the dimensions
after.
For example, if row index 0 has red background and row index 1
has a green background, then inserting 2 rows at index 1 can inherit
either the green or red background. If `inheritFromBefore` is true,
the two new rows will be red (because the row before the insertion point
was red), whereas if `inheritFromBefore` is false, the two new rows will
be green (because the row after the insertion point was green).
* @property {sheets(v4).DimensionRange} range The dimensions to insert. Both the start and end indexes must be bounded.
*/
/**
* @typedef InsertRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range to insert new cells into.
* @property {string} shiftDimension The dimension which will be shifted when inserting cells.
If ROWS, existing cells will be shifted down.
If COLUMNS, existing cells will be shifted right.
*/
/**
* @typedef InterpolationPoint
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Color} color The color this interpolation point should use.
* @property {string} type How the value should be interpreted.
* @property {string} value The value this interpolation point uses. May be a formula.
Unused if type is MIN or
MAX.
*/
/**
* @typedef IterativeCalculationSettings
* @memberOf! sheets(v4)
* @type object
* @property {number} convergenceThreshold When iterative calculation is enabled and successive results differ by
less than this threshold value, the calculation rounds stop.
* @property {integer} maxIterations When iterative calculation is enabled, the maximum number of calculation
rounds to perform.
*/
/**
* @typedef MatchedDeveloperMetadata
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters All filters matching the returned developer metadata.
* @property {sheets(v4).DeveloperMetadata} developerMetadata The developer metadata matching the specified filters.
*/
/**
* @typedef MatchedValueRange
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters The DataFilters from the request that matched the range of
values.
* @property {sheets(v4).ValueRange} valueRange The values matched by the DataFilter.
*/
/**
* @typedef MergeCellsRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} mergeType How the cells should be merged.
* @property {sheets(v4).GridRange} range The range of cells to merge.
*/
/**
* @typedef MoveDimensionRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} destinationIndex The zero-based start index of where to move the source data to,
based on the coordinates *before* the source data is removed
from the grid. Existing data will be shifted down or right
(depending on the dimension) to make room for the moved dimensions.
The source dimensions are removed from the grid, so the
the data may end up in a different index than specified.
For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move
`"1"` and `"2"` to between `"3"` and `"4"`, the source would be
`ROWS [1..3)`,and the destination index would be `"4"`
(the zero-based index of row 5).
The end result would be `A1..A5` of `0, 3, 1, 2, 4`.
* @property {sheets(v4).DimensionRange} source The source dimensions to move.
*/
/**
* @typedef NamedRange
* @memberOf! sheets(v4)
* @type object
* @property {string} name The name of the named range.
* @property {string} namedRangeId The ID of the named range.
* @property {sheets(v4).GridRange} range The range this represents.
*/
/**
* @typedef NumberFormat
* @memberOf! sheets(v4)
* @type object
* @property {string} pattern Pattern string used for formatting. If not set, a default pattern based on
the user's locale will be used if necessary for the given type.
See the [Date and Number Formats guide](/sheets/api/guides/formats) for more
information about the supported patterns.
* @property {string} type The type of the number format.
When writing, this field must be set.
*/
/**
* @typedef OrgChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartData} labels The data containing the labels for all the nodes in the chart. Labels
must be unique.
* @property {sheets(v4).Color} nodeColor The color of the org chart nodes.
* @property {string} nodeSize The size of the org chart nodes.
* @property {sheets(v4).ChartData} parentLabels The data containing the label of the parent for the corresponding node.
A blank value indicates that the node has no parent and is a top-level
node.
This field is optional.
* @property {sheets(v4).Color} selectedNodeColor The color of the selected org chart nodes.
* @property {sheets(v4).ChartData} tooltips The data containing the tooltip for the corresponding node. A blank value
results in no tooltip being displayed for the node.
This field is optional.
*/
/**
* @typedef OverlayPosition
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridCoordinate} anchorCell The cell the object is anchored to.
* @property {integer} heightPixels The height of the object, in pixels. Defaults to 371.
* @property {integer} offsetXPixels The horizontal offset, in pixels, that the object is offset
from the anchor cell.
* @property {integer} offsetYPixels The vertical offset, in pixels, that the object is offset
from the anchor cell.
* @property {integer} widthPixels The width of the object, in pixels. Defaults to 600.
*/
/**
* @typedef Padding
* @memberOf! sheets(v4)
* @type object
* @property {integer} bottom The bottom padding of the cell.
* @property {integer} left The left padding of the cell.
* @property {integer} right The right padding of the cell.
* @property {integer} top The top padding of the cell.
*/
/**
* @typedef PasteDataRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridCoordinate} coordinate The coordinate at which the data should start being inserted.
* @property {string} data The data to insert.
* @property {string} delimiter The delimiter in the data.
* @property {boolean} html True if the data is HTML.
* @property {string} type How the data should be pasted.
*/
/**
* @typedef PieChartSpec
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ChartData} domain The data that covers the domain of the pie chart.
* @property {string} legendPosition Where the legend of the pie chart should be drawn.
* @property {number} pieHole The size of the hole in the pie chart.
* @property {sheets(v4).ChartData} series The data that covers the one and only series of the pie chart.
* @property {boolean} threeDimensional True if the pie is three dimensional.
*/
/**
* @typedef PivotFilterCriteria
* @memberOf! sheets(v4)
* @type object
* @property {string[]} visibleValues Values that should be included. Values not listed here are excluded.
*/
/**
* @typedef PivotGroup
* @memberOf! sheets(v4)
* @type object
* @property {boolean} showTotals True if the pivot table should include the totals for this grouping.
* @property {string} sortOrder The order the values in this group should be sorted.
* @property {integer} sourceColumnOffset The column offset of the source range that this grouping is based on.
For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
means this group refers to column `C`, whereas the offset `1` would refer
to column `D`.
* @property {sheets(v4).PivotGroupSortValueBucket} valueBucket The bucket of the opposite pivot group to sort by.
If not specified, sorting is alphabetical by this group's values.
* @property {sheets(v4).PivotGroupValueMetadata[]} valueMetadata Metadata about values in the grouping.
*/
/**
* @typedef PivotGroupSortValueBucket
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).ExtendedValue[]} buckets Determines the bucket from which values are chosen to sort.
For example, in a pivot table with one row group & two column groups,
the row group can list up to two values. The first value corresponds
to a value within the first column group, and the second value
corresponds to a value in the second column group. If no values
are listed, this would indicate that the row should be sorted according
to the "Grand Total" over the column groups. If a single value is listed,
this would correspond to using the "Total" of that bucket.
* @property {integer} valuesIndex The offset in the PivotTable.values list which the values in this
grouping should be sorted by.
*/
/**
* @typedef PivotGroupValueMetadata
* @memberOf! sheets(v4)
* @type object
* @property {boolean} collapsed True if the data corresponding to the value is collapsed.
* @property {sheets(v4).ExtendedValue} value The calculated value the metadata corresponds to.
(Note that formulaValue is not valid,
because the values will be calculated.)
*/
/**
* @typedef PivotTable
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).PivotGroup[]} columns Each column grouping in the pivot table.
* @property {object} criteria An optional mapping of filters per source column offset.
The filters will be applied before aggregating data into the pivot table.
The map's key is the column offset of the source range that you want to
filter, and the value is the criteria for that column.
For example, if the source was `C10:E15`, a key of `0` will have the filter
for column `C`, whereas the key `1` is for column `D`.
* @property {sheets(v4).PivotGroup[]} rows Each row grouping in the pivot table.
* @property {sheets(v4).GridRange} source The range the pivot table is reading data from.
* @property {string} valueLayout Whether values should be listed horizontally (as columns)
or vertically (as rows).
* @property {sheets(v4).PivotValue[]} values A list of values to include in the pivot table.
*/
/**
* @typedef PivotValue
* @memberOf! sheets(v4)
* @type object
* @property {string} formula A custom formula to calculate the value. The formula must start
with an `=` character.
* @property {string} name A name to use for the value. This is only used if formula was set.
Otherwise, the column name is used.
* @property {integer} sourceColumnOffset The column offset of the source range that this value reads from.
For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
means this value refers to column `C`, whereas the offset `1` would
refer to column `D`.
* @property {string} summarizeFunction A function to summarize the value.
If formula is set, the only supported values are
SUM and
CUSTOM.
If sourceColumnOffset is set, then `CUSTOM`
is not supported.
*/
/**
* @typedef ProtectedRange
* @memberOf! sheets(v4)
* @type object
* @property {string} description The description of this protected range.
* @property {sheets(v4).Editors} editors The users and groups with edit access to the protected range.
This field is only visible to users with edit access to the protected
range and the document.
Editors are not supported with warning_only protection.
* @property {string} namedRangeId The named range this protected range is backed by, if any.
When writing, only one of range or named_range_id
may be set.
* @property {integer} protectedRangeId The ID of the protected range.
This field is read-only.
* @property {sheets(v4).GridRange} range The range that is being protected.
The range may be fully unbounded, in which case this is considered
a protected sheet.
When writing, only one of range or named_range_id
may be set.
* @property {boolean} requestingUserCanEdit True if the user who requested this protected range can edit the
protected area.
This field is read-only.
* @property {sheets(v4).GridRange[]} unprotectedRanges The list of unprotected ranges within a protected sheet.
Unprotected ranges are only supported on protected sheets.
* @property {boolean} warningOnly True if this protected range will show a warning when editing.
Warning-based protection means that every user can edit data in the
protected range, except editing will prompt a warning asking the user
to confirm the edit.
When writing: if this field is true, then editors is ignored.
Additionally, if this field is changed from true to false and the
`editors` field is not set (nor included in the field mask), then
the editors will be set to all the editors in the document.
*/
/**
* @typedef RandomizeRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range to randomize.
*/
/**
* @typedef RepeatCellRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).CellData} cell The data to write.
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `cell` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).GridRange} range The range to repeat the cell in.
*/
/**
* @typedef Request
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).AddBandingRequest} addBanding Adds a new banded range
* @property {sheets(v4).AddChartRequest} addChart Adds a chart.
* @property {sheets(v4).AddConditionalFormatRuleRequest} addConditionalFormatRule Adds a new conditional format rule.
* @property {sheets(v4).AddFilterViewRequest} addFilterView Adds a filter view.
* @property {sheets(v4).AddNamedRangeRequest} addNamedRange Adds a named range.
* @property {sheets(v4).AddProtectedRangeRequest} addProtectedRange Adds a protected range.
* @property {sheets(v4).AddSheetRequest} addSheet Adds a sheet.
* @property {sheets(v4).AppendCellsRequest} appendCells Appends cells after the last row with data in a sheet.
* @property {sheets(v4).AppendDimensionRequest} appendDimension Appends dimensions to the end of a sheet.
* @property {sheets(v4).AutoFillRequest} autoFill Automatically fills in more data based on existing data.
* @property {sheets(v4).AutoResizeDimensionsRequest} autoResizeDimensions Automatically resizes one or more dimensions based on the contents
of the cells in that dimension.
* @property {sheets(v4).ClearBasicFilterRequest} clearBasicFilter Clears the basic filter on a sheet.
* @property {sheets(v4).CopyPasteRequest} copyPaste Copies data from one area and pastes it to another.
* @property {sheets(v4).CreateDeveloperMetadataRequest} createDeveloperMetadata Creates new developer metadata
* @property {sheets(v4).CutPasteRequest} cutPaste Cuts data from one area and pastes it to another.
* @property {sheets(v4).DeleteBandingRequest} deleteBanding Removes a banded range
* @property {sheets(v4).DeleteConditionalFormatRuleRequest} deleteConditionalFormatRule Deletes an existing conditional format rule.
* @property {sheets(v4).DeleteDeveloperMetadataRequest} deleteDeveloperMetadata Deletes developer metadata
* @property {sheets(v4).DeleteDimensionRequest} deleteDimension Deletes rows or columns in a sheet.
* @property {sheets(v4).DeleteEmbeddedObjectRequest} deleteEmbeddedObject Deletes an embedded object (e.g, chart, image) in a sheet.
* @property {sheets(v4).DeleteFilterViewRequest} deleteFilterView Deletes a filter view from a sheet.
* @property {sheets(v4).DeleteNamedRangeRequest} deleteNamedRange Deletes a named range.
* @property {sheets(v4).DeleteProtectedRangeRequest} deleteProtectedRange Deletes a protected range.
* @property {sheets(v4).DeleteRangeRequest} deleteRange Deletes a range of cells from a sheet, shifting the remaining cells.
* @property {sheets(v4).DeleteSheetRequest} deleteSheet Deletes a sheet.
* @property {sheets(v4).DuplicateFilterViewRequest} duplicateFilterView Duplicates a filter view.
* @property {sheets(v4).DuplicateSheetRequest} duplicateSheet Duplicates a sheet.
* @property {sheets(v4).FindReplaceRequest} findReplace Finds and replaces occurrences of some text with other text.
* @property {sheets(v4).InsertDimensionRequest} insertDimension Inserts new rows or columns in a sheet.
* @property {sheets(v4).InsertRangeRequest} insertRange Inserts new cells in a sheet, shifting the existing cells.
* @property {sheets(v4).MergeCellsRequest} mergeCells Merges cells together.
* @property {sheets(v4).MoveDimensionRequest} moveDimension Moves rows or columns to another location in a sheet.
* @property {sheets(v4).PasteDataRequest} pasteData Pastes data (HTML or delimited) into a sheet.
* @property {sheets(v4).RandomizeRangeRequest} randomizeRange Randomizes the order of the rows in a range.
* @property {sheets(v4).RepeatCellRequest} repeatCell Repeats a single cell across a range.
* @property {sheets(v4).SetBasicFilterRequest} setBasicFilter Sets the basic filter on a sheet.
* @property {sheets(v4).SetDataValidationRequest} setDataValidation Sets data validation for one or more cells.
* @property {sheets(v4).SortRangeRequest} sortRange Sorts data in a range.
* @property {sheets(v4).TextToColumnsRequest} textToColumns Converts a column of text into many columns of text.
* @property {sheets(v4).UnmergeCellsRequest} unmergeCells Unmerges merged cells.
* @property {sheets(v4).UpdateBandingRequest} updateBanding Updates a banded range
* @property {sheets(v4).UpdateBordersRequest} updateBorders Updates the borders in a range of cells.
* @property {sheets(v4).UpdateCellsRequest} updateCells Updates many cells at once.
* @property {sheets(v4).UpdateChartSpecRequest} updateChartSpec Updates a chart's specifications.
* @property {sheets(v4).UpdateConditionalFormatRuleRequest} updateConditionalFormatRule Updates an existing conditional format rule.
* @property {sheets(v4).UpdateDeveloperMetadataRequest} updateDeveloperMetadata Updates an existing developer metadata entry
* @property {sheets(v4).UpdateDimensionPropertiesRequest} updateDimensionProperties Updates dimensions' properties.
* @property {sheets(v4).UpdateEmbeddedObjectPositionRequest} updateEmbeddedObjectPosition Updates an embedded object's (e.g. chart, image) position.
* @property {sheets(v4).UpdateFilterViewRequest} updateFilterView Updates the properties of a filter view.
* @property {sheets(v4).UpdateNamedRangeRequest} updateNamedRange Updates a named range.
* @property {sheets(v4).UpdateProtectedRangeRequest} updateProtectedRange Updates a protected range.
* @property {sheets(v4).UpdateSheetPropertiesRequest} updateSheetProperties Updates a sheet's properties.
* @property {sheets(v4).UpdateSpreadsheetPropertiesRequest} updateSpreadsheetProperties Updates the spreadsheet's properties.
*/
/**
* @typedef Response
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).AddBandingResponse} addBanding A reply from adding a banded range.
* @property {sheets(v4).AddChartResponse} addChart A reply from adding a chart.
* @property {sheets(v4).AddFilterViewResponse} addFilterView A reply from adding a filter view.
* @property {sheets(v4).AddNamedRangeResponse} addNamedRange A reply from adding a named range.
* @property {sheets(v4).AddProtectedRangeResponse} addProtectedRange A reply from adding a protected range.
* @property {sheets(v4).AddSheetResponse} addSheet A reply from adding a sheet.
* @property {sheets(v4).CreateDeveloperMetadataResponse} createDeveloperMetadata A reply from creating a developer metadata entry.
* @property {sheets(v4).DeleteConditionalFormatRuleResponse} deleteConditionalFormatRule A reply from deleting a conditional format rule.
* @property {sheets(v4).DeleteDeveloperMetadataResponse} deleteDeveloperMetadata A reply from deleting a developer metadata entry.
* @property {sheets(v4).DuplicateFilterViewResponse} duplicateFilterView A reply from duplicating a filter view.
* @property {sheets(v4).DuplicateSheetResponse} duplicateSheet A reply from duplicating a sheet.
* @property {sheets(v4).FindReplaceResponse} findReplace A reply from doing a find/replace.
* @property {sheets(v4).UpdateConditionalFormatRuleResponse} updateConditionalFormatRule A reply from updating a conditional format rule.
* @property {sheets(v4).UpdateDeveloperMetadataResponse} updateDeveloperMetadata A reply from updating a developer metadata entry.
* @property {sheets(v4).UpdateEmbeddedObjectPositionResponse} updateEmbeddedObjectPosition A reply from updating an embedded object's position.
*/
/**
* @typedef RowData
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).CellData[]} values The values in the row, one per column.
*/
/**
* @typedef SearchDeveloperMetadataRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters The data filters describing the criteria used to determine which
DeveloperMetadata entries to return. DeveloperMetadata matching any of the
specified filters will be included in the response.
*/
/**
* @typedef SearchDeveloperMetadataResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).MatchedDeveloperMetadata[]} matchedDeveloperMetadata The metadata matching the criteria of the search request.
*/
/**
* @typedef SetBasicFilterRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BasicFilter} filter The filter to set.
*/
/**
* @typedef SetDataValidationRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range the data validation rule should apply to.
* @property {sheets(v4).DataValidationRule} rule The data validation rule to set on each cell in the range,
or empty to clear the data validation in the range.
*/
/**
* @typedef Sheet
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BandedRange[]} bandedRanges The banded (i.e. alternating colors) ranges on this sheet.
* @property {sheets(v4).BasicFilter} basicFilter The filter on this sheet, if any.
* @property {sheets(v4).EmbeddedChart[]} charts The specifications of every chart on this sheet.
* @property {sheets(v4).ConditionalFormatRule[]} conditionalFormats The conditional format rules in this sheet.
* @property {sheets(v4).GridData[]} data Data in the grid, if this is a grid sheet.
The number of GridData objects returned is dependent on the number of
ranges requested on this sheet. For example, if this is representing
`Sheet1`, and the spreadsheet was requested with ranges
`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a
startRow/startColumn of `0`,
while the second one will have `startRow 14` (zero-based row 15),
and `startColumn 3` (zero-based column D).
* @property {sheets(v4).DeveloperMetadata[]} developerMetadata The developer metadata associated with a sheet.
* @property {sheets(v4).FilterView[]} filterViews The filter views in this sheet.
* @property {sheets(v4).GridRange[]} merges The ranges that are merged together.
* @property {sheets(v4).SheetProperties} properties The properties of the sheet.
* @property {sheets(v4).ProtectedRange[]} protectedRanges The protected ranges in this sheet.
*/
/**
* @typedef SheetProperties
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridProperties} gridProperties Additional properties of the sheet if this sheet is a grid.
(If the sheet is an object sheet, containing a chart or image, then
this field will be absent.)
When writing it is an error to set any grid properties on non-grid sheets.
* @property {boolean} hidden True if the sheet is hidden in the UI, false if it's visible.
* @property {integer} index The index of the sheet within the spreadsheet.
When adding or updating sheet properties, if this field
is excluded then the sheet will be added or moved to the end
of the sheet list. When updating sheet indices or inserting
sheets, movement is considered in "before the move" indexes.
For example, if there were 3 sheets (S1, S2, S3) in order to
move S1 ahead of S2 the index would have to be set to 2. A sheet
index update request will be ignored if the requested index is
identical to the sheets current index or if the requested new
index is equal to the current sheet index + 1.
* @property {boolean} rightToLeft True if the sheet is an RTL sheet instead of an LTR sheet.
* @property {integer} sheetId The ID of the sheet. Must be non-negative.
This field cannot be changed once set.
* @property {string} sheetType The type of sheet. Defaults to GRID.
This field cannot be changed once set.
* @property {sheets(v4).Color} tabColor The color of the tab in the UI.
* @property {string} title The name of the sheet.
*/
/**
* @typedef SortRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range to sort.
* @property {sheets(v4).SortSpec[]} sortSpecs The sort order per column. Later specifications are used when values
are equal in the earlier specifications.
*/
/**
* @typedef SortSpec
* @memberOf! sheets(v4)
* @type object
* @property {integer} dimensionIndex The dimension the sort should be applied to.
* @property {string} sortOrder The order data should be sorted.
*/
/**
* @typedef SourceAndDestination
* @memberOf! sheets(v4)
* @type object
* @property {string} dimension The dimension that data should be filled into.
* @property {integer} fillLength The number of rows or columns that data should be filled into.
Positive numbers expand beyond the last row or last column
of the source. Negative numbers expand before the first row
or first column of the source.
* @property {sheets(v4).GridRange} source The location of the data to use as the source of the autofill.
*/
/**
* @typedef Spreadsheet
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadata[]} developerMetadata The developer metadata associated with a spreadsheet.
* @property {sheets(v4).NamedRange[]} namedRanges The named ranges defined in a spreadsheet.
* @property {sheets(v4).SpreadsheetProperties} properties Overall properties of a spreadsheet.
* @property {sheets(v4).Sheet[]} sheets The sheets that are part of a spreadsheet.
* @property {string} spreadsheetId The ID of the spreadsheet.
This field is read-only.
* @property {string} spreadsheetUrl The url of the spreadsheet.
This field is read-only.
*/
/**
* @typedef SpreadsheetProperties
* @memberOf! sheets(v4)
* @type object
* @property {string} autoRecalc The amount of time to wait before volatile functions are recalculated.
* @property {sheets(v4).CellFormat} defaultFormat The default format of all cells in the spreadsheet.
CellData.effectiveFormat will not be set if the
cell's format is equal to this default format.
This field is read-only.
* @property {sheets(v4).IterativeCalculationSettings} iterativeCalculationSettings Determines whether and how circular references are resolved with iterative
calculation. Absence of this field means that circular references will
result in calculation errors.
* @property {string} locale The locale of the spreadsheet in one of the following formats:
* an ISO 639-1 language code such as `en`
* an ISO 639-2 language code such as `fil`, if no 639-1 code exists
* a combination of the ISO language code and country code, such as `en_US`
Note: when updating this field, not all locales/languages are supported.
* @property {string} timeZone The time zone of the spreadsheet, in CLDR format such as
`America/New_York`. If the time zone isn't recognized, this may
be a custom time zone such as `GMT-07:00`.
* @property {string} title The title of the spreadsheet.
*/
/**
* @typedef TextFormat
* @memberOf! sheets(v4)
* @type object
* @property {boolean} bold True if the text is bold.
* @property {string} fontFamily The font family.
* @property {integer} fontSize The size of the font.
* @property {sheets(v4).Color} foregroundColor The foreground color of the text.
* @property {boolean} italic True if the text is italicized.
* @property {boolean} strikethrough True if the text has a strikethrough.
* @property {boolean} underline True if the text is underlined.
*/
/**
* @typedef TextFormatRun
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).TextFormat} format The format of this run. Absent values inherit the cell's format.
* @property {integer} startIndex The character index where this run starts.
*/
/**
* @typedef TextRotation
* @memberOf! sheets(v4)
* @type object
* @property {integer} angle The angle between the standard orientation and the desired orientation.
Measured in degrees. Valid values are between -90 and 90. Positive
angles are angled upwards, negative are angled downwards.
Note: For LTR text direction positive angles are in the counterclockwise
direction, whereas for RTL they are in the clockwise direction
* @property {boolean} vertical If true, text reads top to bottom, but the orientation of individual
characters is unchanged.
For example:
| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |
*/
/**
* @typedef TextToColumnsRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} delimiter The delimiter to use. Used only if delimiterType is
CUSTOM.
* @property {string} delimiterType The delimiter type to use.
* @property {sheets(v4).GridRange} source The source data range. This must span exactly one column.
*/
/**
* @typedef UnmergeCellsRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).GridRange} range The range within which all cells should be unmerged.
If the range spans multiple merges, all will be unmerged.
The range must not partially span any merge.
*/
/**
* @typedef UpdateBandingRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).BandedRange} bandedRange The banded range to update with the new properties.
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `bandedRange` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
*/
/**
* @typedef UpdateBordersRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).Border} bottom The border to put at the bottom of the range.
* @property {sheets(v4).Border} innerHorizontal The horizontal border to put within the range.
* @property {sheets(v4).Border} innerVertical The vertical border to put within the range.
* @property {sheets(v4).Border} left The border to put at the left of the range.
* @property {sheets(v4).GridRange} range The range whose borders should be updated.
* @property {sheets(v4).Border} right The border to put at the right of the range.
* @property {sheets(v4).Border} top The border to put at the top of the range.
*/
/**
* @typedef UpdateCellsRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields of CellData that should be updated.
At least one field must be specified.
The root is the CellData; 'row.values.' should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).GridRange} range The range to write data to.
If the data in rows does not cover the entire requested range,
the fields matching those set in fields will be cleared.
* @property {sheets(v4).RowData[]} rows The data to write.
* @property {sheets(v4).GridCoordinate} start The coordinate to start writing data at.
Any number of rows and columns (including a different number of
columns per row) may be written.
*/
/**
* @typedef UpdateChartSpecRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} chartId The ID of the chart to update.
* @property {sheets(v4).ChartSpec} spec The specification to apply to the chart.
*/
/**
* @typedef UpdateConditionalFormatRuleRequest
* @memberOf! sheets(v4)
* @type object
* @property {integer} index The zero-based index of the rule that should be replaced or moved.
* @property {integer} newIndex The zero-based new index the rule should end up at.
* @property {sheets(v4).ConditionalFormatRule} rule The rule that should replace the rule at the given index.
* @property {integer} sheetId The sheet of the rule to move. Required if new_index is set,
unused otherwise.
*/
/**
* @typedef UpdateConditionalFormatRuleResponse
* @memberOf! sheets(v4)
* @type object
* @property {integer} newIndex The index of the new rule.
* @property {sheets(v4).ConditionalFormatRule} newRule The new rule that replaced the old rule (if replacing),
or the rule that was moved (if moved)
* @property {integer} oldIndex The old index of the rule. Not set if a rule was replaced
(because it is the same as new_index).
* @property {sheets(v4).ConditionalFormatRule} oldRule The old (deleted) rule. Not set if a rule was moved
(because it is the same as new_rule).
*/
/**
* @typedef UpdateDeveloperMetadataRequest
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter[]} dataFilters The filters matching the developer metadata entries to update.
* @property {sheets(v4).DeveloperMetadata} developerMetadata The value that all metadata matched by the data filters will be updated to.
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `developerMetadata` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
*/
/**
* @typedef UpdateDeveloperMetadataResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DeveloperMetadata[]} developerMetadata The updated developer metadata.
*/
/**
* @typedef UpdateDimensionPropertiesRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `properties` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).DimensionProperties} properties Properties to update.
* @property {sheets(v4).DimensionRange} range The rows or columns to update.
*/
/**
* @typedef UpdateEmbeddedObjectPositionRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields of OverlayPosition
that should be updated when setting a new position. Used only if
newPosition.overlayPosition
is set, in which case at least one field must
be specified. The root `newPosition.overlayPosition` is implied and
should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).EmbeddedObjectPosition} newPosition An explicit position to move the embedded object to.
If newPosition.sheetId is set,
a new sheet with that ID will be created.
If newPosition.newSheet is set to true,
a new sheet will be created with an ID that will be chosen for you.
* @property {integer} objectId The ID of the object to moved.
*/
/**
* @typedef UpdateEmbeddedObjectPositionResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).EmbeddedObjectPosition} position The new position of the embedded object.
*/
/**
* @typedef UpdateFilterViewRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `filter` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).FilterView} filter The new properties of the filter view.
*/
/**
* @typedef UpdateNamedRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `namedRange` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).NamedRange} namedRange The named range to update with the new properties.
*/
/**
* @typedef UpdateProtectedRangeRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `protectedRange` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).ProtectedRange} protectedRange The protected range to update with the new properties.
*/
/**
* @typedef UpdateSheetPropertiesRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root `properties` is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).SheetProperties} properties The properties to update.
*/
/**
* @typedef UpdateSpreadsheetPropertiesRequest
* @memberOf! sheets(v4)
* @type object
* @property {string} fields The fields that should be updated. At least one field must be specified.
The root 'properties' is implied and should not be specified.
A single `"*"` can be used as short-hand for listing every field.
* @property {sheets(v4).SpreadsheetProperties} properties The properties to update.
*/
/**
* @typedef UpdateValuesByDataFilterResponse
* @memberOf! sheets(v4)
* @type object
* @property {sheets(v4).DataFilter} dataFilter The data filter that selected the range that was updated.
* @property {integer} updatedCells The number of cells updated.
* @property {integer} updatedColumns The number of columns where at least one cell in the column was updated.
* @property {sheets(v4).ValueRange} updatedData The values of the cells in the range matched by the dataFilter after all
updates were applied. This is only included if the request's
`includeValuesInResponse` field was `true`.
* @property {string} updatedRange The range (in A1 notation) that updates were applied to.
* @property {integer} updatedRows The number of rows where at least one cell in the row was updated.
*/
/**
* @typedef UpdateValuesResponse
* @memberOf! sheets(v4)
* @type object
* @property {string} spreadsheetId The spreadsheet the updates were applied to.
* @property {integer} updatedCells The number of cells updated.
* @property {integer} updatedColumns The number of columns where at least one cell in the column was updated.
* @property {sheets(v4).ValueRange} updatedData The values of the cells after updates were applied.
This is only included if the request's `includeValuesInResponse` field
was `true`.
* @property {string} updatedRange The range (in A1 notation) that updates were applied to.
* @property {integer} updatedRows The number of rows where at least one cell in the row was updated.
*/
/**
* @typedef ValueRange
* @memberOf! sheets(v4)
* @type object
* @property {string} majorDimension The major dimension of the values.
For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
then requesting `range=A1:B2,majorDimension=ROWS` will return
`[[1,2],[3,4]]`,
whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`.
For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
When writing, if this field is not set, it defaults to ROWS.
* @property {string} range The range the values cover, in A1 notation.
For output, this range indicates the entire requested range,
even though the values will exclude trailing rows and columns.
When appending values, this field represents the range to search for a
table, after which values will be appended.
* @property {array[]} values The data that was read or to be written. This is an array of arrays,
the outer array representing all the data and each inner array
representing a major dimension. Each item in the inner array
corresponds with one cell.
For output, empty trailing rows and columns will not be included.
For input, supported value types are: bool, string, and double.
Null values will be skipped.
To set a cell to an empty value, set the string value to an empty string.
*/
export = Sheets;
Reference in New Issue View Git Blame Copy Permalink