Lib.rs

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

google-dfareporting2d8

与 dfareporting (协议 v2.8) 交互的完整库

由 Sebastian Thiel 和 48 位贡献者 开发

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

5.0.5+20180830 2024 年 6 月 27 日
5.0.4+20180830 2024 年 3 月 5 日
5.0.3+20180830 2023 年 8 月 23 日
5.0.2+20180830 2023 年 3 月 16 日
1.0.6+20170818 2017 年 9 月 27 日

#2157 在 网络编程

Download history 3/week @ 2024-04-07 1/week @ 2024-05-19 88/week @ 2024-06-23 88/week @ 2024-06-30

95 每月下载
用于 google-dfareporting2d8-cl…

MIT 许可证

3.5MB
43K SLoC

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

此文档是从 dfareporting crate 版本 5.0.5+20180830 生成的，其中 20180830 是由 mako 代码生成器 v5.0.5 构建的 dfareporting:v2.8 方案的精确修订。

有关 dfareporting v2d8 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

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

用法

设置您的项目

要使用此库，您需要在您的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting2d8 as dfareporting2d8;
use dfareporting2d8::{Result, Error};
use std::default::Default;
use dfareporting2d8::{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")。

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下语句对此适用。

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~344K SLoC