Crate google_content2_sandbox [−] [src]

This documentation was generated from Shopping Content crate version 1.0.5+20170519, where 20170519 is the exact revision of the content:v2sandbox schema built by the mako code generator v1.0.5.

Everything else about the Shopping Content v2_sandbox API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

orders
- acknowledge, advancetestorder, cancel, cancellineitem, createtestorder, custombatch, get, getbymerchantorderid, gettestordertemplate, list, refund, returnlineitem, shiplineitems, updatemerchantorderid and updateshipment

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
  - a collection of properties
  - never directly used in Activities
Activities
- operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

let r = hub.orders().get(...).doit()
let r = hub.orders().list(...).doit()
let r = hub.orders().updateshipment(...).doit()
let r = hub.orders().advancetestorder(...).doit()
let r = hub.orders().updatemerchantorderid(...).doit()
let r = hub.orders().returnlineitem(...).doit()
let r = hub.orders().gettestordertemplate(...).doit()
let r = hub.orders().createtestorder(...).doit()
let r = hub.orders().refund(...).doit()
let r = hub.orders().custombatch(...).doit()
let r = hub.orders().cancellineitem(...).doit()
let r = hub.orders().getbymerchantorderid(...).doit()
let r = hub.orders().acknowledge(...).doit()
let r = hub.orders().cancel(...).doit()
let r = hub.orders().shiplineitems(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-content2_sandbox = "*"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_content2_sandbox as content2_sandbox;
use content2_sandbox::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use content2_sandbox::ShoppingContent;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = ShoppingContent::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// 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("justo")
             .placed_date_start("amet.")
             .placed_date_end("erat")
             .page_token("labore")
             .order_by("sea")
             .max_results(11)
             .acknowledged(true)
             .doit();
 
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be enocodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

PODs are handed by copy
strings are passed as &str
request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
ErrorResponse	A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound
ErrorType	An error returned by the API.
Errors	A list of errors returned by a failed batch entry.
MethodInfo	Contains information about an API request.
MultiPartReader	Provides a `Read` interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.
Order	There is no detailed description.
OrderAcknowledgeCall	Marks an order as acknowledged. This method can only be called for non-multi-client accounts.
OrderAddress	There is no detailed description.
OrderAdvancetestorderCall	Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". This method can only be called for non-multi-client accounts.
OrderCancelCall	Cancels all line items in an order, making a full refund. This method can only be called for non-multi-client accounts.
OrderCancellation	There is no detailed description.
OrderCancellineitemCall	Cancels a line item, making a full refund. This method can only be called for non-multi-client accounts.
OrderCreatetestorderCall	Sandbox only. Creates a test order. This method can only be called for non-multi-client accounts.
OrderCustombatchCall	Retrieves or modifies multiple orders in a single request. This method can only be called for non-multi-client accounts.
OrderCustomer	There is no detailed description.
OrderDeliveryDetails	There is no detailed description.
OrderGetCall	Retrieves an order from your Merchant Center account. This method can only be called for non-multi-client accounts.
OrderGetbymerchantorderidCall	Retrieves an order using merchant order id. This method can only be called for non-multi-client accounts.
OrderGettestordertemplateCall	Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. This method can only be called for non-multi-client accounts.
OrderLineItem	There is no detailed description.
OrderLineItemProduct	There is no detailed description.
OrderLineItemProductVariantAttribute	There is no detailed description.
OrderLineItemReturnInfo	There is no detailed description.
OrderLineItemShippingDetails	There is no detailed description.
OrderLineItemShippingDetailsMethod	There is no detailed description.
OrderListCall	Lists the orders in your Merchant Center account. This method can only be called for non-multi-client accounts.
OrderMethods	A builder providing access to all methods supported on order resources. It is not used directly, but through the `ShoppingContent` hub.
OrderPaymentMethod	There is no detailed description.
OrderPromotion	There is no detailed description.
OrderPromotionBenefit	There is no detailed description.
OrderRefund	There is no detailed description.
OrderRefundCall	Refund a portion of the order, up to the full amount paid. This method can only be called for non-multi-client accounts.
OrderReturn	There is no detailed description.
OrderReturnlineitemCall	Returns a line item. This method can only be called for non-multi-client accounts.
OrderShiplineitemCall	Marks line item(s) as shipped. This method can only be called for non-multi-client accounts.
OrderShipment	There is no detailed description.
OrderShipmentLineItemShipment	There is no detailed description.
OrderUpdatemerchantorderidCall	Updates the merchant order ID for a given order. This method can only be called for non-multi-client accounts.
OrderUpdateshipmentCall	Updates a shipment's status, carrier, and/or tracking ID. This method can only be called for non-multi-client accounts.
OrdersAcknowledgeRequest	There is no detailed description.
OrdersAcknowledgeResponse	There is no detailed description.
OrdersAdvanceTestOrderResponse	There is no detailed description.
OrdersCancelLineItemRequest	There is no detailed description.
OrdersCancelLineItemResponse	There is no detailed description.
OrdersCancelRequest	There is no detailed description.
OrdersCancelResponse	There is no detailed description.
OrdersCreateTestOrderRequest	There is no detailed description.
OrdersCreateTestOrderResponse	There is no detailed description.
OrdersCustomBatchRequest	There is no detailed description.
OrdersCustomBatchRequestEntry	There is no detailed description.
OrdersCustomBatchRequestEntryCancel	There is no detailed description.
OrdersCustomBatchRequestEntryCancelLineItem	There is no detailed description.
OrdersCustomBatchRequestEntryRefund	There is no detailed description.
OrdersCustomBatchRequestEntryReturnLineItem	There is no detailed description.
OrdersCustomBatchRequestEntryShipLineItems	There is no detailed description.
OrdersCustomBatchRequestEntryUpdateShipment	There is no detailed description.
OrdersCustomBatchResponse	There is no detailed description.
OrdersCustomBatchResponseEntry	There is no detailed description.
OrdersGetByMerchantOrderIdResponse	There is no detailed description.
OrdersGetTestOrderTemplateResponse	There is no detailed description.
OrdersListResponse	There is no detailed description.
OrdersRefundRequest	There is no detailed description.
OrdersRefundResponse	There is no detailed description.
OrdersReturnLineItemRequest	There is no detailed description.
OrdersReturnLineItemResponse	There is no detailed description.
OrdersShipLineItemsRequest	There is no detailed description.
OrdersShipLineItemsResponse	There is no detailed description.
OrdersUpdateMerchantOrderIdRequest	There is no detailed description.
OrdersUpdateMerchantOrderIdResponse	There is no detailed description.
OrdersUpdateShipmentRequest	There is no detailed description.
OrdersUpdateShipmentResponse	There is no detailed description.
Price	There is no detailed description.
ShoppingContent	Central instance to access all ShoppingContent related resource activities
TestOrder	There is no detailed description.
TestOrderCustomer	There is no detailed description.
TestOrderLineItem	There is no detailed description.
TestOrderLineItemProduct	There is no detailed description.
TestOrderPaymentMethod	There is no detailed description.

Enums

Error
Scope	Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder	Identifies types which represent builders for a particular resource method
Delegate	A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.
Hub	Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.
MethodsBuilder	Identifies types for building methods of a particular resource type
NestedType	Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.
Part	Identifies types which are only used as part of other types, which usually are carrying the `Resource` trait.
ReadSeek	A utility to specify reader types which provide seeking capabilities too
RequestValue	Identifies types which are used in API requests.
Resource	Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.
ResponseResult	Identifies types which are used in API responses.
ToParts	A trait for all types that can convert themselves into a parts string

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.