32 个版本 (14 个稳定版)
使用旧的 Rust 2015
1.0.8+20181010 | 2018 年 10 月 14 日 |
---|---|
1.0.7+20171206 | 2017 年 12 月 12 日 |
1.0.6+20170925 | 2017 年 9 月 27 日 |
1.0.5+20170517 | 2017 年 5 月 26 日 |
0.1.2+20150304 | 2015 年 3 月 25 日 |
在 #web-api 中排名 #285
每月下载量 50 次
在 google-youtubeanalytics1-… 中使用
175KB
2K SLoC
“google-youtubeanalytics1” 库允许访问 Google YouTube 分析服务的所有功能。
本文档由 YouTube 分析 模块版本 1.0.8+20181010 生成,其中 20181010 是由 mako 代码生成器 v1.0.8 构建的 youtubeAnalytics:v1 模式的确切修订版本。
关于 YouTube 分析 v1 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-youtubeanalytics1 = "*"
# 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_youtubeanalytics1 as youtubeanalytics1;
use youtubeanalytics1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use youtubeanalytics1::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
枚举作为doit()方法的返回值提供,要么作为可能的中继结果传递给Hub Delegate
或Authenticator Delegate
。
当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。
上传和下载
如果方法支持下载,则应该读取响应体(它是Result的一部分)以获取媒体。如果此方法还支持
Response Result
,则默认返回该值。您可以将其视为实际媒体的元数据。要触发媒体下载,您必须通过以下调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多2种不同的协议进行上传:简单和可恢复。每种方法的独特性都由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过向委托提供方法构建器来修改doit()
方法的调用方式,在执行最终的doit()
调用之前。相应的函数将被调用以提供进度信息,以及确定系统在失败时是否应该重试。
委托特质默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过json进行编码和解码。使用可选部分来表示部分请求和响应是有效的。大多数可选部分都被视为部分,这些部分可以通过名称识别,将被发送到服务器以指示请求的设置部分或响应中所需的部分。
构建器参数
通过使用方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受一个参数,以下语句适用于该参数。
参数将始终复制或克隆到构建器中,以使其与原始生命周期独立。
许可
youtubeanalytics1库由Sebastian Thiel生成,并置于MIT许可之下。您可以在存储库的许可文件中阅读全文。
依赖关系
~8–19MB
~302K SLoC