#protocols #google #web #google-api #web-api #chromemanagement

google-chromemanagement1

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

11 个稳定版本 (3 个主要版本)

5.0.5+20240624 2024 年 6 月 27 日
5.0.4+20240303 2024 年 3 月 5 日
5.0.3+20230123 2023 年 8 月 23 日
5.0.2+20230123 2023 年 3 月 16 日
2.0.4+20210330 2021 年 4 月 14 日

网络编程 中排名 2821


用于 google-chromemanagement1-…

MIT 许可证

590KB
7K SLoC

google-chromemanagement1 库允许访问 Google Chrome Management 服务的所有功能。

本文档由 Chrome Management crate 版本 5.0.5+20240624 生成,其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 chromemanagement:v1 模式的确切版本。

有关 Chrome Management v1 API 的其他所有信息,请参阅 官方文档站点

功能

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

本库结构

API结构化为主以下主要项目

  • 中心
  • 资源
    • 可以应用活动到的主要类型
    • 属性和部分的集合
    • 部分
      • 属性的集合
      • 活动中永远不会直接使用
  • 活动
    • 应用到资源的操作

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

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

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

或者具体来说...

let r = hub.customers().apps_android_get(...).doit().await
let r = hub.customers().apps_chrome_get(...).doit().await
let r = hub.customers().apps_web_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_chromemanagement1 as chromemanagement1;
use chromemanagement1::{Result, Error};
use std::default::Default;
use chromemanagement1::{ChromeManagement, 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 = ChromeManagement::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.customers().apps_android_get("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()调用之前向Method Builder提供一个delegate来改变doit()方法的调用方式。将调用相应的方法以提供进度信息,并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法总是接受一个参数,以下声明对此适用。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–22MB
~341K SLoC