google-admob1 库允许访问 Google AdMob 服务所有功能。

本文档是从 AdMob 包版本 5.0.5+20240626 生成的，其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 admob:v1 架构的确切修订版。

有关 AdMob v1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 账户
• 广告单元列表、应用列表、获取、列表、中介报告生成 和 网络报告生成

库的结构

API 结构如下主要项目

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

所有 结构 都用可适用的特质标记，以进一步分类它们并便于浏览。

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

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

或者具体来说...

let r = hub.accounts().get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_admob1 as admob1;
use admob1::{Result, Error};
use std::default::Default;
use admob1::{AdMob, 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 = AdMob::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().get("name")
             .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() 之前向 Method Builder 提供一个 代理 来更改 doit() 方法被调用的方式。将调用相应的方法以提供进度信息，并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器（method builders），您可以重复调用其方法来准备一个操作调用。这些方法始终只接受一个参数，以下陈述适用于这些参数。

• POD（原始数据结构） 通过复制传递
• 字符串作为 &str 传递
• 请求值 被移动

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

Cargo 特性

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

许可证

admob1 库由 Sebastian Thiel 创建，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读完整内容。