API Reference

此 API 参考资料按资源类型编排整理。每种资源类型都有一种或多种数据表示形式以及一个或多个方法。

资源类型

  1. 账号
  2. 内置变量
  3. 客户端
  4. 容器
  5. 目标位置
  6. 环境
  7. 文件夹
  8. Google 代码配置
  9. 代码
  10. 模板
  11. 转换
  12. 触发器
  13. 用户权限
  14. 变量
  15. 版本标头
  16. 版本
  17. 工作区
  18. 区域

账号

如需详细了解账号资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
get GET  /path 获取 GTM 账号。
list GET  /accounts 列出用户有权访问的所有 GTM 账号。
update PUT  /path 更新 GTM 账号。

内置变量

有关 Built-In Variables 资源的详细信息，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/built_in_variables 创建一个或多个 GTM 内置变量。
delete DELETE  /path 删除一个或多个 GTM 内置变量。
list GET  /+parent/built_in_variables 列出 GTM 容器的所有已启用的内置变量。
revert POST  /+path/built_in_variables:revert 还原对 GTM 工作区中 GTM 内置变量的更改。

客户端

如需详细了解 Clients 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/clients 创建 GTM 客户端。
delete DELETE  /path 删除 GTM 客户端。
get GET  /path 获取 GTM 客户端。
list GET  /+parent/clients 列出 GTM 容器工作区的所有 GTM 客户端。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 客户端的更改。
update PUT  /path 更新 GTM 客户端。

容器

有关 Containers 资源的详细信息，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
组合 POST  /+path:combine 合并容器。
创建 POST  /+parent/containers 创建容器。
delete DELETE  /path 删除容器。
get GET  /path 获取容器。
list GET  /+parent/containers 列出属于 GTM 账号的所有容器。
查询 GET  /accounts/containers:lookup 按目的地 ID 或代码 ID 查找容器。
move_tag_id POST  /+path:move_tag_id 将代码 ID 移出容器。
代码段 GET  /+path:snippet 获取容器的代码段。
update PUT  /path 更新容器。

目标

如需详细了解 Destinations 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
get GET  /path 获取目的地。
链接 POST  /+parent/destinations:link 向此容器添加目的地，并将其从当前关联的容器中移除。
list GET  /+parent/destinations 列出与 GTM 容器关联的所有目的地。

环境

有关 Environments 资源的详细信息，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/environments 创建 GTM 环境。
delete DELETE  /path 删除 GTM 环境。
get GET  /path 获取 GTM 环境。
list GET  /+parent/environments 列出 GTM 容器的所有 GTM 环境。
reauthorize POST  /+path:reauthorize 为 GTM 环境重新生成授权代码。
update PUT  /path 更新 GTM 环境。

文件夹

有关 Folders 资源的详细信息，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/folders 创建 GTM 文件夹。
delete DELETE  /path 删除 GTM 文件夹。
实体 POST  /+path:entities 列出 GTM 文件夹中的所有实体。
get GET  /path 获取 GTM 文件夹。
list GET  /+parent/folders 列出容器的所有 GTM 文件夹。
move_entities_to_folder POST  /+path:move_entities_to_folder 将实体移动到 GTM 文件夹。如果请求路径中的 {folder_id} 等于 0，这会转而将实体移出其当前所属的文件夹。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 文件夹的更改。
update PUT  /path 更新 GTM 文件夹。

Google 代码配置

如需详细了解 Google 代码配置资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/gtag_config 创建 Google 代码配置。
delete DELETE  /path 删除 Google 代码配置。
get GET  /path 获取 Google 代码配置。
list GET  /+parent/gtag_config 列出容器中的所有 Google 代码配置。
update PUT  /path 更新 Google 代码配置。

代码

如需详细了解代码资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/tags 创建 GTM 代码。
delete DELETE  /path 删除 GTM 代码。
get GET  /path 获取 GTM 代码。
list GET  /+parent/tags 列出容器的所有 GTM 代码。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 代码的更改。
update PUT  /path 更新 GTM 代码。

模板

如需详细了解模板资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/templates 创建 GTM 自定义模板。
delete DELETE  /path 删除 GTM 模板。
get GET  /path 获取 GTM 模板。
list GET  /+parent/templates 列出 GTM 容器工作区的所有 GTM 模板。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 模板的更改。
update PUT  /path 更新 GTM 模板。

转换

如需详细了解 Transformations 资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/transformations 创建 GTM 转换。
delete DELETE  /path 删除 GTM 转换。
get GET  /path 获取 GTM 转换。
list GET  /+parent/transformations 列出 GTM 容器工作区的所有 GTM 转换。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 转换的更改。
update PUT  /path 更新 GTM 转换。

触发器

如需详细了解触发器资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/triggers 创建 GTM 触发器。
delete DELETE  /path 删除 GTM 触发器。
get GET  /path 获取 GTM 触发器。
list GET  /+parent/triggers 列出容器的所有 GTM 触发器。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 触发器的更改。
update PUT  /path 更新 GTM 触发器。

用户权限

如需详细了解用户权限资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/user_permissions 创建用户的账号和容器访问权限。
delete DELETE  /path 从账号中移除用户，撤消其对该账号及其所有容器的访问权限。
get GET  /path 获取用户的账号和容器访问权限。
list GET  /+parent/user_permissions 列出有权访问该账号的所有用户及其各自获得的账号和容器访问权限。
update PUT  /path 更新用户的账号和容器访问权限。

变量

如需详细了解变量资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/variables 创建 GTM 变量。
delete DELETE  /path 删除 GTM 变量。
get GET  /path 获取 GTM 变量。
list GET  /+parent/variables 列出容器的所有 GTM 变量。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 变量的更改。
update PUT  /path 更新 GTM 变量。

版本标头

如需详细了解版本标头资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
latest GET  /+parent/version_headers:latest 获取最新的容器版本标头
list GET  /+parent/version_headers 列出 GTM 容器的所有容器版本。

版本

如需详细了解版本资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
delete DELETE  /path 删除容器版本。
get GET  /path 获取容器版本。
live GET  /+parent/versions:live 获取当前（即已发布的）容器版本
publish POST  /+path:publish 发布容器版本。
set_latest POST  /+path:set_latest 设置在检测到冲突和错误时用于同步工作区的最新版本。
undelete POST  /+path:undelete 恢复删除的容器版本。
update PUT  /path 更新容器版本。

工作区

如需详细了解工作区资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/workspaces 创建工作区。
create_version POST  /+path:create_version 根据工作区中显示的实体创建容器版本，删除工作区，并将基础容器版本设置为新建的版本。
delete DELETE  /path 删除工作区。
get GET  /path 获取工作区。
getStatus GET  /+path/status 查找工作区中存在冲突的已更改实体。
list GET  /+parent/workspaces 列出 GTM 容器的所有工作区。
quick_preview POST  /+path:quick_preview 根据提供的工作区中的所有实体创建虚构的容器版本，以此方式快速预览工作区。
resolve_conflict POST  /+path:resolve_conflict 将工作区实体更新为请求中传递的已解决冲突的实体，以此方式解决工作区实体的合并冲突。
sync POST  /+path:sync 更新所有未经修改的工作区实体，并显示已修改实体之间的冲突，从而将工作区同步到最新容器版本。
update PUT  /path 更新工作区。

区域

如需详细了解区域资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/tagmanager/v2 的相对地址
创建 POST  /+parent/zones 创建 GTM 区域。
delete DELETE  /path 删除 GTM 区域。
get GET  /path 获取 GTM 区域。
list GET  /+parent/zones 列出 GTM 容器工作区的所有 GTM 区域。
revert POST  /+path:revert 还原对 GTM 工作区中 GTM 区域的更改。
update PUT  /path 更新 GTM 区域。