Struct google_content2::OrderListCall

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

Lists the orders in your Merchant Center account.

A builder for the list method supported by a order resource. It is not used directly, but through a OrderMethods 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.orders().list("merchantId")
             .add_statuses("rebum.")
             .placed_date_start("et")
             .placed_date_end("clita")
             .page_token("eos")
             .order_by("dolores")
             .max_results(76)
             .acknowledged(false)
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The ID of the account that manages the order. This cannot be a multi-client account.

Sets the merchant 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_statuses(self, new_value: &str) -> OrderListCall<'a, C, A>

Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

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

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

Obtains orders placed after this date (inclusively), in ISO 8601 format.

Sets the placed date start query property to the given value.

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

Obtains orders placed before this date (exclusively), in ISO 8601 format.

Sets the placed date end query property to the given value.

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

The token returned by the previous request.

Sets the page token query property to the given value.

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

The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.

Sets the order by query property to the given value.

pub fn max_results(self, new_value: u32) -> OrderListCall<'a, C, A>

The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field.

Sets the max results query property to the given value.

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

Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.

Sets the acknowledged query property to the given value.

pub fn delegate(self, new_value: &'a mut Delegate) -> OrderListCall<'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) -> OrderListCall<'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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> OrderListCall<'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::Full.

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 OrderListCall<'a, C, A>