google-pagespeedonline4 库允许访问 Google pagespeedonline 服务的所有功能。

本文档是从 pagespeedonline 包版本 5.0.5+20191206 生成的，其中 20191206 是由 mako 代码生成器 v5.0.5 构建的 pagespeedonline:v4 方案的精确修订。

有关 pagespeedonline v4 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-pagespeedonline4 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pagespeedonline4 as pagespeedonline4;
use pagespeedonline4::{Result, Error};
use std::default::Default;
use pagespeedonline4::{Pagespeedonline, 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 = Pagespeedonline::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")
             .snapshots(false)
             .screenshot(true)
             .add_rule("amet.")
             .locale("duo")
             .filter_third_party_resources(true)
             .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 枚举的返回值提供，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

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

上传和下载

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

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