#youtube #google-api #web-api

google-youtube3

用于与 YouTube(协议 v3)交互的完整库

50 个版本 (31 个稳定版)

5.0.5+20240626 2024年6月27日
5.0.4+20240303 2024年3月5日
5.0.3+20230123 2023年8月24日
5.0.2+20230123 2023年3月16日
0.1.2+20150309 2015年3月25日

#415 in 视频

Download history 107/week @ 2024-04-27 83/week @ 2024-05-04 235/week @ 2024-05-11 129/week @ 2024-05-18 180/week @ 2024-05-25 155/week @ 2024-06-01 119/week @ 2024-06-08 145/week @ 2024-06-15 272/week @ 2024-06-22 66/week @ 2024-06-29 62/week @ 2024-07-06 69/week @ 2024-07-13 82/week @ 2024-07-20 164/week @ 2024-07-27 304/week @ 2024-08-03 295/week @ 2024-08-10

855 每月下载
3 crates 中使用

MIT 许可证

1.5MB
21K SLoC

google-youtube3 库允许访问 Google YouTube 服务的所有功能。

本文档由 YouTube crate 版本 5.0.5+20240626 生成,其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 youtube:v3 模式的确切修订版本。

有关 YouTube v3 API 的其他所有信息,请参阅 官方文档网站

功能

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

支持上传...

支持下载...

本库结构

API结构为以下主要项

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

所有结构都带有适用的特质,以便进一步分类和便于浏览。

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

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

或具体...

let r = hub.videos().delete(...).doit().await
let r = hub.videos().get_rating(...).doit().await
let r = hub.videos().insert(...).doit().await
let r = hub.videos().list(...).doit().await
let r = hub.videos().rate(...).doit().await
let r = hub.videos().report_abuse(...).doit().await
let r = hub.videos().update(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_youtube3 as youtube3;
use youtube3::{Result, Error};
use std::default::Default;
use youtube3::{YouTube, 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 = YouTube::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.videos().list(&vec!["et".into()])
             .video_category_id("magna")
             .region_code("no")
             .page_token("ipsum")
             .on_behalf_of_content_owner("voluptua.")
             .my_rating("At")
             .max_width(-8)
             .max_results(21)
             .max_height(-2)
             .locale("takimata")
             .add_id("amet.")
             .hl("duo")
             .chart("ipsum")
             .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")

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

Cargo功能

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

许可证

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

依赖关系

~12-23MB
~341K SLoC