View Source GoogleApi.Sheets.V4.Api.Spreadsheets (google_api_sheets v0.31.0)

API calls for all endpoints tagged Spreadsheets.

Summary

Functions

sheets_spreadsheets_batch_update(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_create(connection, optional_params \\ [], opts \\ [])

Creates a spreadsheet, returning the newly created spreadsheet.

sheets_spreadsheets_developer_metadata_get(connection, spreadsheet_id, metadata_id, optional_params \\ [], opts \\ [])

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

sheets_spreadsheets_developer_metadata_search(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_get(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_get_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_sheets_copy_to(connection, spreadsheet_id, sheet_id, optional_params \\ [], opts \\ [])

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

sheets_spreadsheets_values_append(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_values_batch_clear(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_values_batch_clear_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_values_batch_get(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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

sheets_spreadsheets_values_batch_get_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_values_batch_update(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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

sheets_spreadsheets_values_batch_update_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

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

sheets_spreadsheets_values_clear(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

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.

sheets_spreadsheets_values_get(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

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

sheets_spreadsheets_values_update(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

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

Functions

Link to this function

sheets_spreadsheets_batch_update(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchUpdateSpreadsheetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The spreadsheet to apply the updates to.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.BatchUpdateSpreadsheetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchUpdateSpreadsheetResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_create(connection, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Sheets.V4.Model.Spreadsheet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a spreadsheet, returning the newly created spreadsheet.

Parameters

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.Spreadsheet.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.Spreadsheet{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_developer_metadata_get(connection, spreadsheet_id, metadata_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_developer_metadata_get(
  Tesla.Env.client(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.DeveloperMetadata.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to retrieve metadata from.
  • metadata_id (type: integer()) - The ID of the developer metadata to retrieve.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.DeveloperMetadata{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_developer_metadata_search(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_developer_metadata_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.SearchDeveloperMetadataResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to retrieve metadata from.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.SearchDeveloperMetadataRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.SearchDeveloperMetadataResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_get(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Sheets.V4.Model.Spreadsheet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The spreadsheet to request.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :includeGridData (type: boolean()) - True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
    • :ranges (type: list(String.t)) - The ranges to retrieve from the spreadsheet.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.Spreadsheet{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_get_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_get_by_data_filter(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.Spreadsheet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The spreadsheet to request.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.GetSpreadsheetByDataFilterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.Spreadsheet{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_sheets_copy_to(connection, spreadsheet_id, sheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_sheets_copy_to(
  Tesla.Env.client(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.SheetProperties.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet containing the sheet to copy.
  • sheet_id (type: integer()) - The ID of the sheet to copy.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.CopySheetToAnotherSpreadsheetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.SheetProperties{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_append(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_append(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.AppendValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • range (type: String.t) - The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :includeValuesInResponse (type: 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 (type: String.t) - How the input data should be inserted.
    • :responseDateTimeRenderOption (type: String.t) - 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.
    • :responseValueRenderOption (type: String.t) - Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
    • :valueInputOption (type: String.t) - How the input data should be interpreted.
    • :body (type: GoogleApi.Sheets.V4.Model.ValueRange.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.AppendValuesResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_batch_clear(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_batch_clear(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchClearValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.BatchClearValuesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchClearValuesResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_batch_clear_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_batch_clear_by_data_filter(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchClearValuesByDataFilterResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.BatchClearValuesByDataFilterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchClearValuesByDataFilterResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_batch_get(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_batch_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchGetValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to retrieve data from.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :dateTimeRenderOption (type: String.t) - 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.
    • :majorDimension (type: String.t) - 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]].
    • :ranges (type: list(String.t)) - The A1 notation or R1C1 notation of the range to retrieve values from.
    • :valueRenderOption (type: String.t) - How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchGetValuesResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_batch_get_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_batch_get_by_data_filter(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchGetValuesByDataFilterResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to retrieve data from.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.BatchGetValuesByDataFilterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchGetValuesByDataFilterResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_batch_update(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchUpdateValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.BatchUpdateValuesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchUpdateValuesResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_batch_update_by_data_filter(connection, spreadsheet_id, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_batch_update_by_data_filter(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.BatchUpdateValuesByDataFilterResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.BatchUpdateValuesByDataFilterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.BatchUpdateValuesByDataFilterResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_clear(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_clear(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.ClearValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • range (type: String.t) - The A1 notation or R1C1 notation of the values to clear.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Sheets.V4.Model.ClearValuesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.ClearValuesResponse{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_get(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.ValueRange.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to retrieve data from.
  • range (type: String.t) - The A1 notation or R1C1 notation of the range to retrieve values from.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :dateTimeRenderOption (type: String.t) - 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.
    • :majorDimension (type: String.t) - 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]].
    • :valueRenderOption (type: String.t) - How values should be represented in the output. The default render option is FORMATTED_VALUE.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.ValueRange{}} on success
  • {:error, info} on failure
Link to this function

sheets_spreadsheets_values_update(connection, spreadsheet_id, range, optional_params \\ [], opts \\ [])

View Source 
@spec sheets_spreadsheets_values_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Sheets.V4.Model.UpdateValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Sheets.V4.Connection.t) - Connection to server
  • spreadsheet_id (type: String.t) - The ID of the spreadsheet to update.
  • range (type: String.t) - The A1 notation of the values to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :includeValuesInResponse (type: 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 (type: String.t) - 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.
    • :responseValueRenderOption (type: String.t) - Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
    • :valueInputOption (type: String.t) - How the input data should be interpreted.
    • :body (type: GoogleApi.Sheets.V4.Model.ValueRange.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Sheets.V4.Model.UpdateValuesResponse{}} on success
  • {:error, info} on failure