该 google-dfareporting3d3 库允许访问 Google Dfareporting 服务所有功能。

此文档是从 Dfareporting crate 版本 5.0.5+20220104 生成的，其中 20220104 是由 mako 代码生成器 v5.0.5 构建的 dfareporting:v3.3 架构的确切修订版。

有关 Dfareporting v3d3 API 的其他信息，请参阅 官方文档网站。

功能

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

• 活跃广告摘要
• 获取
• 账户权限组
• 获取 和 列表
• 账户权限
• 获取 和 列表
• 账户用户配置文件
• 获取、插入、列表、修补 和 更新
• 账户
• 获取、列表、修补 和 更新
• 广告
• get，insert，list，patch 和 update
• 广告组
• delete，get，insert，list，patch 和 update
• 广告着陆页
• get，insert，list，patch 和 update
• 广告主
• get，insert，list，patch 和 update
• 浏览器
• 列表
• 活动创意关联
• insert 和 list
• 活动
• get，insert，list，patch 和 update
• 变更日志
• get 和 list
• 城市
• 列表
• 连接类型
• get 和 list
• 内容类别
• delete，get，insert，list，patch 和 update
• 转化
• batchinsert 和 batchupdate
• 国家
• 获取和列出
• 创意资产
• 插入
• 创意字段值
• 删除，获取，插入，列出，修补和更新
• 创意字段
• 删除，获取，插入，列出，修补和更新
• 创意组
• 获取，插入，列出，修补和更新
• 创意
• 获取，插入，列出，修补和更新
• 维度值
• 查询
• 目录站点
• 获取，插入和列出
• 动态定位键
• 删除，插入和列出
• 事件标签
• 删除，获取，插入，列出，修补和更新
• 文件
• 获取和列出
• 光晕活动
• 删除，生成标签，获取，插入，列表，部分更新和更新
• 灯泡活动组
• 获取，插入，列表，部分更新和更新
• 灯泡配置
• 获取，列表，部分更新和更新
• 库存项目
• 获取和列表
• 语言
• 列表
• 地铁站
• 列表
• 移动应用
• 获取和列表
• 移动运营商
• 获取和列表
• 操作系统版本
• 获取和列表
• 操作系统
• 获取和列表
• 订单文档
• 获取和列表
• 订单
• 获取和列表
• 放置组
• 获取，插入，列表，部分更新和更新
• 放置策略
• 删除，获取，插入，列表，修补和更新
• 位置
• 生成标签，获取，插入，列表，修补和更新
• 平台类型
• 获取和列表
• 邮政编码
• 获取和列表
• 项目
• 获取和列表
• 地区
• 列表
• 再营销列表共享
• 获取，修补和更新
• 再营销列表
• 获取，插入，列表，修补和更新
• 报告
• 兼容字段查询，删除，文件获取，文件列表，获取，插入，列表，修补，运行和更新
• 站点
• 获取，插入，列表，修补和更新
• 尺寸
• 获取、插入和列出
• 子账户
• 获取、插入、列出、修补和更新
• 可定位再营销列表
• 获取和列出
• 定位模板
• 获取、插入、列出、修补和更新
• 用户配置文件
• 获取和列出
• 用户角色权限组
• 获取和列出
• 用户角色权限
• 获取和列出
• 用户角色
• 删除、获取、插入、列出、修补和更新
• 视频格式
• 获取和列出

支持通过 ... 上传

• 插入创意资产

支持通过 ... 下载

• 获取文件
• 文件获取报告

本库结构

API结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态和允许访问所有活动
  • 创建方法构建器，这些构建器又允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于其中
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

所有 结构 都被标记上了相应的特性，以进一步分类并便于浏览。

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

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

或者具体来说...

let r = hub.reports().compatible_fields_query(...).doit().await
let r = hub.reports().files_get(...).doit().await
let r = hub.reports().files_list(...).doit().await
let r = hub.reports().delete(...).doit().await
let r = hub.reports().get(...).doit().await
let r = hub.reports().insert(...).doit().await
let r = hub.reports().list(...).doit().await
let r = hub.reports().patch(...).doit().await
let r = hub.reports().run(...).doit().await
let r = hub.reports().update(...).doit().await

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

用法

设置你的项目

要使用这个库，你需要在你的 Cargo.toml 文件中放入以下行

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting3d3 as dfareporting3d3;
use dfareporting3d3::{Result, Error};
use std::default::Default;
use dfareporting3d3::{Dfareporting, 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 = Dfareporting::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().files_list(-22, -33)
             .sort_order("no")
             .sort_field("ipsum")
             .page_token("voluptua.")
             .max_results(-27)
             .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 进行编码和解码而设计的。选项用于表示部分请求和响应是有效的。大多数选项都是被认为是可识别的 部分，它们可以通过名称识别，并将发送到服务器以指示请求的设置部分或所需的响应部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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