13 个稳定版本 (3 个主要版本)

5.0.4+20240228 2024 年 3 月 5 日
3.1.0+20220301 2022 年 4 月 26 日
3.0.0+20220301 2022 年 3 月 8 日
2.0.4+20210330 2021 年 4 月 15 日
1.0.6+20170915 2017 年 9 月 27 日

#34 in #command-line-interface

MIT 许可证

2MB
29K SLoC

tagmanager2 命令行界面(CLI)允许您从终端舒适地使用 Google 标签管理器服务的大多数功能。

默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接导向文件,而不受您的 shell 能力限制。错误将打印到标准错误,并导致程序的退出代码非零。

如果请求数据结构,则这些结构将作为格式化的 JSON 返回,以便作为其他工具的输入。

有关标签管理器 API 的其他所有信息,请参阅 官方文档网站

安装和源代码

使用 cargo 安装命令行界面

cargo install google-tagmanager2-cli

GitHub 上找到源代码

用法

本文档是根据修订版 20240228标签管理器 API 生成的。CLI 的版本是 5.0.4

tagmanager2 [options]
        accounts
                containers-combine <path> [-p <v>]... [-o <out>]
                containers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-delete <path> [-p <v>]...
                containers-destinations-get <path> [-p <v>]... [-o <out>]
                containers-destinations-link <parent> [-p <v>]... [-o <out>]
                containers-destinations-list <parent> [-p <v>]... [-o <out>]
                containers-environments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-environments-delete <path> [-p <v>]...
                containers-environments-get <path> [-p <v>]... [-o <out>]
                containers-environments-list <parent> [-p <v>]... [-o <out>]
                containers-environments-reauthorize <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-environments-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-get <path> [-p <v>]... [-o <out>]
                containers-list <parent> [-p <v>]... [-o <out>]
                containers-lookup [-p <v>]... [-o <out>]
                containers-move-tag-id <path> [-p <v>]... [-o <out>]
                containers-snippet <path> [-p <v>]... [-o <out>]
                containers-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-version-headers-latest <parent> [-p <v>]... [-o <out>]
                containers-version-headers-list <parent> [-p <v>]... [-o <out>]
                containers-versions-delete <path> [-p <v>]...
                containers-versions-get <path> [-p <v>]... [-o <out>]
                containers-versions-live <parent> [-p <v>]... [-o <out>]
                containers-versions-publish <path> [-p <v>]... [-o <out>]
                containers-versions-set-latest <path> [-p <v>]... [-o <out>]
                containers-versions-undelete <path> [-p <v>]... [-o <out>]
                containers-versions-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-built-in-variables-create <parent> [-p <v>]... [-o <out>]
                containers-workspaces-built-in-variables-delete <path> [-p <v>]...
                containers-workspaces-built-in-variables-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-built-in-variables-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-clients-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-clients-delete <path> [-p <v>]...
                containers-workspaces-clients-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-clients-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-clients-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-clients-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-create-version <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-delete <path> [-p <v>]...
                containers-workspaces-folders-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-folders-delete <path> [-p <v>]...
                containers-workspaces-folders-entities <path> [-p <v>]... [-o <out>]
                containers-workspaces-folders-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-folders-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-folders-move-entities-to-folder <path> (-r <kv>)... [-p <v>]...
                containers-workspaces-folders-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-folders-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-get-status <path> [-p <v>]... [-o <out>]
                containers-workspaces-gtag-config-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-gtag-config-delete <path> [-p <v>]...
                containers-workspaces-gtag-config-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-gtag-config-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-gtag-config-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-quick-preview <path> [-p <v>]... [-o <out>]
                containers-workspaces-resolve-conflict <path> (-r <kv>)... [-p <v>]...
                containers-workspaces-sync <path> [-p <v>]... [-o <out>]
                containers-workspaces-tags-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-tags-delete <path> [-p <v>]...
                containers-workspaces-tags-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-tags-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-tags-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-tags-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-templates-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-templates-delete <path> [-p <v>]...
                containers-workspaces-templates-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-templates-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-templates-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-templates-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-transformations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-transformations-delete <path> [-p <v>]...
                containers-workspaces-transformations-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-transformations-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-transformations-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-transformations-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-triggers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-triggers-delete <path> [-p <v>]...
                containers-workspaces-triggers-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-triggers-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-triggers-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-triggers-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-variables-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-variables-delete <path> [-p <v>]...
                containers-workspaces-variables-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-variables-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-variables-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-variables-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-zones-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                containers-workspaces-zones-delete <path> [-p <v>]...
                containers-workspaces-zones-get <path> [-p <v>]... [-o <out>]
                containers-workspaces-zones-list <parent> [-p <v>]... [-o <out>]
                containers-workspaces-zones-revert <path> [-p <v>]... [-o <out>]
                containers-workspaces-zones-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                get <path> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update <path> (-r <kv>)... [-p <v>]... [-o <out>]
                user-permissions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                user-permissions-delete <path> [-p <v>]...
                user-permissions-get <path> [-p <v>]... [-o <out>]
                user-permissions-list <parent> [-p <v>]... [-o <out>]
                user-permissions-update <path> (-r <kv>)... [-p <v>]... [-o <out>]
  tagmanager2 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录中,前缀为 tagmanager2-JSON 文件中。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 需要对任何请求进行身份验证。如果是这种情况,范围 决定了授予的权限集。这些权限的粒度通常不超过 只读完全访问

如果没有设置,系统将自动选择最小的可行范围,例如,在调用只读方法时,它只请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围都在相应方法的 CLI 文档中有记录。

首次使用范围时,用户会被要求进行权限。按照 CLI 提供的说明授予权限或拒绝。

如果用户验证了作用域,相应的信息将以JSON格式存储在配置目录中,例如~/.google-service-cli/tagmanager2-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证,请参阅官方文档

应用程序密钥

为了允许任何应用程序使用Google服务,需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用,并设有每日配额。

为了在不强制用户注册自己的应用程序的情况下更舒适地使用CLI,CLI附带了一个默认的应用程序密钥,相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题:~/.google-service-cli/tagmanager2-secret.json,假设已为它启用了所需的tagmanager API。这样的密钥文件可以从Google开发者控制台APIs & auth -> Credentials -> Download JSON中下载,并直接使用。

有关如何设置Google项目和启用API的更多信息,请参阅官方文档

调试

尽管CLI尽力提供可用的错误消息,但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端服务器通信以原始形式输出到标准错误来完成的。

带有--debug标志将错误以Debug表示形式打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用,例如tagmanager2 --debug <resource> <method> [options] 2>debug.txt

依赖项

~20–31MB
~581K SLoC