Lib.rs

› 网络编程
#dfareporting #google-api #google

google-dfareporting3d2

一个用于与dfareporting（协议v3.2）交互的完整库

由 Sebastian Thiel 和 48位贡献者 编写

18个稳定版本 (4个主要版本)

5.0.5+20190531 2024年6月27日
5.0.4+20190531 2024年3月5日
5.0.3+20190531 2023年8月23日
5.0.2+20190531 2023年3月16日
1.0.8+20180830 2018年10月14日

#1158 in 网络编程

Download history 1/week @ 2024-05-18 1/week @ 2024-05-25 79/week @ 2024-06-22 12/week @ 2024-06-29

每月1,136次下载
用于 google-dfareporting3d2-cl…

MIT 许可证

3.5MB
44K SLoC

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

此文档是从dfareporting包版本5.0.5+20190531生成的，其中20190531是mako代码生成器v5.0.5构建的dfareporting:v3.2架构的确切修订版。

有关dfareporting v3d2 API的所有其他信息，请参阅官方文档网站。

功能

从中央枢纽轻松处理以下资源...

由...支持的上传

由...支持的下载

本库的结构

API结构如下主要项

  • 中心
  • 资源
    • 主要类型，可以将活动应用于这些类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 在活动中从未直接使用
  • 活动
    • 应用于资源的操作

所有结构都带有适用的特性，以进一步分类它们并便于浏览。

一般来说，您可以这样调用活动

let r = hub.resource().activity(...).doit().await

或者具体来说...

let r = hub.reports().compatible_fields_query(...).doit().await
let r = hub.reports().files_get(...).doit().await
let r = hub.reports().files_list(...).doit().await
let r = hub.reports().delete(...).doit().await
let r = hub.reports().get(...).doit().await
let r = hub.reports().insert(...).doit().await
let r = hub.reports().list(...).doit().await
let r = hub.reports().patch(...).doit().await
let r = hub.reports().run(...).doit().await
let r = hub.reports().update(...).doit().await

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

用法

设置你的项目

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

[dependencies]
google-dfareporting3d2 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting3d2 as dfareporting3d2;
use dfareporting3d2::{Result, Error};
use std::default::Default;
use dfareporting3d2::{Dfareporting, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::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 = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Dfareporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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().files_list(-22, -33)
             .sort_order("no")
             .sort_field("ipsum")
             .page_token("voluptua.")
             .max_results(-27)
             .doit().await;

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::Io(_)
        |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(...)。

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

  • utoipa - 添加对 utoipa 的支持，并在所有类型上派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型，否则生成的 openapi 规范将是无效的。

许可证

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

依赖项

~12–23MB
~343K SLoC