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

google-doubleclickbidmanager1d1

与DoubleClick Bid Manager(协议版本1.1)交互的完整库

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

5.0.5+20230117 2024年6月27日
5.0.4+20230117 2024年3月5日
5.0.3+20230117 2023年8月23日
5.0.2+20230117 2023年3月16日
1.0.14+20200616 2020年7月10日

#2542 in 网页编程

Download history 1/week @ 2024-05-17 60/week @ 2024-06-21 33/week @ 2024-06-28 6/week @ 2024-07-05

每月767次 下载
用于 google-doubleclickbidmana…

MIT 许可证

190KB
2.5K SLoC

google-doubleclickbidmanager1d1 库允许访问Google DoubleClick Bid Manager服务(协议版本1.1)的所有功能。

本文档是从 DoubleClick Bid Manager crate版本 5.0.5+20230117 生成的,其中 20230117 是由 mako 代码生成器 v5.0.5 构建的 doubleclickbidmanager:v1.1 架构的确切版本。

关于DoubleClick Bid Manager v1d1 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-doubleclickbidmanager1d1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_doubleclickbidmanager1d1 as doubleclickbidmanager1d1;
use doubleclickbidmanager1d1::api::Query;
use doubleclickbidmanager1d1::{Result, Error};
use std::default::Default;
use doubleclickbidmanager1d1::{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)
             .asynchronous(true)
             .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),
}

处理错误

系统产生的所有错误都通过doit()方法的返回值以Result枚举形式提供,或者作为可能的中级结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用多达2种不同的协议:简单可恢复。每种协议的独特之处在于定制的doit(...)方法,分别命名为upload(...)upload_resumable(...)

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

使用方法构建器,您可以通过重复调用其方法来准备动作调用。这些方法始终接受单个参数,以下陈述适用于该参数。

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

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

Cargo功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC