google-cloudcommerceprocurement1 库允许访问 Google Cloud Commerce Partner Procurement Service 服务的所有功能。

本文档由 Cloud Commerce Partner Procurement Service 版本 5.0.5+20240804 生成，其中 20240804 是由 mako 代码生成器 v5.0.5 构建的 cloudcommerceprocurement:v1 架构的确切修订版本。

有关 Cloud Commerce Partner Procurement Service v1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 提供者
• 账户批准、账户获取、账户列表、账户拒绝、账户重置、权益批准、权益批准计划更改、权益获取、权益列表、权益修补、权益拒绝、权益拒绝计划更改 和 权益暂停

本库结构

API结构如下主要项

• 中心对象
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，它们反过来允许访问单个调用构建器
• 资源
  • 你可以应用活动到的主要类型
  • 属性和部分的集合
  • 部分
    • 属性集合
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

所有结构都标有适用的特性和进一步分类它们以简化浏览。

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

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

或者具体...

let r = hub.providers().entitlements_suspend(...).doit().await
let r = hub.providers().entitlements_reject_plan_change(...).doit().await
let r = hub.providers().entitlements_approve(...).doit().await
let r = hub.providers().entitlements_approve_plan_change(...).doit().await
let r = hub.providers().entitlements_reject(...).doit().await
let r = hub.providers().accounts_approve(...).doit().await
let r = hub.providers().accounts_reject(...).doit().await
let r = hub.providers().accounts_reset(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudcommerceprocurement1 as cloudcommerceprocurement1;
use cloudcommerceprocurement1::api::SuspendEntitlementRequest;
use cloudcommerceprocurement1::{Result, Error};
use std::default::Default;
use cloudcommerceprocurement1::{CloudCommercePartnerProcurementService, 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 = CloudCommercePartnerProcurementService::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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 = SuspendEntitlementRequest::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.providers().entitlements_suspend(req, "name")
             .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(...)。

定制和回调

您可以通过向doit()调用提供代理到方法构建器来改变调用doit()的方式。相应的函数将被调用以提供进度信息，并确定系统在失败时是否应该重试。

代理特质默认实现，允许您以最小的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

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

• POD通过复制传递
• 字符串作为&str传递
• 请求值是移动的

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

Cargo特性

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

许可证

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