GoogleApi.Sheets.V4.Api.Spreadsheets.sheets_spreadsheets_get
You're seeing just the function
sheets_spreadsheets_get
, go back to GoogleApi.Sheets.V4.Api.Spreadsheets module for more information.
Link to this function
sheets_spreadsheets_get(connection, spreadsheet_id, optional_params \\ [], opts \\ [])
View SourceSpecs
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 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
(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