#google-api #google #web-api #google-service #protocols #web #mybusinessaccountman

google-mybusinessaccountmanagement1

与 My Business Account Management (协议 v1) 交互的完整库

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

5.0.5+20240625 2024 年 6 月 27 日
5.0.4+20240304 2024 年 3 月 5 日
5.0.3+20230124 2023 年 8 月 24 日
5.0.2+20230124 2023 年 3 月 16 日
2.0.4+20210330 2021 年 4 月 15 日

#2586 in 网页编程

Download history 7/week @ 2024-05-19 1/week @ 2024-05-26 88/week @ 2024-06-23 57/week @ 2024-06-30

708 每月下载量
用于 google-mybusinessaccountm…

MIT 许可证

295KB
3.5K SLoC

google-mybusinessaccountmanagement1 库允许访问 Google My Business Account Management 服务(v1)的所有功能。

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

关于 My Business Account Management v1 API 的其他信息可以在 官方文档网站 找到。

功能

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

库的结构

API 被组织成以下主要项

  • 中心
  • 资源
    • 主要类型,可以将 活动 应用到这些类型上
    • 一系列属性和 部分
    • 部分
      • 一系列属性
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体...

let r = hub.accounts().admins_create(...).doit().await
let r = hub.accounts().admins_delete(...).doit().await
let r = hub.accounts().admins_list(...).doit().await
let r = hub.accounts().admins_patch(...).doit().await
let r = hub.accounts().invitations_accept(...).doit().await
let r = hub.accounts().invitations_decline(...).doit().await
let r = hub.accounts().invitations_list(...).doit().await
let r = hub.accounts().create(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().list(...).doit().await
let r = hub.accounts().patch(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusinessaccountmanagement1 as mybusinessaccountmanagement1;
use mybusinessaccountmanagement1::{Result, Error};
use std::default::Default;
use mybusinessaccountmanagement1::{MyBusinessAccountManagement, 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 = MyBusinessAccountManagement::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.accounts().list()
             .parent_account("et")
             .page_token("magna")
             .page_size(-11)
             .filter("ipsum")
             .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()方法的方式。相应的函数将被调用以提供进度信息,并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–22MB
~342K SLoC