#manager #google-api #google #web-api #api #protocols #web

google-manager1_beta2

用于与 manager(协议 v1beta2)交互的完整库

42 个版本 (25 个稳定版)

5.0.5+20140915 2024 年 6 月 27 日
5.0.4+20140915 2024 年 3 月 5 日
5.0.3+20140915 2023 年 8 月 24 日
5.0.2+20140915 2023 年 3 月 16 日
0.1.2+20140915 2015 年 3 月 25 日

#2441 in 网页编程


google-manager1_beta2-cli 中使用

MIT 许可证

225KB
3K SLoC

google-manager1_beta2 库允许访问 Google manager 服务所有功能。

本文档是根据 manager crate 版本 5.0.5+20140915 生成的,其中 20140915 是由 mako 代码生成器 v5.0.5 构建的 manager:v1beta2 架构的精确修订版本。

关于 manager v1_beta2 API 的其他所有信息,请参阅官方文档站点

功能

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

库结构

API 被组织成以下主要项

  • 枢纽
  • 资源
    • 可以将其应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 从未在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体来说 ...

let r = hub.deployments().delete(...).doit().await
let r = hub.deployments().get(...).doit().await
let r = hub.deployments().insert(...).doit().await
let r = hub.deployments().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_manager1_beta2 as manager1_beta2;
use manager1_beta2::{Result, Error};
use std::default::Default;
use manager1_beta2::{Manager, 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 = Manager::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.deployments().list("projectId", "region")
             .page_token("no")
             .max_results(-55)
             .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")

支持上传的方法可以使用最多两种协议进行上传:简单可恢复。每个的独特之处由定制的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

定制和回调

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

委托特质 默认实现,让您可以以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都旨在通过 json 进行 编码解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求的设置部分或响应中希望获得的部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC