Lib.rs

› 网络编程
#dfareporting #google-api

nightly google-dfareporting2

用于与 dfareporting (协议 v2.0) 交互的完整库

由 Sebastian Thiel 和 45 位贡献者 编写

6 个版本

使用旧的 Rust 2015

0.1.5+20150326 2015年4月9日
0.1.4+20150326 2015年4月7日
0.1.2+20150223 2015年3月25日

在 #dfareporting 中排名 27

每月下载量 27

MIT 许可证

2.5MB
32K SLoC

google-dfareporting2 库允许访问 Google dfareporting 服务（v2.0 协议）的所有功能。

本文档是从 dfareporting crate 版本 0.1.5+20150326 生成的，其中 20150326 是由 mako 代码生成器 v0.1.5 构建的 dfareporting:v2.0 架构的确切修订版。

有关 dfareporting v2 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-dfareporting2 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_dfareporting2 as dfareporting2;
use dfareporting2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dfareporting2::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::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Dfareporting::new(hyper::Client::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 {
        Error::HttpError(err) => println!("HTTPERROR: {:?}", err),
        Error::MissingAPIKey => println!("Auth: Missing API Key - used if there are no scopes"),
        Error::MissingToken => println!("OAuth2: Missing Token"),
        Error::Cancelled => println!("Operation canceled by user"),
        Error::UploadSizeLimitExceeded(size, max_size) => println!("Upload size too big: {} of {}", size, max_size),
        Error::Failure(_) => println!("General Failure (hyper::client::Response doesn't print)"),
        Error::FieldClash(clashed_field) => println!("You added custom parameter which is part of builder: {:?}", clashed_field),
        Error::JsonDecodeError(err) => println!("Couldn't understand server reply - maybe API needs update: {:?}", err),
    },
    Ok(_) => println!("Success (value doesn't print)"),
}

处理错误

系统产生的所有错误都提供为Result枚举，作为doit()方法的返回值，或者作为可能的中继结果传递给Hub Delegate，或者Authenticator Delegate。

当委托处理错误或中继值时，它们有机会指导系统重试。这使得系统对各种错误具有潜在的鲁棒性。

上传和下载

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

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

定制和回调

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

默认实现了delegate trait，这使得您可以轻松地对其进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

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

依赖项

~18–29MB
~558K SLoC