#google #protocols #google-api #web #adexchangebuyer2

google-adexchangebuyer2_v2_beta1

与AdExchangeBuyerII(协议v2beta1)交互的完整库

19个稳定版本 (4个主要版本)

5.0.5+20240625 2024年6月27日
5.0.4+20240305 2024年3月5日
5.0.3+20230124 2023年8月23日
5.0.2+20230124 2023年3月16日
1.0.7+20171208 2018年2月1日

#1104 in 身份验证

Download history 81/week @ 2024-06-22 19/week @ 2024-06-29 30/week @ 2024-07-06

1,168 每月下载次数
用于google-adexchangebuyer2_v…

MIT 许可证

1.5MB
16K SLoC

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

本文档是从AdExchangeBuyerII版本5.0.5+20240625生成的,其中20240625mako代码生成器v5.0.5构建的adexchangebuyer2:v2beta1架构的确切修订。

关于AdExchangeBuyerII v2_beta1 API的其他所有信息,请参阅官方文档网站

功能

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

库结构

API 结构如下主要项

  • 中心
  • 资源
    • 可以应用 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 活动 中永远不会直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用特性和易于浏览。

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

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

或者具体...

let r = hub.buyers().filter_sets_bid_metrics_list(...).doit().await
let r = hub.buyers().filter_sets_bid_response_errors_list(...).doit().await
let r = hub.buyers().filter_sets_bid_responses_without_bids_list(...).doit().await
let r = hub.buyers().filter_sets_filtered_bid_requests_list(...).doit().await
let r = hub.buyers().filter_sets_filtered_bids_creatives_list(...).doit().await
let r = hub.buyers().filter_sets_filtered_bids_details_list(...).doit().await
let r = hub.buyers().filter_sets_filtered_bids_list(...).doit().await
let r = hub.buyers().filter_sets_impression_metrics_list(...).doit().await
let r = hub.buyers().filter_sets_losing_bids_list(...).doit().await
let r = hub.buyers().filter_sets_non_billable_winning_bids_list(...).doit().await
let r = hub.buyers().filter_sets_create(...).doit().await
let r = hub.buyers().filter_sets_delete(...).doit().await
let r = hub.buyers().filter_sets_get(...).doit().await
let r = hub.buyers().filter_sets_list(...).doit().await

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

使用

设置您的项目

要使用此库,您需要在您的 Cargo.toml 文件中添加以下行

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

一个完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adexchangebuyer2_v2_beta1 as adexchangebuyer2_v2_beta1;
use adexchangebuyer2_v2_beta1::{Result, Error};
use std::default::Default;
use adexchangebuyer2_v2_beta1::{AdExchangeBuyerII, 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 = AdExchangeBuyerII::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.buyers().filter_sets_filtered_bids_creatives_list("filterSetName", -33)
             .page_token("no")
             .page_size(-55)
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用最多两种协议: 简单可重试。每种协议的独特性由定制的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

自定义和回调

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

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

服务器请求中的可选部分

此库提供的所有结构都设计成可以通过 json 进行 编码解码。可选部分用于指示部分请求或响应是有效的。大多数可选部分被认为是 Parts,可以通过名称识别,这些部分将被发送到服务器,以指示请求的设置部分或所需的响应部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC