google-doubleclicksearch2 库允许访问 Google Doubleclicksearch 服务所有功能。

此文档由 Doubleclicksearch crate 版本 5.0.5+20240618 生成，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 doubleclicksearch:v2 模式的确切修订版。

关于 Doubleclicksearch v2 API 的其他所有信息可以在 官方文档网站 找到。

功能

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

• 转化
• 获取、按客户 ID 获取、插入、更新 和 更新可用性
• 报告
• 生成、获取、获取文件、获取 ID 映射文件 和 请求
• 保存的列
• 列表

支持下载的...

• 获取文件报告
• 获取 ID 映射文件报告

本库结构

API 结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器反过来又允许访问单个 调用构建器
• 资源
  • 你可以应用 活动 的基本类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都带有可用的特性，以便进一步分类并简化浏览。

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

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

或者具体来说...

let r = hub.reports().generate(...).doit().await
let r = hub.reports().get(...).doit().await
let r = hub.reports().get_file(...).doit().await
let r = hub.reports().get_id_mapping_file(...).doit().await
let r = hub.reports().request(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_doubleclicksearch2 as doubleclicksearch2;
use doubleclicksearch2::{Result, Error};
use std::default::Default;
use doubleclicksearch2::{Doubleclicksearch, 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 = Doubleclicksearch::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.reports().get_file("reportId", -33)
             .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()方法的方式，在执行最终的doit()调用之前。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应重试。

默认实现了委托特质，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

• 通过复制传递POD结构
• 字符串作为&str传递
• 传递请求值

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

Cargo功能

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

许可证

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