6.0.0 • Published 5 years ago

@datafire/google_sheets v6.0.0

Weekly downloads
13
License
MIT
Repository
github
Last release
5 years ago

@datafire/google_sheets

Client library for Google Sheets API

Installation and Usage

npm install --save @datafire/google_sheets
let google_sheets = require('@datafire/google_sheets').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Reads and writes Google Sheets.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_sheets.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_sheets.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

sheets.spreadsheets.create

Creates a spreadsheet, returning the newly created spreadsheet.

google_sheets.sheets.spreadsheets.create({}, context)

Input

  • input object
    • body Spreadsheet
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.get

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.

google_sheets.sheets.spreadsheets.get({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The spreadsheet to request.
    • includeGridData boolean: True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
    • ranges array: The ranges to retrieve from the spreadsheet.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.developerMetadata.get

Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.

google_sheets.sheets.spreadsheets.developerMetadata.get({
  "spreadsheetId": "",
  "metadataId": 0
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to retrieve metadata from.
    • metadataId required integer: The ID of the developer metadata to retrieve.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.developerMetadata.search

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.

google_sheets.sheets.spreadsheets.developerMetadata.search({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to retrieve metadata from.
    • body SearchDeveloperMetadataRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.sheets.copyTo

Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.

google_sheets.sheets.spreadsheets.sheets.copyTo({
  "spreadsheetId": "",
  "sheetId": 0
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet containing the sheet to copy.
    • sheetId required integer: The ID of the sheet to copy.
    • body CopySheetToAnotherSpreadsheetRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.get

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

google_sheets.sheets.spreadsheets.values.get({
  "spreadsheetId": "",
  "range": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to retrieve data from.
    • range required string: The A1 notation of the values to retrieve.
    • dateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • majorDimension string (values: DIMENSION_UNSPECIFIED, ROWS, COLUMNS): 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 returns [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS returns [[1,3],[2,4]].
    • valueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.update

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.

google_sheets.sheets.spreadsheets.values.update({
  "spreadsheetId": "",
  "range": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • range required string: The A1 notation of the values to update.
    • includeValuesInResponse boolean: 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 the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
    • responseDateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • responseValueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
    • valueInputOption string (values: INPUT_VALUE_OPTION_UNSPECIFIED, RAW, USER_ENTERED): How the input data should be interpreted.
    • body ValueRange
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.append

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 and sample code 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.

google_sheets.sheets.spreadsheets.values.append({
  "spreadsheetId": "",
  "range": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • range required string: The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
    • includeValuesInResponse boolean: Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
    • insertDataOption string (values: OVERWRITE, INSERT_ROWS): How the input data should be inserted.
    • responseDateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • responseValueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
    • valueInputOption string (values: INPUT_VALUE_OPTION_UNSPECIFIED, RAW, USER_ENTERED): How the input data should be interpreted.
    • body ValueRange
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.clear

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.

google_sheets.sheets.spreadsheets.values.clear({
  "spreadsheetId": "",
  "range": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • range required string: The A1 notation of the values to clear.
    • body ClearValuesRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.batchClear

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.

google_sheets.sheets.spreadsheets.values.batchClear({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • body BatchClearValuesRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.batchClearByDataFilter

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.

google_sheets.sheets.spreadsheets.values.batchClearByDataFilter({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • body BatchClearValuesByDataFilterRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.batchGet

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

google_sheets.sheets.spreadsheets.values.batchGet({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to retrieve data from.
    • dateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • majorDimension string (values: DIMENSION_UNSPECIFIED, ROWS, COLUMNS): 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 returns [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS returns [[1,3],[2,4]].
    • ranges array: The A1 notation of the values to retrieve.
    • valueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.batchGetByDataFilter

Returns one or more ranges of values 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.

google_sheets.sheets.spreadsheets.values.batchGetByDataFilter({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to retrieve data from.
    • body BatchGetValuesByDataFilterRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.batchUpdate

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.

google_sheets.sheets.spreadsheets.values.batchUpdate({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • body BatchUpdateValuesRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.values.batchUpdateByDataFilter

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.

google_sheets.sheets.spreadsheets.values.batchUpdateByDataFilter({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The ID of the spreadsheet to update.
    • body BatchUpdateValuesByDataFilterRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.batchUpdate

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.

google_sheets.sheets.spreadsheets.batchUpdate({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The spreadsheet to apply the updates to.
    • body BatchUpdateSpreadsheetRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

sheets.spreadsheets.getByDataFilter

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.

google_sheets.sheets.spreadsheets.getByDataFilter({
  "spreadsheetId": ""
}, context)

Input

  • input object
    • spreadsheetId required string: The spreadsheet to request.
    • body GetSpreadsheetByDataFilterRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Definitions

AddBandingRequest

  • AddBandingRequest object: Adds a new banded range to the spreadsheet.

AddBandingResponse

  • AddBandingResponse object: The result of adding a banded range.

AddChartRequest

  • AddChartRequest object: Adds a chart to a sheet in the spreadsheet.

AddChartResponse

  • AddChartResponse object: The result of adding a chart to a spreadsheet.

AddConditionalFormatRuleRequest

  • AddConditionalFormatRuleRequest object: Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.

AddDataSourceRequest

  • AddDataSourceRequest object: Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional bigquery.readonly OAuth scope.

AddDataSourceResponse

AddDimensionGroupRequest

  • AddDimensionGroupRequest object: Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group C:D, depth 1 + B:E results in groups B:E, depth 1 and C:D, depth 2. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group B:E, depth 1 + C:D results in groups B:E, depth 1 and C:D, depth 2. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group B:D, depth 1 + C:E results in groups B:E, depth 1 and C:D, depth 2.

AddDimensionGroupResponse

  • AddDimensionGroupResponse object: The result of adding a group.
    • dimensionGroups array: All groups of a dimension after adding a group to that dimension.

AddFilterViewRequest

  • AddFilterViewRequest object: Adds a filter view.

AddFilterViewResponse

  • AddFilterViewResponse object: The result of adding a filter view.

AddNamedRangeRequest

  • AddNamedRangeRequest object: Adds a named range to the spreadsheet.

AddNamedRangeResponse

  • AddNamedRangeResponse object: The result of adding a named range.

AddProtectedRangeRequest

  • AddProtectedRangeRequest object: Adds a new protected range.

AddProtectedRangeResponse

  • AddProtectedRangeResponse object: The result of adding a new protected range.

AddSheetRequest

  • AddSheetRequest object: Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.

AddSheetResponse

  • AddSheetResponse object: The result of adding a sheet.

AddSlicerRequest

  • AddSlicerRequest object: Adds a slicer to a sheet in the spreadsheet.

AddSlicerResponse

  • AddSlicerResponse object: The result of adding a slicer to a spreadsheet.

AppendCellsRequest

  • AppendCellsRequest object: Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.
    • fields string: 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.
    • rows array: The data to append.
    • sheetId integer: The sheet ID to append the data to.

AppendDimensionRequest

  • AppendDimensionRequest object: Appends rows or columns to the end of a sheet.
    • dimension string (values: DIMENSION_UNSPECIFIED, ROWS, COLUMNS): Whether rows or columns should be appended.
    • length integer: The number of rows or columns to append.
    • sheetId integer: The sheet to append rows or columns to.

AppendValuesResponse

  • AppendValuesResponse object: The response when updating a range of values in a spreadsheet.
    • spreadsheetId string: The spreadsheet the updates were applied to.
    • tableRange string: 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.
    • updates UpdateValuesResponse

AutoFillRequest

  • AutoFillRequest object: Fills in more data based on existing data.
    • range GridRange
    • sourceAndDestination SourceAndDestination
    • useAlternateSeries boolean: True if we should generate data with the "alternate" series. This differs based on the type and amount of source data.

AutoResizeDimensionsRequest

BandedRange

BandingProperties

  • BandingProperties object: Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: header_color and footer_color take priority over band colors. first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.

BaselineValueFormat

  • BaselineValueFormat object: Formatting options for baseline value.
    • comparisonType string (values: COMPARISON_TYPE_UNDEFINED, ABSOLUTE_DIFFERENCE, PERCENTAGE_DIFFERENCE): The comparison type of key value with baseline value.
    • description string: Description which is appended after the baseline value. This field is optional.
    • negativeColor Color
    • negativeColorStyle ColorStyle
    • position TextPosition
    • positiveColor Color
    • positiveColorStyle ColorStyle
    • textFormat TextFormat

BasicChartAxis

  • BasicChartAxis object: An axis of the chart. A chart may not have more than one axis per axis position.
    • format TextFormat
    • position string (values: BASIC_CHART_AXIS_POSITION_UNSPECIFIED, BOTTOM_AXIS, LEFT_AXIS, RIGHT_AXIS): The position of this axis.
    • title string: The title of this axis. If set, this overrides any title inferred from headers of the data.
    • titleTextPosition TextPosition
    • viewWindowOptions ChartAxisViewWindowOptions

BasicChartDomain

  • BasicChartDomain object: The domain of a chart. For example, if charting stock prices over time, this would be the date.
    • domain ChartData
    • reversed boolean: True to reverse the order of the domain values (horizontal axis).

BasicChartSeries

  • BasicChartSeries object: A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price".
    • color Color
    • colorStyle ColorStyle
    • dataLabel DataLabel
    • lineStyle LineStyle
    • pointStyle PointStyle
    • series ChartData
    • styleOverrides array: Style override settings for series data points.
    • targetAxis string (values: BASIC_CHART_AXIS_POSITION_UNSPECIFIED, BOTTOM_AXIS, LEFT_AXIS, RIGHT_AXIS): 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.
    • type string (values: BASIC_CHART_TYPE_UNSPECIFIED, BAR, LINE, AREA, COLUMN, SCATTER, COMBO, STEPPED_AREA): 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.

BasicChartSpec

  • BasicChartSpec object: The specification for a basic chart. See BasicChartType for the list of charts this supports.
    • axis array: The axis on the chart.
    • chartType string (values: BASIC_CHART_TYPE_UNSPECIFIED, BAR, LINE, AREA, COLUMN, SCATTER, COMBO, STEPPED_AREA): The type of the chart.
    • compareMode string (values: BASIC_CHART_COMPARE_MODE_UNSPECIFIED, DATUM, CATEGORY): The behavior of tooltips and data highlighting when hovering on data and chart area.
    • domains array: The domain of data this is charting. Only a single domain is supported.
    • headerCount integer: 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.)
    • interpolateNulls boolean: 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.
    • legendPosition string (values: BASIC_CHART_LEGEND_POSITION_UNSPECIFIED, BOTTOM_LEGEND, LEFT_LEGEND, RIGHT_LEGEND, TOP_LEGEND, NO_LEGEND): The position of the chart legend.
    • lineSmoothing boolean: Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.
    • series array: The data this chart is visualizing.
    • stackedType string (values: BASIC_CHART_STACKED_TYPE_UNSPECIFIED, NOT_STACKED, STACKED, PERCENT_STACKED): The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.
    • threeDimensional boolean: True to make the chart 3D. Applies to Bar and Column charts.
    • totalDataLabel DataLabel

BasicFilter

  • BasicFilter object: The default filter associated with a sheet.
    • criteria object: 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. This field is deprecated in favor of filter_specs.
    • filterSpecs array: The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
    • range GridRange
    • sortSpecs array: The sort order per column. Later specifications are used when values are equal in the earlier specifications.

BasicSeriesDataPointStyleOverride

  • BasicSeriesDataPointStyleOverride object: Style override settings for a single series data point.

BatchClearValuesByDataFilterRequest

  • BatchClearValuesByDataFilterRequest object: The request for clearing more than one range selected by a DataFilter in a spreadsheet.
    • dataFilters array: The DataFilters used to determine which ranges to clear.

BatchClearValuesByDataFilterResponse

  • BatchClearValuesByDataFilterResponse object: The response when clearing a range of values selected with DataFilters in a spreadsheet.
    • clearedRanges array: The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.
      • items string
    • spreadsheetId string: The spreadsheet the updates were applied to.

BatchClearValuesRequest

  • BatchClearValuesRequest object: The request for clearing more than one range of values in a spreadsheet.
    • ranges array: The ranges to clear, in A1 notation.
      • items string

BatchClearValuesResponse

  • BatchClearValuesResponse object: The response when clearing a range of values in a spreadsheet.
    • clearedRanges array: The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.
      • items string
    • spreadsheetId string: The spreadsheet the updates were applied to.

BatchGetValuesByDataFilterRequest

  • BatchGetValuesByDataFilterRequest object: The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
    • dataFilters array: The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.
    • dateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • majorDimension string (values: DIMENSION_UNSPECIFIED, ROWS, COLUMNS): 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 returns [[1,2],[3,4]], whereas a request that sets majorDimension=COLUMNS returns [[1,3],[2,4]].
    • valueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

BatchGetValuesByDataFilterResponse

  • BatchGetValuesByDataFilterResponse object: The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.
    • spreadsheetId string: The ID of the spreadsheet the data was retrieved from.
    • valueRanges array: The requested values with the list of data filters that matched them.

BatchGetValuesResponse

  • BatchGetValuesResponse object: The response when retrieving more than one range of values in a spreadsheet.
    • spreadsheetId string: The ID of the spreadsheet the data was retrieved from.
    • valueRanges array: The requested values. The order of the ValueRanges is the same as the order of the requested ranges.

BatchUpdateSpreadsheetRequest

  • BatchUpdateSpreadsheetRequest object: The request for updating any aspect of a spreadsheet.
    • includeSpreadsheetInResponse boolean: Determines if the update response should include the spreadsheet resource.
    • requests array: 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.
    • responseIncludeGridData boolean: True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.
    • responseRanges array: Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.
      • items string

BatchUpdateSpreadsheetResponse

  • BatchUpdateSpreadsheetResponse object: The reply for batch updating a spreadsheet.
    • replies array: The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.
    • spreadsheetId string: The spreadsheet the updates were applied to.
    • updatedSpreadsheet Spreadsheet

BatchUpdateValuesByDataFilterRequest

  • BatchUpdateValuesByDataFilterRequest object: The request for updating more than one range of values in a spreadsheet.
    • data array: The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.
    • includeValuesInResponse boolean: 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 contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
    • responseDateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • responseValueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
    • valueInputOption string (values: INPUT_VALUE_OPTION_UNSPECIFIED, RAW, USER_ENTERED): How the input data should be interpreted.

BatchUpdateValuesByDataFilterResponse

  • BatchUpdateValuesByDataFilterResponse object: The response when updating a range of values in a spreadsheet.
    • responses array: The response for each range updated.
    • spreadsheetId string: The spreadsheet the updates were applied to.
    • totalUpdatedCells integer: The total number of cells updated.
    • totalUpdatedColumns integer: The total number of columns where at least one cell in the column was updated.
    • totalUpdatedRows integer: The total number of rows where at least one cell in the row was updated.
    • totalUpdatedSheets integer: The total number of sheets where at least one cell in the sheet was updated.

BatchUpdateValuesRequest

  • BatchUpdateValuesRequest object: The request for updating more than one range of values in a spreadsheet.
    • data array: The new values to apply to the spreadsheet.
    • includeValuesInResponse boolean: 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 contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).
    • responseDateTimeRenderOption string (values: SERIAL_NUMBER, FORMATTED_STRING): 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.
    • responseValueRenderOption string (values: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA): Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
    • valueInputOption string (values: INPUT_VALUE_OPTION_UNSPECIFIED, RAW, USER_ENTERED): How the input data should be interpreted.

BatchUpdateValuesResponse

  • BatchUpdateValuesResponse object: The response when updating a range of values in a spreadsheet.
    • responses array: One UpdateValuesResponse per requested range, in the same order as the requests appeared.
    • spreadsheetId string: The spreadsheet the updates were applied to.
    • totalUpdatedCells integer: The total number of cells updated.
    • totalUpdatedColumns integer: The total number of columns where at least one cell in the column was updated.
    • totalUpdatedRows integer: The total number of rows where at least one cell in the row was updated.
    • totalUpdatedSheets integer: The total number of sheets where at least one cell in the sheet was updated.

BigQueryDataSourceSpec

  • BigQueryDataSourceSpec object: The specification of a BigQuery data source that's connected to a sheet.
    • projectId string: The ID of a BigQuery enabled GCP project with a billing account attached. For any queries executed against the data source, the project is charged.
    • querySpec BigQueryQuerySpec
    • tableSpec BigQueryTableSpec

BigQueryQuerySpec

  • BigQueryQuerySpec object: Specifies a custom BigQuery query.
    • rawQuery string: The raw query string.

BigQueryTableSpec

  • BigQueryTableSpec object: Specifies a BigQuery table definition. Only native tables is allowed.
    • datasetId string: The BigQuery dataset id.
    • tableId string: The BigQuery table id.
    • tableProjectId string: The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed.

BooleanCondition

  • BooleanCondition object: A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.
    • type string (values: CONDITION_TYPE_UNSPECIFIED, NUMBER_GREATER, NUMBER_GREATER_THAN_EQ, NUMBER_LESS, NUMBER_LESS_THAN_EQ, NUMBER_EQ, NUMBER_NOT_EQ, NUMBER_BETWEEN, NUMBER_NOT_BETWEEN, TEXT_CONTAINS, TEXT_NOT_CONTAINS, TEXT_STARTS_WITH, TEXT_ENDS_WITH, TEXT_EQ, TEXT_IS_EMAIL, TEXT_IS_URL, DATE_EQ, DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE, DATE_ON_OR_AFTER, DATE_BETWEEN, DATE_NOT_BETWEEN, DATE_IS_VALID, ONE_OF_RANGE, ONE_OF_LIST, BLANK, NOT_BLANK, CUSTOM_FORMULA, BOOLEAN, TEXT_NOT_EQ, DATE_NOT_EQ): The type of condition.
    • values array: 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.

BooleanRule

Border

  • Border object: A border along a cell.
    • color Color
    • colorStyle ColorStyle
    • style string (values: STYLE_UNSPECIFIED, DOTTED, DASHED, SOLID, SOLID_MEDIUM, SOLID_THICK, NONE, DOUBLE): The style of the border.
    • width integer: The width of the border, in pixels. Deprecated; the width is determined by the "style" field.

Borders

BubbleChartSpec

  • BubbleChartSpec object: A bubble chart.
    • bubbleBorderColor Color
    • bubbleBorderColorStyle ColorStyle
    • bubbleLabels ChartData
    • bubbleMaxRadiusSize integer: The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.
    • bubbleMinRadiusSize integer: The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.
    • bubbleOpacity number: The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
    • bubbleSizes ChartData
    • bubbleTextStyle TextFormat
    • domain ChartData
    • groupIds ChartData
    • legendPosition string (values: BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED, BOTTOM_LEGEND, LEFT_LEGEND, RIGHT_LEGEND, TOP_LEGEND, NO_LEGEND, INSIDE_LEGEND): Where the legend of the chart should be drawn.
    • series ChartData

CandlestickChartSpec

  • CandlestickChartSpec object: A candlestick chart.

CandlestickData

CandlestickDomain

  • CandlestickDomain object: The domain of a CandlestickChart.
    • data ChartData
    • reversed boolean: True to reverse the order of the domain values (horizontal axis).

CandlestickSeries

  • CandlestickSeries object: The series of a CandlestickData.

CellData

  • CellData object: Data about a specific cell.
    • dataSourceFormula DataSourceFormula
    • dataSourceTable DataSourceTable
    • dataValidation DataValidationRule
    • effectiveFormat CellFormat
    • effectiveValue ExtendedValue
    • formattedValue string: The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.
    • hyperlink string: A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a =HYPERLINK formula in the userEnteredValue.formulaValue field.
    • note string: Any note on the cell.
    • pivotTable PivotTable
    • textFormatRuns array: Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit 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 are erased.
    • userEnteredFormat CellFormat
    • userEnteredValue ExtendedValue

CellFormat

  • CellFormat object: The format of a cell.
    • backgroundColor Color
    • backgroundColorStyle ColorStyle
    • borders Borders
    • horizontalAlignment string (values: HORIZONTAL_ALIGN_UNSPECIFIED, LEFT, CENTER, RIGHT): The horizontal alignment of the value in the cell.
    • hyperlinkDisplayType string (values: HYPERLINK_DISPLAY_TYPE_UNSPECIFIED, LINKED, PLAIN_TEXT): How a hyperlink, if it exists, should be displayed in the cell.
    • numberFormat NumberFormat
    • padding Padding
    • textDirection string (values: TEXT_DIRECTION_UNSPECIFIED, LEFT_TO_RIGHT, RIGHT_TO_LEFT): The direction of the text in the cell.
    • textFormat TextFormat
    • textRotation TextRotation
    • verticalAlignment string (values: VERTICAL_ALIGN_UNSPECIFIED, TOP, MIDDLE, BOTTOM): The vertical alignment of the value in the cell.
    • wrapStrategy string (values: WRAP_STRATEGY_UNSPECIFIED, OVERFLOW_CELL, LEGACY_WRAP, CLIP, WRAP): The wrap strategy for the value in the cell.

ChartAxisViewWindowOptions

  • ChartAxisViewWindowOptions object: The options that define a "view window" for a chart (such as the visible values in an axis).
    • viewWindowMax number: The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.
    • viewWindowMin number: The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.
    • viewWindowMode string (values: DEFAULT_VIEW_WINDOW_MODE, VIEW_WINDOW_MODE_UNSUPPORTED, EXPLICIT, PRETTY): The view window's mode.

ChartCustomNumberFormatOptions

  • ChartCustomNumberFormatOptions object: Custom number formatting options for chart attributes.
    • prefix string: Custom prefix to be prepended to the chart attribute. This field is optional.
    • suffix string: Custom suffix to be appended to the chart attribute. This field is optional.

ChartData

  • ChartData object: The data included in a domain or series.
    • aggregateType string (values: CHART_AGGREGATE_TYPE_UNSPECIFIED, AVERAGE, COUNT, MAX, MEDIAN, MIN, SUM): The aggregation type for the series of a data source chart. Not supported for regular charts.
    • columnReference DataSourceColumnReference
    • groupRule ChartGroupRule
    • sourceRange ChartSourceRange

ChartDateTimeRule

  • ChartDateTimeRule object: Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.
    • type string (values: CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED, SECOND, MINUTE, HOUR, HOUR_MINUTE, HOUR_MINUTE_AMPM, DAY_OF_WEEK, DAY_OF_YEAR, DAY_OF_MONTH, DAY_MONTH, MONTH, QUARTER, YEAR, YEAR_MONTH, YEAR_QUARTER, YEAR_MONTH_DAY): The type of date-time grouping to apply.

ChartGroupRule

  • ChartGroupRule object: An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.
datafire
@infinitebrahmanuniverse/nolb-_datafire_g@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_g
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago