google-pagespeedonline5 库允许访问 Google Pagespeed Insights 服务（协议 v5）的所有功能。

本文档是根据 Pagespeed Insights 库版本 5.0.5+20240624 生成的，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 pagespeedonline:v5 模式的确切修订版。

有关 Pagespeed Insights v5 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• pagespeedapi
• runpagespeed

本库的结构

API 被组织成以下主要项目

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

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

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

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

或具体地...

let r = hub.pagespeedapi().runpagespeed(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pagespeedonline5 as pagespeedonline5;
use pagespeedonline5::{Result, Error};
use std::default::Default;
use pagespeedonline5::{PagespeedInsights, 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 = PagespeedInsights::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.pagespeedapi().runpagespeed("url")
             .utm_source("magna")
             .utm_campaign("no")
             .strategy("ipsum")
             .locale("voluptua.")
             .add_category("At")
             .captcha_token("sanctus")
             .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() 之前向 Method Builder 提供一个 代理 来更改 doit() 方法调用的方式。相关方法将被调用以提供进度信息，并确定系统是否在失败时重试。

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

服务器请求中的可选部分

此库提供的所有结构都是为了能够通过 编码 和 解码 以 json 格式进行设计的。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都是 Parts，可以通过名称识别，这些部分将被发送到服务器，以指示请求的集合部分或响应中期望的部分。

构建器参数

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

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

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

Cargo 功能

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

许可

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