GoogleApi.Sheets.V4.Api.Spreadsheets.sheets_spreadsheets_get_by_data_filter

You're seeing just the function sheets_spreadsheets_get_by_data_filter, go back to GoogleApi.Sheets.V4.Api.Spreadsheets module for more information.
Link to this function

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

View Source

Specs

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 will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: Specify a field mask listing your desired fields using the fields URL parameter in HTTP Set the includeGridData parameter to true. If a field mask is set, the includeGridData parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

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