Struct SpreadsheetValueGetCall

pub struct SpreadsheetValueGetCall<'a, C>
where
    C: 'a,
{ /* private fields */ }

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

A builder for the values.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().values_get("spreadsheetId", "range")
             .value_render_option("erat")
             .major_dimension("sed")
             .date_time_render_option("duo")
             .doit().await;

Implementations

impl<'a, C> SpreadsheetValueGetCall<'a, C>

where C: Connector,

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

Perform the operation you have build so far.

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

The ID of the spreadsheet to retrieve data from.

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 range(self, new_value: &str) -> SpreadsheetValueGetCall<'a, C>

The A1 notation or R1C1 notation of the range to retrieve values from.

Sets the range 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 value_render_option( self, new_value: &str, ) -> SpreadsheetValueGetCall<'a, C>

How values should be represented in the output. The default render option is FORMATTED_VALUE.

Sets the value render option query property to the given value.

pub fn major_dimension(self, new_value: &str) -> SpreadsheetValueGetCall<'a, C>

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]].

Sets the major dimension query property to the given value.

pub fn date_time_render_option( self, new_value: &str, ) -> SpreadsheetValueGetCall<'a, C>

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.

Sets the date time render option query property to the given value.

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

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) -> SpreadsheetValueGetCall<'a, C>

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

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

pub fn add_scope<St>(self, scope: St) -> SpreadsheetValueGetCall<'a, C>

where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of 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.

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.

pub fn add_scopes<I, St>(self, scopes: I) -> SpreadsheetValueGetCall<'a, C>

where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

pub fn clear_scopes(self) -> SpreadsheetValueGetCall<'a, C>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations

impl<'a, C> CallBuilder for SpreadsheetValueGetCall<'a, C>