google_api_sheets v0.0.1 GoogleApi.Sheets.V4.Api.Spreadsheets View Source
API calls for all endpoints tagged Spreadsheets
.
Link to this section Summary
Functions
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
Creates a spreadsheet, returning the newly created spreadsheet
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
Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet
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
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
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges
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
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range
Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption
Link to this section Functions
sheets_spreadsheets_batch_update(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.BatchUpdateSpreadsheetResponse.t} | {:error, Tesla.Env.t}
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
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The spreadsheet to apply the updates to.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :body (BatchUpdateSpreadsheetRequest):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.BatchUpdateSpreadsheetResponse{}} on success {:error, info} on failure
sheets_spreadsheets_create(Tesla.Env.client, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.Spreadsheet.t} | {:error, Tesla.Env.t}
Creates a spreadsheet, returning the newly created spreadsheet.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :body (Spreadsheet):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.Spreadsheet{}} on success {:error, info} on failure
sheets_spreadsheets_get(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.Spreadsheet.t} | {:error, Tesla.Env.t}
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.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The spreadsheet to request.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :include_grid_data (Boolean): True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
- :ranges (List[String]): The ranges to retrieve from the spreadsheet.
Returns
{:ok, %GoogleApi.Sheets.V4.Model.Spreadsheet{}} on success {:error, info} on failure
sheets_spreadsheets_sheets_copy_to(Tesla.Env.client, String.t, Integer.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.SheetProperties.t} | {:error, Tesla.Env.t}
Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet containing the sheet to copy.
- sheet_id (Integer): The ID of the sheet to copy.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :body (CopySheetToAnotherSpreadsheetRequest):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.SheetProperties{}} on success {:error, info} on failure
sheets_spreadsheets_values_append(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.AppendValuesResponse.t} | {:error, Tesla.Env.t}
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
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to update.
- range (String): The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :response_value_render_option (String): Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
- :insert_data_option (String): How the input data should be inserted.
- :value_input_option (String): How the input data should be interpreted.
- :response_date_time_render_option (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].
- :include_values_in_response (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.
- :body (ValueRange):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.AppendValuesResponse{}} on success {:error, info} on failure
sheets_spreadsheets_values_batch_clear(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.BatchClearValuesResponse.t} | {:error, Tesla.Env.t}
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.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to update.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :body (BatchClearValuesRequest):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.BatchClearValuesResponse{}} on success {:error, info} on failure
sheets_spreadsheets_values_batch_get(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.BatchGetValuesResponse.t} | {:error, Tesla.Env.t}
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to retrieve data from.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :date_time_render_option (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].
- :value_render_option (String): How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
- :major_dimension (String): The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
- :ranges (List[String]): The A1 notation of the values to retrieve.
Returns
{:ok, %GoogleApi.Sheets.V4.Model.BatchGetValuesResponse{}} on success {:error, info} on failure
sheets_spreadsheets_values_batch_update(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.BatchUpdateValuesResponse.t} | {:error, Tesla.Env.t}
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
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to update.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :body (BatchUpdateValuesRequest):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.BatchUpdateValuesResponse{}} on success {:error, info} on failure
sheets_spreadsheets_values_clear(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.ClearValuesResponse.t} | {:error, Tesla.Env.t}
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
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to update.
- range (String): The A1 notation of the values to clear.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :body (ClearValuesRequest):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.ClearValuesResponse{}} on success {:error, info} on failure
sheets_spreadsheets_values_get(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.ValueRange.t} | {:error, Tesla.Env.t}
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to retrieve data from.
- range (String): The A1 notation of the values to retrieve.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :major_dimension (String): The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
- :date_time_render_option (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].
- :value_render_option (String): How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
Returns
{:ok, %GoogleApi.Sheets.V4.Model.ValueRange{}} on success {:error, info} on failure
sheets_spreadsheets_values_update(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.Sheets.V4.Model.UpdateValuesResponse.t} | {:error, Tesla.Env.t}
Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
Parameters
- connection (GoogleApi.Sheets.V4.Connection): Connection to server
- spreadsheet_id (String): The ID of the spreadsheet to update.
- range (String): The A1 notation of the values to update.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :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.
- :quota_user (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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :response_value_render_option (String): Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
- :value_input_option (String): How the input data should be interpreted.
- :response_date_time_render_option (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].
- :include_values_in_response (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 than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).
- :body (ValueRange):
Returns
{:ok, %GoogleApi.Sheets.V4.Model.UpdateValuesResponse{}} on success {:error, info} on failure