#dfareporting #google-api #google

google-dfareporting3

一个完整的库,用于与dfareporting(协议v3.0)交互

20个稳定版本 (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.7+20171109 2017年12月12日

#306网络编程

Download history 85/week @ 2024-06-23 29/week @ 2024-06-30

1,233 每月下载量
用于 google-dfareporting3-cli

MIT 许可证

3.5MB
43K SLoC

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

本文档是从dfareporting crate版本5.0.5+20180830生成的,其中20180830mako代码生成器v5.0.5构建的dfareporting:v3.0模式的精确修订。

有关dfareporting v3 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)的调用创建了构建器。第二个处理Activities的调用支持配置即将进行的操作的各种方法(此处未展示)。它的设计使得所有必需的参数都必须立即指定(即(...)),而所有可选的都可以根据需要构建doit()方法执行与服务器的实际通信并返回相应的结果。

用法

设置你的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting3 as dfareporting3;
use dfareporting3::{Result, Error};
use std::default::Default;
use dfareporting3::{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 DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器,你可以通过重复调用它的方法来准备一个动作调用。这些方法始终接受单个参数,以下陈述是正确的。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC