#google-api #google #payment #protocols #api #web-api #web

google-paymentsresellersubscription1

与 Payments Reseller Subscription(协议版本 v1)交互的完整库

8 个版本 (稳定)

5.0.5+20240626 2024年6月27日
5.0.4+20240303 2024年3月5日
5.0.3+20230123 2023年8月24日
5.0.2+20230123 2023年3月17日
3.0.0+20220307 2022年3月8日

#2670 in 网页编程


google-paymentsresellersu… 中使用

MIT 许可证

290KB
3.5K SLoC

“google-paymentsresellersubscription1”库允许访问“Google Payments Reseller Subscription”服务的所有功能。

本文档是从“Payments Reseller Subscription”crate版本“5.0.5+20240626”生成的,其中“20240626”是mako代码生成器v5.0.5构建的“paymentsresellersubscription:v1”模式的精确版本。

有关“Payments Reseller Subscription”v1 API的其他信息,请参阅官方文档网站

功能

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

本库的结构

该API结构如下主要项

  • 中心
  • 资源
    • 可以将 活动 应用到的基本类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从未在 活动中 直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用的特性,以进一步分类它们并便于浏览。

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

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

或者具体来说 ...

let r = hub.partners().subscriptions_create(...).doit().await
let r = hub.partners().subscriptions_get(...).doit().await
let r = hub.partners().subscriptions_provision(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_paymentsresellersubscription1 as paymentsresellersubscription1;
use paymentsresellersubscription1::api::GoogleCloudPaymentsResellerSubscriptionV1Subscription;
use paymentsresellersubscription1::{Result, Error};
use std::default::Default;
use paymentsresellersubscription1::{PaymentsResellerSubscription, 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 = PaymentsResellerSubscription::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 = GoogleCloudPaymentsResellerSubscriptionV1Subscription::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.partners().subscriptions_create(req, "parent")
             .subscription_id("magna")
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用最多2种协议进行上传:简单可续传。每种协议的独特性由自定义的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

自定义和回调

您可以通过向 方法构建器 提供一个 委托 来修改 doit() 方法的调用方式,在执行最终的 doit() 调用之前。相应的方 法将被调用以提供进度信息,并确定系统在失败时是否应重试。

委托 trait 默认实现,让您可以轻松自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可

《paymentsresellersubscription1》库由Sebastian Thiel生成,并置于MIT许可下。您可以在仓库的许可文件中阅读全文。

依赖关系

~12–23MB
~346K SLoC