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

此文档是从 adsense 集装箱版本 5.0.5+20240626 生成的，其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 adsense:v2 架构的确切修订版。

关于 adsense v2 API 的其他所有信息都可以在 官方文档站点 找到。

特性

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

• 账户
• 创建广告客户单元，获取广告客户单元，获取广告客户单元广告代码，列出广告客户单元，列出关联的自定义频道广告客户单元，修补广告客户单元，创建广告客户自定义频道，删除广告客户自定义频道，获取广告客户自定义频道，列出广告客户自定义频道，列出关联的广告单元自定义频道，修补广告客户自定义频道，获取广告客户，获取广告客户广告代码，列出广告客户，获取广告客户URL频道，列出广告客户URL频道，列出警报，获取，获取广告拦截恢复标签，列出，列出子账户，列出支付，获取政策问题，列出政策问题，生成报告，生成CSV报告，获取已保存的报告，生成已保存的报告，生成已保存的CSV报告，列出已保存的报告，获取网站和列出网站

本库的结构

API结构为以下主要项目

• 枢纽
  • 一个中央对象，用于维护状态和允许访问所有活动
  • 创建方法构建器，这反过来又允许访问单个调用构建器
• 资源
  • 可以应用活动的主要类型
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 从不直接用于活动
• 活动
  • 应用于资源的操作

所有结构都被标记了相应的特性，以进一步分类它们并简化浏览。

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

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

或者具体来说...

let r = hub.accounts().adclients_adunits_create(...).doit().await
let r = hub.accounts().adclients_adunits_get(...).doit().await
let r = hub.accounts().adclients_adunits_get_adcode(...).doit().await
let r = hub.accounts().adclients_adunits_list(...).doit().await
let r = hub.accounts().adclients_adunits_list_linked_custom_channels(...).doit().await
let r = hub.accounts().adclients_adunits_patch(...).doit().await
let r = hub.accounts().adclients_customchannels_create(...).doit().await
let r = hub.accounts().adclients_customchannels_delete(...).doit().await
let r = hub.accounts().adclients_customchannels_get(...).doit().await
let r = hub.accounts().adclients_customchannels_list(...).doit().await
let r = hub.accounts().adclients_customchannels_list_linked_ad_units(...).doit().await
let r = hub.accounts().adclients_customchannels_patch(...).doit().await
let r = hub.accounts().adclients_urlchannels_get(...).doit().await
let r = hub.accounts().adclients_urlchannels_list(...).doit().await
let r = hub.accounts().adclients_get(...).doit().await
let r = hub.accounts().adclients_get_adcode(...).doit().await
let r = hub.accounts().adclients_list(...).doit().await
let r = hub.accounts().alerts_list(...).doit().await
let r = hub.accounts().payments_list(...).doit().await
let r = hub.accounts().policy_issues_get(...).doit().await
let r = hub.accounts().policy_issues_list(...).doit().await
let r = hub.accounts().reports_saved_generate(...).doit().await
let r = hub.accounts().reports_saved_generate_csv(...).doit().await
let r = hub.accounts().reports_saved_list(...).doit().await
let r = hub.accounts().reports_generate(...).doit().await
let r = hub.accounts().reports_generate_csv(...).doit().await
let r = hub.accounts().reports_get_saved(...).doit().await
let r = hub.accounts().sites_get(...).doit().await
let r = hub.accounts().sites_list(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().get_ad_blocking_recovery_tag(...).doit().await
let r = hub.accounts().list(...).doit().await
let r = hub.accounts().list_child_accounts(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adsense2 as adsense2;
use adsense2::{Result, Error};
use std::default::Default;
use adsense2::{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("account")
             .start_date_year(-33)
             .start_date_month(-11)
             .start_date_day(-55)
             .reporting_time_zone("voluptua.")
             .add_order_by("At")
             .add_metrics("sanctus")
             .limit(-80)
             .language_code("amet.")
             .add_filters("takimata")
             .end_date_year(-52)
             .end_date_month(-20)
             .end_date_day(-55)
             .add_dimensions("gubergren")
             .date_range("Lorem")
             .currency_code("gubergren")
             .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),
}

处理错误

系统产生的所有错误都作为(...)枚举值提供，作为doit()方法的返回值，或者作为可能的中级结果传递给(...)、Authenticator Delegate。

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

上传和下载

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

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

定制和回调

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

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

许可证

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