“google-youtubereporting1”库允许访问Google YouTube Reporting服务的所有功能。

本文档是由YouTube Reporting crate版本5.0.5+20240625生成的，其中20240625是mako代码生成器v5.0.5构建的youtubereporting:v1模式的精确修订版。

有关YouTube Reporting v1 API的更多信息，请访问官方文档网站。

功能

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

• 作业
• 创建、删除、获取、列表、报告获取和报告列表
• 媒体
• 下载
• 报告类型
• 列表

支持以下内容下载...

• 下载媒体

本库的结构

API结构如下主要项目

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，后者允许访问单个调用构建器
• 资源
  • 可以将其应用于活动的基本类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 永远不会在活动中直接使用
• 活动
  • 应用于资源的操作

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

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

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

或者具体来说...

let r = hub.jobs().reports_get(...).doit().await
let r = hub.jobs().reports_list(...).doit().await
let r = hub.jobs().create(...).doit().await
let r = hub.jobs().delete(...).doit().await
let r = hub.jobs().get(...).doit().await
let r = hub.jobs().list(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_youtubereporting1 as youtubereporting1;
use youtubereporting1::{Result, Error};
use std::default::Default;
use youtubereporting1::{YouTubeReporting, 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 = YouTubeReporting::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.jobs().reports_list("jobId")
             .start_time_before(chrono::Utc::now())
             .start_time_at_or_after(chrono::Utc::now())
             .page_token("magna")
             .page_size(-11)
             .on_behalf_of_content_owner("ipsum")
             .created_after(chrono::Utc::now())
             .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枚举，或者作为可能的中途结果传递给Hub Delegate，或者Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指导系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

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

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

自定义和回调

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

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

许可证

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