37 个版本 (稳定)
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.9+20150909 | 2015年10月19日 |
#2722 in 网络编程
每月下载量 2,151
在 google-adexchangebuyer1d4… 中使用
715KB
9K SLoC
google-adexchangebuyer1d4
库允许访问 Google 广告交易所买家服务(v1.4)的所有功能。
本文档是从 广告交易所买家 crate 版本 5.0.5+20210330 生成的,其中 20210330 是由 mako 代码生成器 v5.0.5 构建的 adexchangebuyer:v1.4 方案的精确修订版本。
有关 广告交易所买家 v1d4 API 的其他所有信息,请参阅 官方文档网站。
功能
从中心 枢纽 轻松处理以下 资源...
- 账户
- 获取、列表、修补 和 更新
- 计费信息
- 获取 和 列表
- 预算
- 获取、修补 和 更新
- 创意
- 添加交易,获取,插入,列表,列出交易和删除交易
- marketplacedeals
- 删除,插入,列表和更新
- marketplacenotes
- 插入和列表
- marketplaceprivateauction
- updateproposal
- 性能报告
- 列表
- 预定向配置
- 删除,获取,插入,列表,修补和更新
- 产品
- 获取和搜索
- 提案
- 获取,插入,修补,搜索,设置完成和更新
- pubprofiles
- 列表
本库的结构
API被组织成以下主要项目
所有结构都标记了适用的特质,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或者具体来说...
let r = hub.creatives().add_deal(...).doit().await
let r = hub.creatives().get(...).doit().await
let r = hub.creatives().insert(...).doit().await
let r = hub.creatives().list(...).doit().await
let r = hub.creatives().list_deals(...).doit().await
let r = hub.creatives().remove_deal(...).doit().await
资源 resource()
和活动 activity(...)
调用创建了 构建器。后者处理 Activities
,支持各种配置即将进行的操作(此处未展示)的方法。它设计得使得所有必需的参数都必须立即指定(即 (...)
),而所有可选参数则可以按需 构建。方法 doit()
执行与服务器实际通信并返回相应结果。
使用方法
设置您的项目
要使用这个库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-adexchangebuyer1d4 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_adexchangebuyer1d4 as adexchangebuyer1d4;
use adexchangebuyer1d4::{Result, Error};
use std::default::Default;
use adexchangebuyer1d4::{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);
// 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.creatives().list()
.page_token("et")
.open_auction_status_filter("magna")
.max_results(90)
.deals_status_filter("ipsum")
.add_buyer_creative_id("voluptua.")
.add_account_id(-27)
.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")
。
支持上传的方法可以使用多达 2 种不同的协议:简单 和 可恢复。每种的独特性由定制的 doit(...)
方法表示,分别命名为 upload(...)
和 upload_resumable(...)
。
自定义和回调
您可以通过向 Method Builder 提供一个 代理 来改变 doit()
方法的调用方式,在执行最终的 doit()
调用之前。相应的方
默认实现了 委托特质,允许您以最少的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过 json 进行编码和解码,以实现 请求值 和 响应结果。可选部分用于表示部分请求或响应是有效的。大多数可选部分被认为是 部分,可以通过名称识别,这些部分将发送到服务器以指示请求的设置部分或期望的响应部分。
构建器参数
通过使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对它适用。
参数将被复制或克隆到构建器中,以使其与其原始的生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
adexchangebuyer1d4 库由 Sebastian Thiel 生成,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–23MB
~343K SLoC