google-chromeuxreport1 库允许访问 Google Chrome UX 报告服务（协议 v1）的所有功能。

本文档是根据 Chrome UX 报告 包版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 chromeuxreport:v1 架构的确切修订版。

有关 Chrome UX 报告 v1 API 的其他所有信息，请参阅 官方文档网站。

特性

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

• 记录
• 查询历史记录 和 查询记录

库结构

API 结构如下主要项

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，它们又允许访问单个 调用构建器
• 资源
  • 可以将 活动 应用到的基本类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 从不直接用于 活动
• 活动
  • 应用于 资源 的操作

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

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

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

或者具体...

let r = hub.records().query_history_record(...).doit().await
let r = hub.records().query_record(...).doit().await

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

使用方法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_chromeuxreport1 as chromeuxreport1;
use chromeuxreport1::api::QueryHistoryRequest;
use chromeuxreport1::{Result, Error};
use std::default::Default;
use chromeuxreport1::{ChromeUXReport, 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 = ChromeUXReport::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 = QueryHistoryRequest::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.records().query_history_record(req)
             .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()方法的调用方式。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait具有默认实现，允许您以最少的努力进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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