API Reference

本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法，以及一或多種方法。

資源類型

  1. 帳戶
  2. 內建變數
  3. 用戶端
  4. 容器
  5. 目的地
  6. 環境
  7. 資料夾
  8. Google 代碼設定
  9. 標記
  10. 範本
  11. 轉換
  12. 觸發條件
  13. 使用者權限
  14. 變數
  15. 版本標頭
  16. 版本
  17. 工作區
  18. 可用區

帳戶

如要進一步瞭解 Accounts 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
get GET  /path 取得 Google 代碼管理工具帳戶。
清單 GET  /accounts 列出使用者可存取的所有 GTM 帳戶。
更新 PUT  /path 更新 Google 代碼管理工具帳戶。

內建變數

如需內建變數資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/built_in_variables 建立一或多個 GTM 內建變數。
刪除 DELETE  /path 刪除一或多個 GTM 內建變數。
清單 GET  /+parent/built_in_variables 列出 GTM 容器中所有已啟用的內建變數。
還原 POST  /+path/built_in_variables:revert 在 GTM 工作區中將變更還原為 GTM 內建變數。

用戶端

如要進一步瞭解 Clients 資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/clients 建立 GTM 用戶端。
刪除 DELETE  /path 刪除 GTM 用戶端。
get GET  /path 取得 GTM 用戶端。
清單 GET  /+parent/clients 列出 GTM 容器工作區的所有 GTM 用戶端。
還原 POST  /+path:revert 在 GTM 工作區中將變更還原為 GTM 用戶端。
更新 PUT  /path 更新 GTM 用戶端。

容器

如要進一步瞭解容器資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
合併計算 POST  /+path:combine 合併容器。
create POST  /+parent/containers 建立容器。
刪除 DELETE  /path 刪除容器。
get GET  /path 取得容器。
清單 GET  /+parent/containers 列出屬於 GTM 帳戶的所有容器。
lookup GET  /accounts/containers:lookup 按照目的地 ID 或標記 ID 查詢容器。
move_tag_id POST  /+path:move_tag_id 將代碼 ID 移出容器。
snippet GET  /+path:snippet 取得容器的代碼片段。
更新 PUT  /path 更新容器。

目的地

如要進一步瞭解目的地資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
get GET  /path 取得目的地。
link POST  /+parent/destinations:link 為這個容器新增目的地，並將其從目前連結的容器中移除。
清單 GET  /+parent/destinations 列出已連結至 GTM 容器的所有目的地。

環境

如要進一步瞭解環境資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/environments 建立 Google 代碼管理工具環境。
刪除 DELETE  /path 刪除 GTM 環境。
get GET  /path 取得 GTM 環境。
清單 GET  /+parent/environments 列出 GTM 容器的所有 GTM 環境。
重新授權 POST  /+path:reauthorize 重新產生 GTM 環境的授權碼。
更新 PUT  /path 更新 GTM 環境。

資料夾

如需資料夾資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/folders 建立 Google 代碼管理工具資料夾。
刪除 DELETE  /path 刪除 Google 代碼管理工具資料夾。
實體 POST  /+path:entities 列出 GTM 資料夾中的所有實體。
get GET  /path 取得 GTM 資料夾。
清單 GET  /+parent/folders 列出容器的所有 GTM 資料夾。
move_entities_to_folder POST  /+path:move_entities_to_folder 將實體移至 GTM 資料夾。如果要求路徑中的 {folder_id} 等於 0，則系統會將實體移出目前所屬的資料夾。
還原 POST  /+path:revert 將變更還原為 GTM 工作區中的 GTM 資料夾。
更新 PUT  /path 更新 GTM 資料夾。

Google 代碼設定

如要進一步瞭解 Google 代碼設定資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/gtag_config 建立 Google 代碼設定。
刪除 DELETE  /path 刪除 Google 代碼設定。
get GET  /path 取得 Google 代碼設定。
清單 GET  /+parent/gtag_config 列出容器中的所有 Google 代碼設定。
更新 PUT  /path 更新 Google 代碼設定。

標記

如要進一步瞭解標記資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/tags 建立 GTM 代碼。
刪除 DELETE  /path 刪除 GTM 代碼。
get GET  /path 取得 GTM 代碼。
清單 GET  /+parent/tags 列出容器的所有 GTM 代碼。
還原 POST  /+path:revert 在 GTM 工作區中還原為 GTM 代碼的變更。
更新 PUT  /path 更新 GTM 代碼。

範本

如需範本資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/templates 建立 Google 代碼管理工具自訂範本。
刪除 DELETE  /path 刪除 Google 代碼管理工具範本。
get GET  /path 取得 Google 代碼管理工具範本。
清單 GET  /+parent/templates 列出 GTM 容器工作區的所有 GTM 範本。
還原 POST  /+path:revert 將變更還原為 GTM 工作區中的 GTM 範本。
更新 PUT  /path 更新 GTM 範本。

轉換

如需轉換資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/transformations 建立 Google 代碼管理工具轉換。
刪除 DELETE  /path 刪除 GTM 轉換。
get GET  /path 取得 Google 代碼管理工具轉換。
清單 GET  /+parent/transformations 列出 GTM 容器工作區的所有 GTM 轉換。
還原 POST  /+path:revert 在 GTM 工作區中還原為 GTM 轉換。
更新 PUT  /path 更新 GTM 轉換。

觸發條件

如要進一步瞭解觸發條件資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/triggers 建立 Google 代碼管理工具觸發條件。
刪除 DELETE  /path 刪除 GTM 觸發條件。
get GET  /path 取得 GTM 觸發條件。
清單 GET  /+parent/triggers 列出容器的所有 GTM 觸發條件。
還原 POST  /+path:revert 在 GTM 工作區中將變更還原為 GTM 觸發條件。
更新 PUT  /path 更新 GTM 觸發條件。

使用者權限

如要進一步瞭解使用者權限資源，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/user_permissions 建立使用者的帳戶和容器存取權。
刪除 DELETE  /path 從帳戶中移除使用者，撤銷使用者及其所有容器的存取權。
get GET  /path 取得使用者的帳戶和容器存取權。
清單 GET  /+parent/user_permissions 列出具有帳戶存取權的所有使用者，以及每個使用者的帳戶和容器使用者存取權。
更新 PUT  /path 更新使用者的帳戶和容器存取權。

變數

如需 Variables 資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/variables 建立 Google 代碼管理工具變數。
刪除 DELETE  /path 刪除 GTM 變數。
get GET  /path 取得 GTM 變數。
清單 GET  /+parent/variables 列出容器的所有 GTM 變數。
還原 POST  /+path:revert 將變更還原為 GTM 工作區中的 GTM 變數。
更新 PUT  /path 更新 GTM 變數。

版本標頭

如需版本標頭資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
最新 GET  /+parent/version_headers:latest 取得最新版容器版本標頭
清單 GET  /+parent/version_headers 列出 GTM 容器的所有容器版本。

版本

如需版本資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
刪除 DELETE  /path 刪除容器版本。
get GET  /path 取得容器版本。
即時 GET  /+parent/versions:live 取得使用中的 (即已發布) 容器版本
發布 POST  /+path:publish 發布容器版本。
set_latest POST  /+path:set_latest 設定偵測衝突和錯誤時，用於同步處理工作區的最新版本。
取消刪除 POST  /+path:undelete 取消刪除容器版本。
更新 PUT  /path 更新容器版本。

工作區

如需 Workspaces 資源詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/workspaces 建立工作區。
create_version POST  /+path:create_version 從工作區中的實體建立容器版本、刪除工作區，並將基本容器版本設為新建立的版本。
刪除 DELETE  /path 刪除工作區。
get GET  /path 取得工作區。
getStatus GET  /+path/status 找出工作區中發生衝突和經過修改的實體。
清單 GET  /+parent/workspaces 列出屬於 GTM 容器的所有工作區。
quick_preview POST  /+path:quick_preview 透過提供的工作區中所有實體建立假容器版本，快速預覽工作區。
resolve_conflict POST  /+path:resolve_conflict 將工作區實體更新為要求中傳遞的已解析實體，以解決工作區實體的合併衝突。
同步 POST  /+path:sync 更新所有未經修改的工作區實體，並顯示已修改實體的衝突，藉此將工作區同步處理至最新的容器版本。
更新 PUT  /path 更新工作區。

可用區

如需 Zones 資源的詳細資料，請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/tagmanager/v2 的 URI，除非另有說明
create POST  /+parent/zones 建立 Google 代碼管理工具區域。
刪除 DELETE  /path 刪除 GTM 區域。
get GET  /path 取得 Google 代碼管理工具區域。
清單 GET  /+parent/zones 列出 GTM 容器工作區的所有 GTM 區域。
還原 POST  /+path:revert 將變更還原為 GTM 工作區中的 GTM 可用區。
更新 PUT  /path 更新 GTM 區域。