Googlesheetsconnector v1

Version 1

Connector Overview: This page documents all 17 actions for the Googlesheetsconnector v1.

View API Documentation

DeveloperMetadata (2)

GET GetV4SpreadsheetsDeveloperMetadata

/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to retrieve metadata from.

Metadataid

The ID of the developer metadata to retrieve.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

POST SearchV4SpreadsheetsDeveloperMetadataSearch

/v4/spreadsheets/{spreadsheetId}/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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to retrieve metadata from.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Sheets

POST CopyToV4SpreadsheetsSheetsCopyTo

/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet containing the sheet to copy.

Sheetid

The ID of the sheet to copy.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (1)

Option Name

Description

Destinationspreadsheetid

The ID of the spreadsheet to copy the sheet to.

Spreadsheets (4)

POST BatchUpdateV4SpreadsheetsBatchUpdateBySpreadsheetId

/v4/spreadsheets/{spreadsheetId}: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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The spreadsheet to apply the updates to.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (3)

Option Name

Description

Includespreadsheetinresponse

Determines if the update response should include the spreadsheet resource.

Responseranges

Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.

Responseincludegriddata

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.

POST CreateV4Spreadsheets

/v4/spreadsheets

Creates a spreadsheet, returning the newly created spreadsheet.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (2)

Option Name

Description

Spreadsheetid

The ID of the spreadsheet. This field is read-only.

Spreadsheeturl

The url of the spreadsheet. This field is read-only.

POST GetByDataFilterV4SpreadsheetsGetByDataFilter

/v4/spreadsheets/{spreadsheetId}: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 returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 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, as a best practice, retrieve only the specific spreadsheet fields that you want.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The spreadsheet to request.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (1)

Option Name

Description

Includegriddata

True if grid data should be returned. This parameter is ignored if a field mask was set in the request.

GET GetV4SpreadsheetsBySpreadsheetId

/v4/spreadsheets/{spreadsheetId}

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 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, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using A1 notation. You can define a single cell (for example, A1) or multiple cells (for example, A1:D5). You can also get cells from other sheets within the same spreadsheet (for example, Sheet2!A1:C4) or retrieve multiple ranges at once (for example, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The spreadsheet to request.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Ranges

The ranges to retrieve from the spreadsheet.

Includegriddata

True if grid data should be returned. This parameter is ignored if a field mask was set in the request.

Response Type

N/A

Values (10)

POST AppendV4SpreadsheetsValuesAppend

/v4/spreadsheets/{spreadsheetId}/values/{range}: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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Range

The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Valueinputoption

How the input data should be interpreted. (Acceptable values are: "INPUT_VALUE_OPTION_UNSPECIFIED", "RAW", "USER_ENTERED")

Insertdataoption

How the input data should be inserted. (Acceptable values are: "OVERWRITE", "INSERT_ROWS")

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.

Responsevaluerenderoption

Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. (Acceptable values are: "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA")

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 SERIAL_NUMBER. (Acceptable values are: "SERIAL_NUMBER", "FORMATTED_STRING")

Response Type

N/A

Options (3)

Option Name

Description

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.

Majordimension

N/A

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.

POST BatchClearByDataFilterV4SpreadsheetsValuesBatchClearByDataFilter

/v4/spreadsheets/{spreadsheetId}/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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

POST BatchClearV4SpreadsheetsValuesBatchClear

/v4/spreadsheets/{spreadsheetId}/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 and data validation) are kept.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (1)

Option Name

Description

Ranges

The ranges to clear, in A1 notation or R1C1 notation.

POST BatchGetByDataFilterV4SpreadsheetsValuesBatchGetByDataFilter

/v4/spreadsheets/{spreadsheetId}/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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to retrieve data from.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (3)

Option Name

Description

Majordimension

N/A

Valuerenderoption

N/A

Datetimerenderoption

N/A

GET BatchGetV4SpreadsheetsValuesBatchGet

/v4/spreadsheets/{spreadsheetId}/values:batchGet

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to retrieve data from.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Ranges

The A1 notation or R1C1 notation of the range to retrieve values from.

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 ranges=["A1:B2"],majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting ranges=["A1:B2"],majorDimension=COLUMNS returns [[1,3],[2,4]]. (Acceptable values are: "DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS")

Valuerenderoption

How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. (Acceptable values are: "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA")

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 SERIAL_NUMBER. (Acceptable values are: "SERIAL_NUMBER", "FORMATTED_STRING")

Response Type

N/A

POST BatchUpdateByDataFilterV4SpreadsheetsValuesBatchUpdateByDataFilter

/v4/spreadsheets/{spreadsheetId}/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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (4)

Option Name

Description

Valueinputoption

N/A

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

Responsevaluerenderoption

N/A

Responsedatetimerenderoption

N/A

POST BatchUpdateV4SpreadsheetsValuesBatchUpdate

/v4/spreadsheets/{spreadsheetId}/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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (4)

Option Name

Description

Valueinputoption

N/A

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

Responsevaluerenderoption

N/A

Responsedatetimerenderoption

N/A

POST ClearV4SpreadsheetsValuesClearBySpreadsheetId

/v4/spreadsheets/{spreadsheetId}/values/{range}: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.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Range

The A1 notation or R1C1 notation of the values to clear.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Response Type

N/A

Options (1)

Option Name

Description

Options

N/A

GET GetV4SpreadsheetsValuesBySpreadsheetId

/v4/spreadsheets/{spreadsheetId}/values/{range}

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to retrieve data from.

Range

The A1 notation or R1C1 notation of the range to retrieve values from.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Majordimension

The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: A1=1,B1=2,A2=3,B2=4, then requesting range=Sheet1!A1:B2?majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting range=Sheet1!A1:B2?majorDimension=COLUMNS returns [[1,3],[2,4]]. (Acceptable values are: "DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS")

Valuerenderoption

How values should be represented in the output. The default render option is FORMATTED_VALUE. (Acceptable values are: "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA")

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 SERIAL_NUMBER. (Acceptable values are: "SERIAL_NUMBER", "FORMATTED_STRING")

Response Type

N/A

PUT UpdateV4SpreadsheetsValuesBySpreadsheetId

/v4/spreadsheets/{spreadsheetId}/values/{range}

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Spreadsheetid

The ID of the spreadsheet to update.

Range

The A1 notation of the values to update.

Access Token

OAuth access token.

Alt

Data format for response. (Acceptable values are: "json", "media", "proto")

Callback

JSONP

Fields

Selector specifying which fields to include in a partial response.

Key

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

OAuth 2.0 token for the current user.

Prettyprint

Returns response with indentations and line breaks.

Quotauser

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

Upload protocol for media (e.g. "raw", "multipart").

Uploadtype

Legacy upload protocol for media (e.g. "media", "multipart").

$.xgafv

V1 error format. (Acceptable values are: "1", "2")

Valueinputoption

How the input data should be interpreted. (Acceptable values are: "INPUT_VALUE_OPTION_UNSPECIFIED", "RAW", "USER_ENTERED")

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 the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).

Responsevaluerenderoption

Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. (Acceptable values are: "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA")

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 SERIAL_NUMBER. (Acceptable values are: "SERIAL_NUMBER", "FORMATTED_STRING")

Response Type

N/A

Options (3)

Option Name

Description

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.

Majordimension

N/A

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.