#google #google-api #protocols #web #web-api #api #adsense-host

google-adsensehost4d1

一个完整的库,用于与 AdSense Host (协议版本 4.1) 交互

48 个版本 (30 个稳定版)

5.0.5+20200930 2024 年 6 月 27 日
5.0.4+20200930 2024 年 3 月 5 日
5.0.3+20200930 2023 年 8 月 23 日
5.0.2+20200930 2023 年 3 月 16 日
0.1.2+20150309 2015 年 3 月 25 日

#2898 in 网页编程


用于 google-adsensehost4d1-cli

MIT 许可证

475KB
6K SLoC

google-adsensehost4d1 库允许访问 Google AdSense Host 服务(协议版本 4.1)的所有功能。

此文档是从 AdSense Host 包版本 5.0.5+20200930 生成的,其中 20200930 是由 mako 代码生成器 v5.0.5 构建的 adsensehost:v4.1 架构的确切修订版。

有关 AdSense Host v4d1 API 的其他信息,请参阅 官方文档网站

功能

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

本库结构

API 结构如下主要项

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

所有 结构 都用适用特性标记,以便进一步分类并便于浏览。

一般来说,你可以这样调用 活动

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

或者具体...

let r = hub.accounts().adclients_get(...).doit().await
let r = hub.accounts().adclients_list(...).doit().await
let r = hub.accounts().adunits_delete(...).doit().await
let r = hub.accounts().adunits_get(...).doit().await
let r = hub.accounts().adunits_get_ad_code(...).doit().await
let r = hub.accounts().adunits_insert(...).doit().await
let r = hub.accounts().adunits_list(...).doit().await
let r = hub.accounts().adunits_patch(...).doit().await
let r = hub.accounts().adunits_update(...).doit().await
let r = hub.accounts().reports_generate(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().list(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adsensehost4d1 as adsensehost4d1;
use adsensehost4d1::{Result, Error};
use std::default::Default;
use adsensehost4d1::{AdSenseHost, 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 = AdSenseHost::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.accounts().reports_generate("accountId", "startDate", "endDate")
             .start_index(46)
             .add_sort("voluptua.")
             .add_metric("At")
             .max_results(93)
             .locale("sed")
             .add_filter("amet.")
             .add_dimension("takimata")
             .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(...)

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

Cargo功能

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

许可证

adsensehost4d1 库由 Sebastian Thiel 编写,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。

依赖项

~12–23MB
~346K SLoC