#google-api #licensing #google #protocols #web #web-api #api

google-licensing1

一个完整的库,用于与许可(协议 v1)交互

42 个版本 (25 个稳定版本)

5.0.5+20240624 2024年6月27日
5.0.4+20240301 2024年3月5日
5.0.3+20230121 2023年8月23日
5.0.2+20230121 2023年3月17日
0.1.2+20140122 2015年3月25日

#2571 in 网页编程


用于 google-licensing1-cli

MIT 许可证

200KB
2.5K SLoC

google-licensing1 库允许访问 Google 许可服务所有功能。

此文档是从 licensing crate 版本 5.0.5+20240624 生成的,其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 licensing:v1 架构的确切修订版。

有关 licensing v1 API 的其他信息,请参阅 官方文档网站

功能

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

此库的结构

API 被组织成以下主要项目

  • 枢纽
  • 资源
    • 主要类型,您可以将 活动 应用于这些类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从未在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有相应的属性,以进一步分类并便于浏览。

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

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

或者具体...

let r = hub.license_assignments().delete(...).doit().await
let r = hub.license_assignments().get(...).doit().await
let r = hub.license_assignments().insert(...).doit().await
let r = hub.license_assignments().list_for_product(...).doit().await
let r = hub.license_assignments().list_for_product_and_sku(...).doit().await
let r = hub.license_assignments().patch(...).doit().await
let r = hub.license_assignments().update(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_licensing1 as licensing1;
use licensing1::{Result, Error};
use std::default::Default;
use licensing1::{Licensing, 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 = Licensing::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.license_assignments().list_for_product_and_sku("productId", "skuId", "customerId")
             .page_token("ipsum")
             .max_results(73)
             .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() 之前向 Method Builder 提供一个 代理 来更改 doit() 方法的调用方式。将调用相应的方法来提供进度信息,以及确定系统在失败时应否重试。

代理 trait 具有默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部件

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖项

~12–22MB
~342K SLoC