#数据分析 #Web API #Web #Google API #Google #API #协议

google-analytics3

一个完整的库,用于与数据分析(协议 v3)交互

47 个版本 (29 个稳定版本)

5.0.5+20190807 2024年6月27日
5.0.4+20190807 2024年3月5日
5.0.3+20190807 2023年8月23日
5.0.2+20190807 2023年3月16日
0.1.2+20150308 2015年3月25日

#数据分析 中排名第 21

Download history 6/week @ 2024-05-18 2/week @ 2024-05-25 2/week @ 2024-06-01 2/week @ 2024-06-08 1/week @ 2024-06-15 87/week @ 2024-06-22 18/week @ 2024-06-29 7/week @ 2024-07-06

每月下载量 2,772
google-analytics3-cli 中使用

MIT 许可证

1.5MB
19K SLoC

google-analytics3 库允许访问 Google 分析服务(v3协议)的所有功能。

本文档是根据 analyticscrate版本 5.0.5+20190807 生成的,其中 20190807 是由 mako 代码生成器 v5.0.5 构建的 analytics:v3 架构的确切修订版。

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

功能

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

支持上传...

本库的结构

API 被组织成以下主要项目

  • 枢纽
  • 资源
    • 可以将 活动 应用到的主类型
    • 一系列属性和 部分
    • 部分
      • 一系列属性
      • 活动 中永远不会直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者更具体...

let r = hub.management().account_user_links_insert(...).doit().await
let r = hub.management().account_user_links_update(...).doit().await
let r = hub.management().profile_user_links_insert(...).doit().await
let r = hub.management().profile_user_links_update(...).doit().await
let r = hub.management().webproperty_user_links_insert(...).doit().await
let r = hub.management().webproperty_user_links_update(...).doit().await

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

用法

设置你的项目

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

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_analytics3 as analytics3;
use analytics3::api::EntityUserLink;
use analytics3::{Result, Error};
use std::default::Default;
use analytics3::{Analytics, 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 = Analytics::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 = EntityUserLink::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.management().profile_user_links_update(req, "accountId", "webPropertyId", "profileId", "linkId")
             .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枚举提供,作为doit()方法的返回值,或者作为可能的中间结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

代理特质默认实现,允许你以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是为了通过 编码解码 来支持 json 格式而设计的。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被视为 部分,这些部分可以通过名称识别,将被发送到服务器以指示请求或响应中所需的部分。

构建器参数

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

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

参数总是被复制或克隆到构建器中,以确保它们与原始的生命周期独立。

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~345K SLoC