Lib.rs

›
#google-dfareporting #resources

google-dfareporting2d2

一个完整的库，用于与 dfareporting (协议 v2.2) 交互

由 Sebastian Thiel 和 以及 43 位贡献者 共同开发

14 个版本 (7 个稳定版)

使用旧的 Rust 2015

1.0.6+20160803 2017年9月24日
1.0.5+20160803 2017年5月26日
1.0.4+20160803 2017年2月4日
1.0.2+20160803 2016年12月27日
0.1.9+20150717 2015年10月19日


用于 google-dfareporting2d2-cl…

MIT 许可证

3MB
40K SLoC

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

本文档是根据 dfareporting crate 版本 1.0.6+20160803 生成的，其中 20160803 是由 mako 代码生成器 v1.0.6 构建的 dfareporting:v2.2 模式的确切修订版。

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

功能

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

支持通过 ... 上传

支持通过 ... 下载

本库结构

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-dfareporting2d2 = "*"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_dfareporting2d2 as dfareporting2d2;
use dfareporting2d2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dfareporting2d2::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 提供一个 delegate 来更改 doit() 方法调用的方式，在最终进行 doit() 调用之前。将调用相应的方法来提供进度信息，以及确定系统在失败时是否应该重试。

代理trait（delegate trait）默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受一个参数，以下陈述对此参数有效。

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

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

许可证

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

依赖项

~9–20MB
~320K SLoC