google-adsense1d4 库允许访问 Google AdSense 服务所有功能。

本文档是从 AdSense crate 版本 5.0.5+20201002 生成的，其中 20201002 是由 mako 代码生成器 v5.0.5 构建的 adsense:v1.4 架构的确切修订版。

有关 AdSense v1d4 API 的其他信息，请参阅 官方文档站点。

功能

从中央 中心 简单地处理以下 资源 ...

• 帐户
• 获取广告代码，广告客户端列表，广告单元自定义渠道列表，获取广告单元，获取广告代码，广告单元列表，删除警报，警报列表，自定义渠道广告单元列表，获取自定义渠道，自定义渠道列表，获取，列表，支付列表，生成报告，已保存报告生成，已保存报告列表，获取已保存广告样式，已保存广告样式列表以及URL渠道列表
• 广告客户端
• 列表
• 广告单元
• 自定义渠道列表，获取，获取广告代码以及列表
• 警报
• 删除以及列表
• 自定义渠道
• 广告单元列表，获取以及列表
• 元数据
• 维度列表以及度量列表
• 支付
• 列表
• 报告
• 生成，已保存生成以及已保存列表
• 已保存广告样式
• 获取以及列表
• URL渠道
• 列表

支持由 ... 下载

• 生成账户报告
• 生成报告

本库结构

API 结构如下主要项

• 中心
  • 一个中心对象，用于维护状态和访问所有 活动
  • 创建 方法构建器，这些构建器反过来允许访问单个 调用构建器
• 资源
  • 你可以将 活动 应用到的主要类型
  • 属性和 部分 的集合
  • 部分
    • 属性集合
    • 在 活动 中 never 直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或者具体来说...

let r = hub.accounts().adclients_get_ad_code(...).doit().await
let r = hub.accounts().adclients_list(...).doit().await
let r = hub.accounts().adunits_customchannels_list(...).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_list(...).doit().await
let r = hub.accounts().alerts_delete(...).doit().await
let r = hub.accounts().alerts_list(...).doit().await
let r = hub.accounts().customchannels_adunits_list(...).doit().await
let r = hub.accounts().customchannels_get(...).doit().await
let r = hub.accounts().customchannels_list(...).doit().await
let r = hub.accounts().payments_list(...).doit().await
let r = hub.accounts().reports_saved_generate(...).doit().await
let r = hub.accounts().reports_saved_list(...).doit().await
let r = hub.accounts().reports_generate(...).doit().await
let r = hub.accounts().savedadstyles_get(...).doit().await
let r = hub.accounts().savedadstyles_list(...).doit().await
let r = hub.accounts().urlchannels_list(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adsense1d4 as adsense1d4;
use adsense1d4::{Result, Error};
use std::default::Default;
use adsense1d4::{AdSense, 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 = AdSense::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")
             .use_timezone_reporting(true)
             .start_index(-28)
             .add_sort("At")
             .add_metric("sanctus")
             .max_results(-80)
             .locale("amet.")
             .add_filter("takimata")
             .add_dimension("amet.")
             .currency("duo")
             .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()方法之前修改其调用方式。相应的函数将被调用以提供进度信息，以及确定系统在失败时应否重试。

代理特质默认实现，您只需付出最少努力即可自定义它。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可

adsense1d4库由Sebastian Thiel生成，并置于MIT许可下。您可以在存储库的许可文件中阅读全文。