#google #协议 #web

google-displayvideo1

与Display Video(协议v1)交互的完整库

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

5.0.5+20240620 2024年6月27日
5.0.4+20240229 2024年3月5日
5.0.3+20230119 2023年8月23日
5.0.2+20230119 2023年3月16日
1.0.14+20200707 2020年7月10日

#14 in 视频

Download history 2/week @ 2024-05-17 1/week @ 2024-05-24 64/week @ 2024-06-21 37/week @ 2024-06-28 16/week @ 2024-07-05

765 每月下载量
用于 google-displayvideo1-cli

MIT 协议

3MB
32K SLoC

google-displayvideo1 库允许访问Google Display Video服务的所有功能。

此文档是根据Display Video crate版本5.0.5+20240620生成的,其中20240620mako代码生成器v5.0.5构建的displayvideo:v1模式的精确修订。

有关Display Video v1 API的其他信息,请参阅官方文档站点

功能

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

支持通过 ... 上传

支持通过 ... 下载

本库的结构

API结构如下主要项目

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

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

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

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

或者具体...

let r = hub.advertisers().assets_upload(...).doit().await
let r = hub.advertisers().campaigns_targeting_types_assigned_targeting_options_get(...).doit().await
let r = hub.advertisers().campaigns_targeting_types_assigned_targeting_options_list(...).doit().await
let r = hub.advertisers().campaigns_bulk_list_campaign_assigned_targeting_options(...).doit().await
let r = hub.advertisers().campaigns_create(...).doit().await
let r = hub.advertisers().campaigns_delete(...).doit().await
let r = hub.advertisers().campaigns_get(...).doit().await
let r = hub.advertisers().campaigns_list(...).doit().await
let r = hub.advertisers().campaigns_patch(...).doit().await
let r = hub.advertisers().channels_sites_bulk_edit(...).doit().await
let r = hub.advertisers().channels_sites_create(...).doit().await
let r = hub.advertisers().channels_sites_delete(...).doit().await
let r = hub.advertisers().channels_sites_list(...).doit().await
let r = hub.advertisers().channels_sites_replace(...).doit().await
let r = hub.advertisers().channels_create(...).doit().await
let r = hub.advertisers().channels_get(...).doit().await
let r = hub.advertisers().channels_list(...).doit().await
let r = hub.advertisers().channels_patch(...).doit().await
let r = hub.advertisers().creatives_create(...).doit().await
let r = hub.advertisers().creatives_delete(...).doit().await
let r = hub.advertisers().creatives_get(...).doit().await
let r = hub.advertisers().creatives_list(...).doit().await
let r = hub.advertisers().creatives_patch(...).doit().await
let r = hub.advertisers().insertion_orders_targeting_types_assigned_targeting_options_get(...).doit().await
let r = hub.advertisers().insertion_orders_targeting_types_assigned_targeting_options_list(...).doit().await
let r = hub.advertisers().insertion_orders_bulk_list_insertion_order_assigned_targeting_options(...).doit().await
let r = hub.advertisers().insertion_orders_create(...).doit().await
let r = hub.advertisers().insertion_orders_delete(...).doit().await
let r = hub.advertisers().insertion_orders_get(...).doit().await
let r = hub.advertisers().insertion_orders_list(...).doit().await
let r = hub.advertisers().insertion_orders_patch(...).doit().await
let r = hub.advertisers().invoices_list(...).doit().await
let r = hub.advertisers().invoices_lookup_invoice_currency(...).doit().await
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_create(...).doit().await
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_delete(...).doit().await
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_get(...).doit().await
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_list(...).doit().await
let r = hub.advertisers().line_items_bulk_edit_line_item_assigned_targeting_options(...).doit().await
let r = hub.advertisers().line_items_bulk_list_line_item_assigned_targeting_options(...).doit().await
let r = hub.advertisers().line_items_create(...).doit().await
let r = hub.advertisers().line_items_delete(...).doit().await
let r = hub.advertisers().line_items_generate_default(...).doit().await
let r = hub.advertisers().line_items_get(...).doit().await
let r = hub.advertisers().line_items_list(...).doit().await
let r = hub.advertisers().line_items_patch(...).doit().await
let r = hub.advertisers().location_lists_assigned_locations_bulk_edit(...).doit().await
let r = hub.advertisers().location_lists_assigned_locations_create(...).doit().await
let r = hub.advertisers().location_lists_assigned_locations_delete(...).doit().await
let r = hub.advertisers().location_lists_assigned_locations_list(...).doit().await
let r = hub.advertisers().location_lists_create(...).doit().await
let r = hub.advertisers().location_lists_get(...).doit().await
let r = hub.advertisers().location_lists_list(...).doit().await
let r = hub.advertisers().location_lists_patch(...).doit().await
let r = hub.advertisers().manual_triggers_activate(...).doit().await
let r = hub.advertisers().manual_triggers_create(...).doit().await
let r = hub.advertisers().manual_triggers_deactivate(...).doit().await
let r = hub.advertisers().manual_triggers_get(...).doit().await
let r = hub.advertisers().manual_triggers_list(...).doit().await
let r = hub.advertisers().manual_triggers_patch(...).doit().await
let r = hub.advertisers().negative_keyword_lists_negative_keywords_bulk_edit(...).doit().await
let r = hub.advertisers().negative_keyword_lists_negative_keywords_create(...).doit().await
let r = hub.advertisers().negative_keyword_lists_negative_keywords_delete(...).doit().await
let r = hub.advertisers().negative_keyword_lists_negative_keywords_list(...).doit().await
let r = hub.advertisers().negative_keyword_lists_negative_keywords_replace(...).doit().await
let r = hub.advertisers().negative_keyword_lists_create(...).doit().await
let r = hub.advertisers().negative_keyword_lists_delete(...).doit().await
let r = hub.advertisers().negative_keyword_lists_get(...).doit().await
let r = hub.advertisers().negative_keyword_lists_list(...).doit().await
let r = hub.advertisers().negative_keyword_lists_patch(...).doit().await
let r = hub.advertisers().targeting_types_assigned_targeting_options_create(...).doit().await
let r = hub.advertisers().targeting_types_assigned_targeting_options_delete(...).doit().await
let r = hub.advertisers().targeting_types_assigned_targeting_options_get(...).doit().await
let r = hub.advertisers().targeting_types_assigned_targeting_options_list(...).doit().await
let r = hub.advertisers().audit(...).doit().await
let r = hub.advertisers().bulk_edit_advertiser_assigned_targeting_options(...).doit().await
let r = hub.advertisers().bulk_list_advertiser_assigned_targeting_options(...).doit().await
let r = hub.advertisers().create(...).doit().await
let r = hub.advertisers().delete(...).doit().await
let r = hub.advertisers().get(...).doit().await
let r = hub.advertisers().list(...).doit().await
let r = hub.advertisers().patch(...).doit().await

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_displayvideo1 as displayvideo1;
use displayvideo1::{Result, Error};
use std::default::Default;
use displayvideo1::{DisplayVideo, 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 = DisplayVideo::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.advertisers().campaigns_targeting_types_assigned_targeting_options_list(-22, -33, "targetingType")
             .page_token("ipsum")
             .page_size(-28)
             .order_by("At")
             .filter("sanctus")
             .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的一部分,以获取媒体。如果此方法也支持Response Result,它将默认返回该结果。你可以将其视为实际媒体的元数据。要触发媒体下载,你将不得不通过以下调用设置建造者:.param("alt", "media")

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

定制和回调

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

delegate trait默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是为了能够通过 编码解码 来使用 json 格式。使用可选类型(Optionals)来表示部分请求或响应是有效的。大多数可选类型都被视为 部分(Parts),可以通过名称来识别,这些部分将被发送到服务器,以指示请求的设置部分或响应中期望的部分。

构建器参数

通过使用 方法构建器,你可以通过重复调用它的方法来准备一个动作调用。这些方法始终接受一个参数,以下是一些关于这个参数的说明。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC