Lib.rs

›
#dfareporting

google-dfareporting2d7

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

由 Sebastian Thiel 和 48 位贡献者 编写

9 个稳定版本

使用旧的 Rust 2015

1.0.6+20170818 2017年9月27日
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日

#18 in #dfareporting

Download history 50/week @ 2024-03-29 14/week @ 2024-04-05 1/week @ 2024-05-17 47/week @ 2024-06-21 5/week @ 2024-06-28 18/week @ 2024-07-05

70 每月下载量
在 google-dfareporting2d7-cli 中使用

MIT 许可证

3.5MB
42K SLoC

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

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

有关 dfareporting v2d7 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-dfareporting2d7 = "*"

一个完整的示例

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

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

依赖关系

~8–19MB
~302K SLoC