“google-gmailpostmastertools1”库允许访问 Google Postmaster Tools 服务的所有功能。

本文档是从 Postmaster Tools crate 版本 5.0.5+20240626 生成的，其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 gmailpostmastertools:v1 架构的确切修订版。

有关 Postmaster Tools v1 API 的其他信息，请参阅 官方文档网站。

功能

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

• 域名
• 获取, 列表, 流量统计获取 和 流量统计列表

库的结构

API 被结构化为以下主要项

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

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

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

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

或者具体来说 ...

let r = hub.domains().traffic_stats_get(...).doit().await
let r = hub.domains().traffic_stats_list(...).doit().await
let r = hub.domains().get(...).doit().await
let r = hub.domains().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gmailpostmastertools1 as gmailpostmastertools1;
use gmailpostmastertools1::{Result, Error};
use std::default::Default;
use gmailpostmastertools1::{PostmasterTools, 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 = PostmasterTools::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.domains().traffic_stats_list("parent")
             .start_date_year(-33)
             .start_date_month(-11)
             .start_date_day(-55)
             .page_token("voluptua.")
             .page_size(-27)
             .end_date_year(-8)
             .end_date_month(-80)
             .end_date_day(-2)
             .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),
}

处理错误

系统产生的所有错误都作为 doit() 方法的返回值提供的 Result 枚举，或者作为可能的中继结果传递给 Hub Delegate，或 Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

如果方法支持下载，则响应体（它是 Result 的一部分）应由您读取以获取媒体。如果该方法还支持 Response Result，则默认返回它。您可以将它视为实际媒体的元数据。要触发媒体下载，您必须通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多 2 种不同的协议进行上传：简单和可恢复。每个协议的独特性由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

定制和回调

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

代理特质 Delegate 默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

本库提供的所有结构都是为了通过 编码 和 解码 为 json 而设计的。使用可选值来表示部分请求和响应是有效的。大多数可选值都是 部分，可以通过名称识别，这些部分将被发送到服务器以指示请求的设置部分或响应中希望包含的部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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