google-realtimebidding1 库允许访问 Google 实时竞价 服务的所有功能。

本文档由 实时竞价 库版本 5.0.5+20240625 生成，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 realtimebidding:v1 架构的确切修订版本。

有关实时竞价 v1 API 的其他信息，请参阅 官方文档网站。

功能

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

• 出价者
• 创意列表，创意监控，端点获取，端点列表，端点修补，获取，列表，预定位配置激活，预定位配置添加目标应用，预定位配置添加目标发布者，预定位配置添加目标网站，预定位配置创建，预定位配置删除，预定位配置获取，预定位配置列表，预定位配置修补，预定位配置移除目标应用，预定位配置移除目标发布者，预定位配置移除目标网站，预定位配置暂停，发布者连接批量批准，发布者连接批量拒绝，发布者连接获取 和 发布者连接列表
• 买家
• 创建创意，获取创意，创意列表，创意修补，获取，获取重定向标签，列表，关闭用户列表，创建用户列表，获取用户列表，获取用户列表重定向标签，用户列表列表，打开用户列表 和 更新用户列表

本库的结构

API 结构如下主要项目

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

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

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

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

或者具体...

let r = hub.bidders().creatives_list(...).doit().await
let r = hub.bidders().creatives_watch(...).doit().await
let r = hub.bidders().endpoints_get(...).doit().await
let r = hub.bidders().endpoints_list(...).doit().await
let r = hub.bidders().endpoints_patch(...).doit().await
let r = hub.bidders().pretargeting_configs_activate(...).doit().await
let r = hub.bidders().pretargeting_configs_add_targeted_apps(...).doit().await
let r = hub.bidders().pretargeting_configs_add_targeted_publishers(...).doit().await
let r = hub.bidders().pretargeting_configs_add_targeted_sites(...).doit().await
let r = hub.bidders().pretargeting_configs_create(...).doit().await
let r = hub.bidders().pretargeting_configs_delete(...).doit().await
let r = hub.bidders().pretargeting_configs_get(...).doit().await
let r = hub.bidders().pretargeting_configs_list(...).doit().await
let r = hub.bidders().pretargeting_configs_patch(...).doit().await
let r = hub.bidders().pretargeting_configs_remove_targeted_apps(...).doit().await
let r = hub.bidders().pretargeting_configs_remove_targeted_publishers(...).doit().await
let r = hub.bidders().pretargeting_configs_remove_targeted_sites(...).doit().await
let r = hub.bidders().pretargeting_configs_suspend(...).doit().await
let r = hub.bidders().publisher_connections_batch_approve(...).doit().await
let r = hub.bidders().publisher_connections_batch_reject(...).doit().await
let r = hub.bidders().publisher_connections_get(...).doit().await
let r = hub.bidders().publisher_connections_list(...).doit().await
let r = hub.bidders().get(...).doit().await
let r = hub.bidders().list(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_realtimebidding1 as realtimebidding1;
use realtimebidding1::{Result, Error};
use std::default::Default;
use realtimebidding1::{RealTimeBidding, 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 = RealTimeBidding::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.bidders().creatives_list("parent")
             .view("magna")
             .page_token("no")
             .page_size(-55)
             .filter("voluptua.")
             .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 枚举的返回值提供，或者作为可能的中间结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，它们可能有机会指示系统重试。这使得系统对各种错误具有潜在的鲁棒性。

上传和下载

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

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

定制和回调

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

默认实现了代理特质，让您可以轻松地对其进行定制。

服务器请求中的可选部分

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

构建器参数

通过方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法将始终接受单个参数，以下语句对它适用。

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

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

Cargo功能

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

许可证

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