#google-api #google #web-api #google-service #protocols #api #web

google-adexchangeseller2

与 Ad Exchange Seller 服务(协议 v2.0)交互的完整库

44 个版本 (26 个稳定版)

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

#2121 in 网页编程

Download history 2/week @ 2024-05-15 5/week @ 2024-05-22 2/week @ 2024-06-05 2/week @ 2024-06-12 92/week @ 2024-06-26 80/week @ 2024-07-03

2,607 每月下载量
用于 google-adexchangeseller2-…

MIT 许可证

305KB
4K SLoC

google-adexchangeseller2 库允许访问 Google Ad Exchange Seller 服务(v2.0)的所有功能。

本文档是从 Ad Exchange Seller 库版本 5.0.5+20171101 生成的,其中 20171101 是由 mako 代码生成器 v5.0.5 构建的 adexchangeseller:v2.0 架构的确切修订版。

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

功能

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

支持下载 ...

此库的结构

API结构分为以下主要项目

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

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

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

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

或者具体来说...

let r = hub.accounts().adclients_list(...).doit().await
let r = hub.accounts().alerts_list(...).doit().await
let r = hub.accounts().customchannels_get(...).doit().await
let r = hub.accounts().customchannels_list(...).doit().await
let r = hub.accounts().metadata_dimensions_list(...).doit().await
let r = hub.accounts().metadata_metrics_list(...).doit().await
let r = hub.accounts().preferreddeals_get(...).doit().await
let r = hub.accounts().preferreddeals_list(...).doit().await
let r = hub.accounts().reports_saved_generate(...).doit().await
let r = hub.accounts().reports_saved_list(...).doit().await
let r = hub.accounts().reports_generate(...).doit().await
let r = hub.accounts().urlchannels_list(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().list(...).doit().await

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

用法

设置你的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_adexchangeseller2 as adexchangeseller2;
use adexchangeseller2::{Result, Error};
use std::default::Default;
use adexchangeseller2::{AdExchangeSeller, 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 = AdExchangeSeller::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.accounts().reports_generate("accountId", "startDate", "endDate")
             .start_index(46)
             .add_sort("voluptua.")
             .add_metric("At")
             .max_results(93)
             .locale("sed")
             .add_filter("amet.")
             .add_dimension("takimata")
             .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(...)

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖项

~12–22MB
~344K SLoC