#google #google-api #protocols #web-api #web #digitalassetlinks

google-digitalassetlinks1

一个完整的库,用于与数字资产链接(协议v1)交互

18 个稳定版本 (4 个主要版本)

5.0.5+20240622 2024年6月27日
5.0.4+20240224 2024年3月5日
5.0.3+20230117 2023年8月23日
5.0.2+20230117 2023年3月16日
1.0.8+20181009 2018年10月14日

#2650 in Web编程


google-digitalassetlinks1… 中使用

MIT 许可证

150KB
2K SLoC

《google-digitalassetlinks1》库允许访问《Google数字资产链接》服务的所有功能。

本文档是根据《digitalassetlinks》crate版本《5.0.5+20240622》生成的,其中《20240622》是《digitalassetlinks:v1》模式的确切修订版本,该模式由mako代码生成器《v5.0.5》构建。

有关《digitalassetlinks》v1 API的所有其他信息,请参阅官方文档网站

功能

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

库的结构

API被结构化为以下主要项

  • 枢纽
    • 一个中心对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器反过来又允许访问单个 调用构建器
  • 资源
    • 您可以将 活动 应用于其上的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中永远不会直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地说 ...

let r = hub.assetlinks().bulk_check(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_digitalassetlinks1 as digitalassetlinks1;
use digitalassetlinks1::api::BulkCheckRequest;
use digitalassetlinks1::{Result, Error};
use std::default::Default;
use digitalassetlinks1::{Digitalassetlinks, 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 = Digitalassetlinks::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 = BulkCheckRequest::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.assetlinks().bulk_check(req)
             .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(...)

定制和回调

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

代理特质 默认实现,允许您以最少的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是可编码和可解码的,通过 编码解码 的方式。使用可选值来表示部分请求或响应是有效的。大多数可选值都是 部分,通过名称可以识别,这些部分将被发送到服务器,以表示请求的集合部分或响应中期望的部分。

构建器参数

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

  • POD 以副本形式传递
  • 字符串作为 &str 传递
  • 请求值 是移动的

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

Cargo 功能

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

许可

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

依赖项

~12–23MB
~343K SLoC