google-admin1_reports 库允许访问 Google 报告服务的所有功能。

本文档由 reports 包版本 1.0.12+20190521 生成，其中 20190521 是由 mako 代码生成器 v1.0.12 构建的 admin:reports_v1 模式的确切修订版。

有关 reports v1_reports API 的其他所有信息，请参阅 官方文档网站。

特性

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

• 活动
• 列表 和 监视
• 频道
• 停止
• 客户使用报告
• 获取
• 实体使用报告
• 获取
• 用户使用报告
• 获取

支持订阅...

• 列出活动
• 监视活动

此库的结构

API 被组织为以下主要项目

• 枢纽
  • 一个中央对象，用于维护状态和访问所有 活动
  • 创建 方法构建器，后者反过来允许访问单个 调用构建器
• 资源
  • 可以将 活动 应用于其上的主要类型
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 从未在 活动 中直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或具体...

let r = hub.user_usage_report().get(...).doit()
let r = hub.entity_usage_reports().get(...).doit()
let r = hub.customer_usage_reports().get(...).doit()

资源 resource() 和活动 activity(...) 调用创建构建器。第二个处理 Activities，支持各种配置即将进行的操作的方法（此处未显示）。它设计得如此，即所有必需的参数都必须立即指定（即 (...)），而所有可选的都可以按需 构建。doit() 方法执行与服务器之间的实际通信并返回相应的结果。

用法

设置项目

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

[dependencies]
google-admin1_reports = "*"
# 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_admin1_reports as admin1_reports;
use admin1_reports::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use admin1_reports::Reports;

// 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 = Reports::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.user_usage_report().get("userKey", "date")
             .parameters("Stet")
             .page_token("sed")
             .org_unit_id("et")
             .max_results(83)
             .filters("kasd")
             .customer_id("accusam")
             .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(...)。