该 google-searchconsole1 库允许访问 Google Search Console 服务中的所有功能。

本文档是从版本 5.0.5+20240625 的 Search Console crate 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 searchconsole:v1 模式的确切修订版。

关于 Search Console v1 API 的其他信息可以在 官方文档网站 上找到。

功能

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

• searchanalytics
• query
• sitemaps
• delete, get, list 和 submit
• sites
• add, delete, get 和 list
• url 检查
• 索引检查
• url 测试工具
• 移动友好性测试运行

本库结构

API 结构如下主要项

• 中心
  • 一个中央对象，用于维护状态和允许访问所有 活动
  • 创建 方法构建器，后者又允许访问单个 调用构建器
• 资源
  • 可以应用 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

所有结构都通过适用的特征进行标记，以进一步分类并简化浏览。

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

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

或者具体...

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

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_searchconsole1 as searchconsole1;
use searchconsole1::api::SearchAnalyticsQueryRequest;
use searchconsole1::{Result, Error};
use std::default::Default;
use searchconsole1::{SearchConsole, 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 = SearchConsole::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),
}

处理错误

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

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

上传和下载

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

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

自定义和回调

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

默认实现了委托trait，让您可以以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器，您可以通过反复调用其方法来准备操作调用。这些方法始终接受单个参数，以下语句为真。

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

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

Cargo功能

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

许可

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