google-content2_sandbox 库允许访问 Google 购物内容服务的所有功能。

此文档是从 Shopping Content crate 版本 5.0.5+20181009 生成的，其中 20181009 是由 mako 代码生成器 v5.0.5 构建的 content:v2sandbox 架构的确切修订版。

有关 Shopping Content v2_sandbox API 的其他所有信息，请参阅 官方文档网站。

功能

从中央 中心轻松处理以下 资源 ...

• orderinvoices
• createchargeinvoice 和 createrefundinvoice
• orderpayments
• notifyauthapproved、notifyauthdeclined、notifycharge 和 notifyrefund
• orderreturns
• get 和 list
• orders
• 确认，提前测试订单，取消，取消行项目，客户取消测试订单，创建测试订单，创建测试退货，自定义批量操作，获取，通过商家订单ID获取，获取测试订单模板，库存退款行项目，列表，退款，拒绝退货行项目，退货行项目，退货退款行项目，设置行项目元数据，设置行项目发货，更新行项目发货详情，更新商家订单ID 和 更新发货

该库的结构

API 结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 你可以将 活动 应用到的顶级类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 从未在 活动 中直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都用相应的特质标记，以便进一步分类并方便浏览。

一般来说，你可以这样调用 活动

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

或者具体地说...

let r = hub.orders().acknowledge(...).doit().await
let r = hub.orders().advancetestorder(...).doit().await
let r = hub.orders().cancel(...).doit().await
let r = hub.orders().cancellineitem(...).doit().await
let r = hub.orders().canceltestorderbycustomer(...).doit().await
let r = hub.orders().createtestorder(...).doit().await
let r = hub.orders().createtestreturn(...).doit().await
let r = hub.orders().custombatch(...).doit().await
let r = hub.orders().get(...).doit().await
let r = hub.orders().getbymerchantorderid(...).doit().await
let r = hub.orders().gettestordertemplate(...).doit().await
let r = hub.orders().instorerefundlineitem(...).doit().await
let r = hub.orders().list(...).doit().await
let r = hub.orders().refund(...).doit().await
let r = hub.orders().rejectreturnlineitem(...).doit().await
let r = hub.orders().returnlineitem(...).doit().await
let r = hub.orders().returnrefundlineitem(...).doit().await
let r = hub.orders().setlineitemmetadata(...).doit().await
let r = hub.orders().shiplineitems(...).doit().await
let r = hub.orders().updatelineitemshippingdetails(...).doit().await
let r = hub.orders().updatemerchantorderid(...).doit().await
let r = hub.orders().updateshipment(...).doit().await

资源（resource）和活动（activity）调用创建构建器。第二个处理Activities，支持各种方法来配置即将进行的操作（此处未显示）。它设计成必须立即指定所有必需的参数（即 (...)），而所有可选参数都可以按照需要构建。doit()方法执行与服务器实际通信，并返回相应的结果。

用法

设置您的项目

要使用此库，您需要在您的Cargo.toml文件中放入以下行

[dependencies]
google-content2_sandbox = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_content2_sandbox as content2_sandbox;
use content2_sandbox::{Result, Error};
use std::default::Default;
use content2_sandbox::{ShoppingContent, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::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 = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = ShoppingContent::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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(79)
             .add_statuses("magna")
             .placed_date_start("no")
             .placed_date_end("ipsum")
             .page_token("voluptua.")
             .order_by("At")
             .max_results(93)
             .acknowledged(false)
             .doit().await;

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::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为Result枚举提供，作为doit()方法的返回值，或者作为中间结果传递给Hub Delegate或Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指导系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载，则应该读取响应体（它是Result的一部分），以获取媒体。如果此类方法还支持Response Result，则默认返回该值。您可以将它视为实际媒体的元数据。要触发媒体下载，您需要通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多2种不同的协议进行上传：简单和可恢复。每种协议的独特性由定制的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

自定义和回调

您可以通过向Method Builder提供代理来更改调用doit()方法的方式，在最终调用doit()之前。相应的函数将被调用以提供进度信息，并确定系统是否应在失败时重试。

“委托特性行为”默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

该库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 部分，通过名称进行标识，这些部分将被发送到服务器以指示请求中设置的各部分或期望的响应部分。

构建器参数

使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终只接受一个参数，以下陈述对它适用。

• PODs 通过复制传递
• 字符串作为 &str 传递
• 请求值 被移动

参数总是被复制或克隆到构建器中，以确保它们与它们的原始生命周期独立。

Cargo 功能

• utoipa - 为所有类型添加对 utoipa 的支持并从 utoipa::ToSchema 中派生。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型，否则生成的 openapi 规范将是无效的。

许可证

content2_sandbox 库由 Sebastian Thiel 生成，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。