Lib.rs

›
#dfareporting

google-dfareporting2d4

一个完整的库，用于与 dfareporting（协议 v2.4）交互

由 Sebastian Thiel 和 以及 48 位贡献者 开发

11 个版本 (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.13+20160323 2016年4月10日

#15 in #dfareporting


用于 google-dfareporting2d4-cli…

MIT 许可证

3MB
40K SLoC

该 google-dfareporting2d4 库允许访问 Google dfareporting 服务（v2.4）的所有功能。

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

有关 dfareporting v2d4 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-dfareporting2d4 = "*"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_dfareporting2d4 as dfareporting2d4;
use dfareporting2d4::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dfareporting2d4::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")。

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

定制和回调

您可以通过向 Method Builder 提供一个 delegate 来更改 doit() 方法的调用方式，在最终进行 doit() 调用之前。将调用相应的方法以提供进度信息，并确定系统在失败时应否重试。

delegate trait 默认实现，允许您以最小的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个动作调用。这些方法总是接受单个参数，以下陈述适用于这些参数。

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

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

许可证

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

依赖关系

~8–19MB
~303K SLoC