google-analyticsadmin1_alpha 库允许访问 Google Google Analytics Admin 服务的所有功能。

本文档由 Google Analytics Admin crate 版本 5.0.3+20220307 生成，其中 20220307 是由 mako 代码生成器 v5.0.3 构建的 analyticsadmin:v1alpha 方案的精确版本。

有关 Google Analytics Admin v1_alpha API 的其他所有信息，请参阅 官方文档网站。

特性

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

• 账户摘要
• 列表
• 账户
• 删除，获取，获取数据共享设置，列出，修补，提供账户票据，搜索变更历史事件，用户链接审计，批量创建用户链接，批量删除用户链接，批量获取用户链接，批量更新用户链接，创建用户链接，删除用户链接，获取用户链接，列出用户链接和修补用户链接
• 属性
• acknowledge user data collection, conversion events create, conversion events delete, conversion events get, conversion events list, create, custom dimensions archive, custom dimensions create, custom dimensions get, custom dimensions list, custom dimensions patch, custom metrics archive, custom metrics create, custom metrics get, custom metrics list, custom metrics patch, data streams create, data streams delete, data streams get, data streams get global site tag, data streams list, data streams measurement protocol secrets create, data streams measurement protocol secrets delete, data streams measurement protocol secrets get, data streams measurement protocol secrets list, data streams measurement protocol secrets patch, data streams patch, delete, display video360 advertiser link proposals approve, display video360 advertiser link proposals cancel, display video360 advertiser link proposals create, display video360 advertiser link proposals delete, display video360 advertiser link proposals get, display video360 advertiser link proposals list, display video360 advertiser links create, display video360 advertiser links delete, display video360 advertiser links get, display video360 advertiser links list, display video360 advertiser links patch, firebase links create, firebase links delete, firebase links list, get, get data retention settings, get google signals settings, google ads links create, google ads links delete, google ads links list, google ads links patch, list, patch, update data retention settings, update google signals settings, user links audit, user links batch create, user links batch delete, user links batch get, user links batch update, user links create, user links delete, user links get, user links list and user links patch

该库的结构

API结构如下几个主要项

• 中心
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，这反过来又允许访问单个调用构建器
• 资源
  • 可以应用活动的主要类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 从不直接用于活动
• 活动
  • 应用于资源的操作

所有结构都带有适用的特性和进一步分类，便于浏览。

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

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

或者具体...

let r = hub.accounts().user_links_batch_delete(...).doit().await
let r = hub.accounts().user_links_delete(...).doit().await
let r = hub.accounts().delete(...).doit().await
let r = hub.properties().conversion_events_delete(...).doit().await
let r = hub.properties().custom_dimensions_archive(...).doit().await
let r = hub.properties().custom_metrics_archive(...).doit().await
let r = hub.properties().data_streams_measurement_protocol_secrets_delete(...).doit().await
let r = hub.properties().data_streams_delete(...).doit().await
let r = hub.properties().display_video360_advertiser_link_proposals_delete(...).doit().await
let r = hub.properties().display_video360_advertiser_links_delete(...).doit().await
let r = hub.properties().firebase_links_delete(...).doit().await
let r = hub.properties().google_ads_links_delete(...).doit().await
let r = hub.properties().user_links_batch_delete(...).doit().await
let r = hub.properties().user_links_delete(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_analyticsadmin1_alpha as analyticsadmin1_alpha;
use analyticsadmin1_alpha::api::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest;
use analyticsadmin1_alpha::{Result, Error};
use std::default::Default;
use analyticsadmin1_alpha::{GoogleAnalyticsAdmin, 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 = GoogleAnalyticsAdmin::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().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 = GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest::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.accounts().user_links_batch_delete(req, "parent")
             .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 Delegate或Authenticator Delegate。

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

上传和下载

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

支持上传的方法可以使用最多2种不同的协议进行：简单和可恢复。每种协议的独特性由定制的doit(...)方法表示，然后分别命名为upload(...)和upload_resumable(...)。

自定义和回调

您可以通过在最终调用doit()之前将delegate传递给Method Builder来更改调用doit()方法的方式。相应的方法将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

delegate trait具有默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用method builders，您可以通过重复调用其方法来准备一个操作调用。这些方法始终只接受一个参数，以下陈述是正确的。

• PODs通过复制传递
• 字符串作为&str传递
• request values被移动

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

许可证

analyticsadmin1_alpha 库是由 Sebastian Thiel 生成的，并置于 MIT 许可证之下。您可以在仓库的许可证文件中阅读全文。