Lib.rs

›
#dfareporting

google-dfareporting2d6

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

由 Sebastian Thiel 和 48 位贡献者

9 个稳定版本

使用旧的 Rust 2015

1.0.6+20170428 2017 年 9 月 24 日
1.0.5+20170428 2017 年 5 月 26 日
1.0.4+20161027 2017 年 2 月 4 日
1.0.2+20161027 2016 年 12 月 27 日
0.1.15+20160803 2016 年 9 月 11 日

#17 in #dfareporting

35 每月下载量
用于 google-dfareporting2d6-cl…

MIT 许可证

3.5MB
42K SLoC

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

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

有关 dfareporting v2d6 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(...) 调用创建 构建器。第二个处理 活动 的构建器支持各种方法来配置即将进行的操作（此处未显示）。它设计成必须立即指定所有必需的参数（即 (...)），而所有可选的参数都可以按需 构建。doit() 方法执行与服务器的实际通信，并返回相应的结果。

用法

设置项目

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

[dependencies]
google-dfareporting2d6 = "*"

完整示例

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

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

依赖项

~8–19MB
~303K SLoC