Struct google_sheets4::api::SpreadsheetValueAppendCall
source · pub struct SpreadsheetValueAppendCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
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.
A builder for the values.append method supported by a spreadsheet resource.
It is not used directly, but through a SpreadsheetMethods instance.
§Example
Instantiate a resource method builder
use sheets4::api::ValueRange;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = ValueRange::default();
// 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_append(req, "spreadsheetId", "range")
.value_input_option("ipsum")
.response_value_render_option("ipsum")
.response_date_time_render_option("est")
.insert_data_option("gubergren")
.include_values_in_response(false)
.doit().await;Implementations§
source§impl<'a, S> SpreadsheetValueAppendCall<'a, S>
impl<'a, S> SpreadsheetValueAppendCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, AppendValuesResponse)>
pub async fn doit(self) -> Result<(Response<Body>, AppendValuesResponse)>
Perform the operation you have build so far.
sourcepub fn request(self, new_value: ValueRange) -> SpreadsheetValueAppendCall<'a, S>
pub fn request(self, new_value: ValueRange) -> SpreadsheetValueAppendCall<'a, S>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn spreadsheet_id(
self,
new_value: &str
) -> SpreadsheetValueAppendCall<'a, S>
pub fn spreadsheet_id( self, new_value: &str ) -> SpreadsheetValueAppendCall<'a, S>
The ID of the spreadsheet to update.
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.
sourcepub fn range(self, new_value: &str) -> SpreadsheetValueAppendCall<'a, S>
pub fn range(self, new_value: &str) -> SpreadsheetValueAppendCall<'a, S>
The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
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.
sourcepub fn value_input_option(
self,
new_value: &str
) -> SpreadsheetValueAppendCall<'a, S>
pub fn value_input_option( self, new_value: &str ) -> SpreadsheetValueAppendCall<'a, S>
How the input data should be interpreted.
Sets the value input option query property to the given value.
sourcepub fn response_value_render_option(
self,
new_value: &str
) -> SpreadsheetValueAppendCall<'a, S>
pub fn response_value_render_option( self, new_value: &str ) -> SpreadsheetValueAppendCall<'a, S>
Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
Sets the response value render option query property to the given value.
sourcepub fn response_date_time_render_option(
self,
new_value: &str
) -> SpreadsheetValueAppendCall<'a, S>
pub fn response_date_time_render_option( self, new_value: &str ) -> SpreadsheetValueAppendCall<'a, S>
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.
Sets the response date time render option query property to the given value.
sourcepub fn insert_data_option(
self,
new_value: &str
) -> SpreadsheetValueAppendCall<'a, S>
pub fn insert_data_option( self, new_value: &str ) -> SpreadsheetValueAppendCall<'a, S>
How the input data should be inserted.
Sets the insert data option query property to the given value.
sourcepub fn include_values_in_response(
self,
new_value: bool
) -> SpreadsheetValueAppendCall<'a, S>
pub fn include_values_in_response( self, new_value: bool ) -> SpreadsheetValueAppendCall<'a, S>
Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
Sets the include values in response query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> SpreadsheetValueAppendCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> SpreadsheetValueAppendCall<'a, S>
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.
sourcepub fn param<T>(self, name: T, value: T) -> SpreadsheetValueAppendCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> SpreadsheetValueAppendCall<'a, S>
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”).
sourcepub fn add_scope<St>(self, scope: St) -> SpreadsheetValueAppendCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> SpreadsheetValueAppendCall<'a, S>
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::Drive.
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.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> SpreadsheetValueAppendCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> SpreadsheetValueAppendCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> SpreadsheetValueAppendCall<'a, S>
pub fn clear_scopes(self) -> SpreadsheetValueAppendCall<'a, S>
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).