#google-api #web-api #google #protocols #api #web #youtube-analytics

google-youtubeanalytics2

一个完整的库,用于与 YouTube 分析(协议 v2)交互

2 个稳定版本

使用旧的 Rust 2015

1.0.8+20181010 2018 年 10 月 14 日
1.0.7+20181010 2018 年 10 月 13 日

#315#web-api


用于 google-youtubeanalytics2-…

MIT 许可证

185KB
2K SLoC

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

本文档是从 YouTube 分析 包版本 1.0.8+20181010 生成的,其中 20181010 是由 mako 代码生成器 v1.0.8 构建的 youtubeAnalytics:v2 架构的确切修订版本。

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

功能

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

本库的结构

API 被组织成以下主要项目

  • 枢纽
  • 资源
    • 主要类型,您可以将 活动 应用于它们
    • 一系列属性和 部分
    • 部分
      • 一系列属性
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

所有结构都被标记了相应的特征,以便进一步分类和简化浏览。

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

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

或者具体来说...

let r = hub.groups().list(...).doit()
let r = hub.groups().update(...).doit()
let r = hub.groups().insert(...).doit()
let r = hub.groups().delete(...).doit()

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

使用方法

设置您的项目

要使用这个库,您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-youtubeanalytics2 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_youtubeanalytics2 as youtubeanalytics2;
use youtubeanalytics2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use youtubeanalytics2::YouTubeAnalytics;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = YouTubeAnalytics::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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.groups().list()
             .page_token("eirmod")
             .on_behalf_of_content_owner("sit")
             .mine(false)
             .id("sed")
             .doit();

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::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

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

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

上传和下载

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

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

自定义和回调

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

委托特质默认实现,允许您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

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

依赖关系

~9–21MB
~324K SLoC