42 个版本 (25 个稳定版)

5.0.5+20240619	2024年6月27日
5.0.4+20240228	2024年3月5日
5.0.3+20230123	2023年8月24日
5.0.2+20230123	2023年3月16日
0.1.2+20150121	2015年3月25日

#522 in 网页编程

2,397 每月下载量
用于 google-tagmanager1-cli

MIT 许可证

1MB
10K SLoC

“google-tagmanager1”库允许访问“Google 标签管理器”服务的所有功能。

此文档是从版本 Tag Manager crate 5.0.5+20240619 生成的，其中 20240619 是由 mako 代码生成器 v5.0.5 构建的 tagmanager:v1 方案的精确修订版。

有关“Tag Manager” v1 API 的其他所有信息，请参阅官方文档网站。

功能

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

本库结构

API 被结构化为以下主要项

枢纽
- 一个中心对象，用于维护状态并允许访问所有活动
- 创建 方法构建器，后者再进一步允许访问单个 调用构建器
资源
- 主要类型，您可以将活动应用到这些类型上
- 一组属性和部分
- 部分
  - 一组属性
  - 永远不会直接用于活动
活动
- 应用于资源的操作

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

通常，您可以像这样调用活动：

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

或具体来说 ...

let r = hub.accounts().containers_environments_create(...).doit().await
let r = hub.accounts().containers_environments_delete(...).doit().await
let r = hub.accounts().containers_environments_get(...).doit().await
let r = hub.accounts().containers_environments_list(...).doit().await
let r = hub.accounts().containers_environments_update(...).doit().await
let r = hub.accounts().containers_folders_entities_list(...).doit().await
let r = hub.accounts().containers_folders_create(...).doit().await
let r = hub.accounts().containers_folders_delete(...).doit().await
let r = hub.accounts().containers_folders_get(...).doit().await
let r = hub.accounts().containers_folders_list(...).doit().await
let r = hub.accounts().containers_folders_update(...).doit().await
let r = hub.accounts().containers_move_folders_update(...).doit().await
let r = hub.accounts().containers_reauthorize_environments_update(...).doit().await
let r = hub.accounts().containers_tags_create(...).doit().await
let r = hub.accounts().containers_tags_delete(...).doit().await
let r = hub.accounts().containers_tags_get(...).doit().await
let r = hub.accounts().containers_tags_list(...).doit().await
let r = hub.accounts().containers_tags_update(...).doit().await
let r = hub.accounts().containers_triggers_create(...).doit().await
let r = hub.accounts().containers_triggers_delete(...).doit().await
let r = hub.accounts().containers_triggers_get(...).doit().await
let r = hub.accounts().containers_triggers_list(...).doit().await
let r = hub.accounts().containers_triggers_update(...).doit().await
let r = hub.accounts().containers_variables_create(...).doit().await
let r = hub.accounts().containers_variables_delete(...).doit().await
let r = hub.accounts().containers_variables_get(...).doit().await
let r = hub.accounts().containers_variables_list(...).doit().await
let r = hub.accounts().containers_variables_update(...).doit().await
let r = hub.accounts().containers_versions_create(...).doit().await
let r = hub.accounts().containers_versions_delete(...).doit().await
let r = hub.accounts().containers_versions_get(...).doit().await
let r = hub.accounts().containers_versions_list(...).doit().await
let r = hub.accounts().containers_versions_publish(...).doit().await
let r = hub.accounts().containers_versions_restore(...).doit().await
let r = hub.accounts().containers_versions_undelete(...).doit().await
let r = hub.accounts().containers_versions_update(...).doit().await
let r = hub.accounts().containers_create(...).doit().await
let r = hub.accounts().containers_delete(...).doit().await
let r = hub.accounts().containers_get(...).doit().await
let r = hub.accounts().containers_list(...).doit().await
let r = hub.accounts().containers_update(...).doit().await
let r = hub.accounts().permissions_create(...).doit().await
let r = hub.accounts().permissions_delete(...).doit().await
let r = hub.accounts().permissions_get(...).doit().await
let r = hub.accounts().permissions_list(...).doit().await
let r = hub.accounts().permissions_update(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().list(...).doit().await
let r = hub.accounts().update(...).doit().await

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

使用方法

设置你的项目

要使用此库，你需要在你的 Cargo.toml 文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_tagmanager1 as tagmanager1;
use tagmanager1::api::Folder;
use tagmanager1::{Result, Error};
use std::default::Default;
use tagmanager1::{TagManager, 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 = TagManager::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 = Folder::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().containers_move_folders_update(req, "accountId", "containerId", "folderId")
             .add_variable_id("ipsum")
             .add_trigger_id("voluptua.")
             .add_tag_id("At")
             .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() 调用之前向 Method Builder 提供一个代理来更改 doit() 方法的调用方式。将调用相应的方法以提供进度信息，以及确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下语句是正确的。

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

参数将被复制或克隆到构建器中，以使其与其原始生命周期独立。

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~344K SLoC