Struct google_sheets4::SpreadsheetGetCall

pub struct SpreadsheetGetCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

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.

A builder for the get method supported by a spreadsheet resource. It is not used directly, but through a SpreadsheetMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.spreadsheets().get("spreadsheetId")
             .add_ranges("et")
             .include_grid_data(true)
             .doit();

Implementations

impl<'a, C, A> SpreadsheetGetCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, Spreadsheet)>

Perform the operation you have build so far.

pub fn spreadsheet_id(self, new_value: &str) -> SpreadsheetGetCall<'a, C, A>

The spreadsheet to request.

Sets the spreadsheet id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn add_ranges(self, new_value: &str) -> SpreadsheetGetCall<'a, C, A>

The ranges to retrieve from the spreadsheet.

Append the given value to the ranges query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn include_grid_data(self, new_value: bool) -> SpreadsheetGetCall<'a, C, A>

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

Sets the include grid data query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> SpreadsheetGetCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> SpreadsheetGetCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• quotaUser (query-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.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> SpreadsheetGetCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::DriveReadonly.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for SpreadsheetGetCall<'a, C, A>