#google-api #google #protocols #api #web-api #web #doubleclickbidmanage

google-doubleclickbidmanager1

与 DoubleClick Bid Manager(协议 v1)交互的完整库

45 个版本 (29 个稳定版)

5.0.5+20210323 2024 年 6 月 27 日
5.0.4+20210323 2024 年 3 月 5 日
5.0.3+20210323 2023 年 8 月 23 日
5.0.2+20210323 2023 年 3 月 16 日
0.1.8+20150326 2015 年 6 月 19 日

1902网页编程

Download history 6/week @ 2024-05-19 87/week @ 2024-06-23 41/week @ 2024-06-30

2,622 每月下载量
用于 google-doubleclickbidmana…

MIT 许可证

230KB
3K SLoC

google-doubleclickbidmanager1 库允许访问 Google DoubleClick Bid Manager 服务的所有功能。

本文档是从 DoubleClick Bid Manager 版本 5.0.5+20210323 生成的,其中 20210323 是由 mako 代码生成器 v5.0.5 构建的 doubleclickbidmanager:v1 模式的确切修订版本。

有关 DoubleClick Bid Manager v1 API 的其他所有信息,请参阅官方文档网站

特性

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

本库结构

API 结构如下主要项目

  • 枢纽
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都用适用的特性标记,以进一步分类并便于浏览。

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

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

或者具体...

let r = hub.queries().createquery(...).doit().await
let r = hub.queries().getquery(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_doubleclickbidmanager1 as doubleclickbidmanager1;
use doubleclickbidmanager1::api::Query;
use doubleclickbidmanager1::{Result, Error};
use std::default::Default;
use doubleclickbidmanager1::{DoubleClickBidManager, 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 = DoubleClickBidManager::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 = Query::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.queries().createquery(req)
             .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")

支持上传的方法可以使用多达 2 种不同的协议进行上传: 简单可恢复。每种的区别体现在自定义的 doit(...) 方法上,分别命名为 upload(...)upload_resumable(...)

自定义和回调

您可以通过提供一个委托方法构建器来修改调用doit()方法的方式,在最终调用之前。相应的方法将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

使用方法构建器,您可以通过反复调用其方法来准备动作调用。这些方法始终接受单个参数,以下陈述是真实的。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC