google-webmasters3 库允许访问 Google 网页管理员服务的所有功能。

本文档是根据 webmasters 库版本 5.0.5+20190428 生成的，其中 20190428 是由 mako 代码生成器 v5.0.5 构建的 webmasters:v3 架构的确切修订版。

有关 webmasters v3 API 的其他信息，请参阅 官方文档网站。

功能

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

• searchanalytics
• query
• sitemaps
• delete、get、list 和 submit
• sites
• add、delete、get 和 list

本库的结构

API 结构如下

• 枢纽
  • 一个中央对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 可以应用 活动 的主要类型
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 不会直接在 活动 中使用
• 活动
  • 应用于 资源 的操作

所有 结构 都用适用的特质标记，以便进一步分类和便于浏览。

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

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

或者更具体地说...

let r = hub.searchanalytics().query(...).doit().await

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

用法

设置你的项目

要使用此库，请将以下行放入你的 Cargo.toml 文件

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_webmasters3 as webmasters3;
use webmasters3::api::SearchAnalyticsQueryRequest;
use webmasters3::{Result, Error};
use std::default::Default;
use webmasters3::{Webmasters, 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 = Webmasters::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = SearchAnalyticsQueryRequest::default();

// 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.searchanalytics().query(req, "siteUrl")
             .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")。

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 特性

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

许可证

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