google-dfareporting2d1 库允许访问Google dfareporting服务的所有功能。

本文档是从 dfareporting crate版本 1.0.6+20160323 生成的，其中 20160323 是由mako 代码生成器 v1.0.6 构建的dfareporting:v2.1架构的确切修订版。

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

特性

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

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

支持上传的...

• 插入创意资产

支持下载的...

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

此库的结构

API结构如下主要项

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

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

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

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

或者更具体...

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

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

用法

设置您的项目

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

[dependencies]
google-dfareporting2d1 = "*"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_dfareporting2d1 as dfareporting2d1;
use dfareporting2d1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dfareporting2d1::Dfareporting;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Dfareporting::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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().list("profileId")
             .sort_order("sit")
             .sort_field("Stet")
             .scope("sed")
             .page_token("et")
             .max_results(-18)
             .doit();

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::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提供委托来更改doit方法被调用的方式，在执行最终的doit调用之前。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

委托特质默认实现，允许您以最小的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下语句对其成立。

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

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

许可证

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