google-reseller1_sandbox 库允许访问 Google 经销商服务的所有功能。

本文档是从 reseller crate 版本 5.0.5+20160329 生成的，其中 20160329 是由 mako 代码生成器 v5.0.5 构建的 reseller:v1sandbox 架构的精确修订版本。

关于 reseller v1_sandbox API 的其他所有信息可以在 官方文档网站 找到。

功能

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

• 客户
• 获取, 插入, 修补 和 更新
• 订阅
• 激活, 更改计划, 更改续订设置, 更改座位, 删除, 获取, 插入, 列出, 启动付费服务 和 暂停

本库的结构

API 结构如下几个主要项目

• 中心节点
  • 一个中央对象，用于维护状态和访问所有 活动
  • 创建 方法构建器，这又允许访问单个 调用构建器
• 资源
  • 您可以应用 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 永远不会直接用于 活动
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用的特性，以便进一步分类和便于浏览。

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

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

或者具体...

let r = hub.subscriptions().activate(...).doit().await
let r = hub.subscriptions().change_plan(...).doit().await
let r = hub.subscriptions().change_renewal_settings(...).doit().await
let r = hub.subscriptions().change_seats(...).doit().await
let r = hub.subscriptions().delete(...).doit().await
let r = hub.subscriptions().get(...).doit().await
let r = hub.subscriptions().insert(...).doit().await
let r = hub.subscriptions().list(...).doit().await
let r = hub.subscriptions().start_paid_service(...).doit().await
let r = hub.subscriptions().suspend(...).doit().await

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

用法

设置您的项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_reseller1_sandbox as reseller1_sandbox;
use reseller1_sandbox::{Result, Error};
use std::default::Default;
use reseller1_sandbox::{Reseller, 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 = Reseller::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.subscriptions().list()
             .page_token("et")
             .max_results(68)
             .customer_name_prefix("no")
             .customer_id("ipsum")
             .customer_auth_token("voluptua.")
             .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() 方法的返回值，或者作为可能的中继结果传递给 中心节点代理 或 认证代理。

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

上传和下载

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

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

自定义和回调

您可以通过提供给 委托 给 方法构建器 的方式来改变 doit() 方法调用的方式。在最终调用 doit() 之前，将调用相应的方法来提供进度信息，并确定系统在失败时应否重试。

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

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述是正确的。

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

参数将始终复制或克隆到构建器中，以使它们与其原始生命周期独立。

Cargo 功能

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

许可证

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