该 google-adexperiencereport1 库允许访问 Google 广告体验报告服务的所有功能。

本文档是从 广告体验报告 框架版本 5.0.5+20240610 生成的，其中 20240610 是由 mako 代码生成器 v5.0.5 构建的 adexperiencereport:v1 架构的确切修订版。

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

特性

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

• 网站
• 获取
• 违规网站
• 列表

库的结构

API 被组织成以下主要项目

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

所有 结构 都带有适用的特征，以进一步分类它们并简化浏览。

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

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

或者具体来说 ...

let r = hub.sites().get(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adexperiencereport1 as adexperiencereport1;
use adexperiencereport1::{Result, Error};
use std::default::Default;
use adexperiencereport1::{AdExperienceReport, 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 = AdExperienceReport::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.sites().get("name")
             .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(...)。

定制和回调

您可以通过向Method Builder提供delegate来修改doit()方法的调用方式，在执行最终的doit()调用之前。相应的方将调用以提供进度信息，以及确定系统在失败时应否重试。

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

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器，您可以通过多次调用其方法来准备一个操作调用。这些方法总是接受单个参数，以下语句是正确的。

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

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

Cargo 功能

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

许可证

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