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

此文档是从 Dfareporting 包版本 5.0.5+20230118 生成的，其中 20230118 是由 mako 代码生成器 v5.0.5 构建的 dfareporting:v3.4 模式的确切修订版本。

有关 Dfareporting v3d4 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
• 国家
• get和list
• 创意资产
• 插入
• 创意字段值
• 删除，获取，插入，列出，修补和更新
• 创意字段
• 删除，获取，插入，列出，修补和更新
• 创意组
• 获取，插入，列出，修补和更新
• 创意
• 获取，插入，列出，修补和更新
• 自定义事件
• 批量插入
• 维度值
• 查询
• 目录网站
• 获取，插入和列出
• 动态定向键
• 删除，插入和列出
• 事件标签
• 删除，获取，插入，列出，修补和更新
• 文件
• 获取和列出
• 光晕活动
• 删除，生成标签，获取，插入，列出，修补和更新
• 光束活动组
• 获取，插入，列出，修补和更新
• 光束配置
• 获取，列出，修补和更新
• 库存项目
• 获取和列出
• 语言
• 列表
• 地铁
• 列表
• 移动应用
• 获取和列出
• 移动运营商
• 获取和列出
• 操作系统版本
• 获取和列出
• 操作系统
• 获取和列出
• 订单文档
• 获取和列出
• 订单
• 获取和列出
• 放置组
• 获取，插入，列出，修补和更新
• 放置策略
• 删除，获取，插入，列出，修补和更新
• 投放
• 生成标签，获取，插入，列出，修补和更新
• 平台类型
• 获取和列出
• 邮政编码
• 获取和列出
• 项目
• 获取和列出
• 地区
• 列表
• 再营销列表共享
• 获取，修补和更新
• 再营销列表
• 获取，插入，列出，修补和更新
• 报告
• 兼容字段查询，删除，文件获取，文件列出，获取，插入，列出，修补，运行和更新
• 网站
• 获取，插入，列出，修补和更新
• 尺寸
• get，insert和list
• 子账户
• get，insert，list，patch和update
• 可投放的再营销名单
• get和list
• 定向模板
• get，insert，list，patch和update
• 用户资料
• get和list
• 用户角色权限组
• get和list
• 用户角色权限
• get和list
• 用户角色
• delete，get，insert，list，patch和update
• 视频格式
• get和list

支持上传的...

• 插入创意资产

支持下载的...

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

本库的结构

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-dfareporting3d4 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting3d4 as dfareporting3d4;
use dfareporting3d4::{Result, Error};
use std::default::Default;
use dfareporting3d4::{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枚举的返回值提供，或者作为可能的中途结果传递给Hub Delegate或Authenticator Delegate。

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

上传和下载

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

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

定制和回调

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

委托特质（delegate trait）具有默认实现，让您可以以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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