19个稳定版本 (4个主要版本)
5.0.5+20240123 | 2024年6月27日 |
---|---|
5.0.4+20240123 | 2024年3月5日 |
5.0.3+20221104 | 2023年8月23日 |
5.0.2+20221104 | 2023年3月16日 |
1.0.7+20171108 | 2018年2月1日 |
在 Web编程 中排名 2876
每月下载量 1,183
用于 google-analyticsreporting…
180KB
2K SLoC
“google-analyticsreporting4”库允许访问Google AnalyticsReporting服务的所有功能。
本文档是从AnalyticsReporting crate版本5.0.5+20240123生成的,其中20240123是mako代码生成器v5.0.5构建的analyticsreporting:v4模式的精确版本。
有关AnalyticsReporting v4 API的所有其他信息,请参阅官方文档网站。
功能
从中央中心轻松处理以下资源...
本库的结构
API结构如下
所有结构都带有适用的特性和标记,以进一步分类它们并简化浏览。
一般来说,您可以通过以下方式调用活动
let r = hub.resource().activity(...).doit().await
或者具体地...
let r = hub.user_activity().search(...).doit().await
资源(resource()
)和活动(activity(...)
)调用创建构建器。后者处理Activities
,支持各种配置即将进行的操作(此处未显示)的方法。它被设计成必须立即指定所有必需的参数(即 (...)
),而所有可选的参数可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置项目
要使用这个库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-analyticsreporting4 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_analyticsreporting4 as analyticsreporting4;
use analyticsreporting4::api::SearchUserActivityRequest;
use analyticsreporting4::{Result, Error};
use std::default::Default;
use analyticsreporting4::{AnalyticsReporting, 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 = AnalyticsReporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = SearchUserActivityRequest::default();
// 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.user_activity().search(req)
.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")
。
支持上传的方法可以使用多达2种不同的协议进行操作:简单和可恢复。每种的独特性都通过定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
您可以通过在执行最终的doit()
调用之前向Method Builder
提供一个代理来更改doit()
方法的调用方式。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。
delegate trait具有默认实现,这使得您可以用最少的努力进行定制。
服务器请求中的可选部分
本库提供的所有结构都设计为可以通过json进行编码和解码。编码和解码通过解码完成。使用可选参数来表示部分请求和响应是有效的。大多数可选参数都是被认为是部分,通过名称可以识别,这些部分将被发送到服务器,以指示请求或响应中期望的部分。
构建器参数
通过使用方法构建器,您可以重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述适用于这些参数。
参数将始终被复制或克隆到构建器中,以确保它们与其原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将无效。
许可证
analyticsreporting4 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~346K SLoC