google-gmailpostmastertools1_beta1 库允许访问 Google Postmaster Tools（服务）的所有功能。

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

关于 Postmaster Tools v1_beta1 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(...) 调用创建 构建器。第二个处理 活动 支持各种方法来配置即将进行的操作（此处未显示）。它是这样设计的，即所有必需的参数必须立即指定（即 (...)），而所有可选的参数都可以按需 构建。 doit() 方法执行与服务器的实际通信并返回相应的结果。

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gmailpostmastertools1_beta1 as gmailpostmastertools1_beta1;
use gmailpostmastertools1_beta1::{Result, Error};
use std::default::Default;
use gmailpostmastertools1_beta1::{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),
}

处理错误

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

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

上传和下载

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

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

自定义和回调

您可以通过向委托提供方法构建器，在执行最终的doit()调用之前修改一个doit()方法调用的方式。将调用相应的方法以提供进度信息，以及确定系统在失败时是否应该重试。

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

许可证

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