#dfareporting

google-dfareporting2d5

一个与 dfareporting (协议 v2.5) 交互的完整库

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 日

#16 in #dfareporting


用于 google-dfareporting2d5-cl…

MIT 许可证

3MB
40K SLoC

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

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

有关 dfareporting v2d5 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-dfareporting2d5 = "*"

一个完整的示例

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

处理错误

系统产生的所有错误都作为(...)方法的返回值提供的(...)枚举,或者作为可能的中级结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

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

代理特质默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述适用于此参数。

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

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

许可证

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

依赖关系

~8–19MB
~305K SLoC