#google-api #google #web-api #protocols #api #ad-exchange-buyer #web

google-adexchangebuyer1d3

一个完整的库,用于与广告交易平台买家(协议版本1.3)交互

47个版本 (29个稳定版本)

5.0.5+20210330 2024年6月27日
5.0.4+20210330 2024年3月5日
5.0.3+20210330 2023年8月23日
5.0.2+20210330 2023年3月16日
0.1.2+20150218 2015年3月25日

#2821 in 网页编程

Download history 86/week @ 2024-06-23 14/week @ 2024-06-30

每月下载量2,745
用于 google-adexchangebuyer1d3…

MIT 许可证

410KB
5.5K SLoC

google-adexchangebuyer1d3 库允许访问 Google Ad Exchange Buyer 服务的所有功能。

本文档是从 Ad Exchange Buyer 包版本 5.0.5+20210330 生成的,其中 20210330 是由 mako 代码生成器 v5.0.5 构建的 adexchangebuyer:v1.3 方案的精确修订。

有关 Ad Exchange Buyer v1d3 API 的其他信息,请参阅 官方文档网站

功能

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

本库结构

API结构如下主要项目

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

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

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

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

或者具体...

let r = hub.pretargeting_config().get(...).doit().await
let r = hub.pretargeting_config().insert(...).doit().await
let r = hub.pretargeting_config().patch(...).doit().await
let r = hub.pretargeting_config().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adexchangebuyer1d3 as adexchangebuyer1d3;
use adexchangebuyer1d3::api::PretargetingConfig;
use adexchangebuyer1d3::{Result, Error};
use std::default::Default;
use adexchangebuyer1d3::{AdExchangeBuyer, 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 = AdExchangeBuyer::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = PretargetingConfig::default();

// 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.pretargeting_config().patch(req, -22, -33)
             .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

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

上传和下载

如果一种方法支持下载,那么作为结果的组成部分,响应体应该由您读取以获取媒体。如果该方法还支持响应结果,它将默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您需要通过以下调用设置构建器:.param("alt", "media")

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

自定义和回调

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

代理特质具有默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

  • utoipa - 添加对 utoipa 的支持,并自动为所有类型生成 utoipa::ToSchema。您需要将所需类型导入并注册到 #[openapi(schemas(...))],否则生成的 openapi 规范将是无效的。

许可证

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

依赖项

~12–23MB
~346K SLoC