Workspaces: sync

更新所有未經修改的工作區實體並顯示已修改實體的衝突，將工作區同步處理至最新的容器版本。立即試用。

要求

HTTP 要求

POST https://www.googleapis.com/tagmanager/v2/+path:sync

參數

參數名稱 值 說明
路徑參數
path string GTM Workspace 的 API 相對路徑。範例：accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

授權

此要求需要取得下列範圍的授權：

範圍
https://www.googleapis.com/auth/tagmanager.edit.containers

詳情請參閱驗證和授權頁面。

要求主體

請勿使用這個方法提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "syncStatus": {
    "mergeConflict": boolean,
    "syncError": boolean
  },
  "mergeConflict": [
    {
      "entityInWorkspace": {
        "tag": accounts.containers.workspaces.tags Resource,
        "trigger": accounts.containers.workspaces.triggers Resource,
        "variable": accounts.containers.workspaces.variables Resource,
        "folder": accounts.containers.workspaces.folders Resource,
        "client": accounts.containers.workspaces.clients Resource,
        "transformation": accounts.containers.workspaces.transformations Resource,
        "changeStatus": string
      },
      "entityInBaseVersion": {
        "tag": accounts.containers.workspaces.tags Resource,
        "trigger": accounts.containers.workspaces.triggers Resource,
        "variable": accounts.containers.workspaces.variables Resource,
        "folder": accounts.containers.workspaces.folders Resource,
        "client": accounts.containers.workspaces.clients Resource,
        "transformation": accounts.containers.workspaces.transformations Resource,
        "changeStatus": string
      }
    }
  ]
}
屬性名稱 值 說明 附註
syncStatus nested object 指出同步處理是否導致合併衝突或同步處理錯誤。
syncStatus.mergeConflict boolean 同步處理作業偵測到合併衝突。
syncStatus.syncError boolean 同步處理作業發生錯誤。
mergeConflict[] list 同步處理後發生合併衝突。如果這個欄位未空白，系統仍會將同步處理視為成功。但必須先解決所有衝突，才能建立版本。
mergeConflict[].entityInWorkspace nested object 與基礎版本相比，變更不一致的 Workspace 實體。如果工作區中的實體遭到刪除，該實體仍會顯示已刪除的變更狀態。
mergeConflict[].entityInWorkspace.tag nested object 實體所代表的標記。
mergeConflict[].entityInWorkspace.trigger nested object 以實體表示的觸發條件。
mergeConflict[].entityInWorkspace.variable nested object 實體所代表的變數。
mergeConflict[].entityInWorkspace.folder nested object 實體代表的資料夾。
mergeConflict[].entityInWorkspace.changeStatus string 代表工作區中的實體已變更。

可接受的值為：
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object 與工作區相比，變更不一致的基礎版本實體 (自最近一次同步作業) 發生。如果缺少這個欄位，代表工作區實體已從基礎版本中刪除。
mergeConflict[].entityInBaseVersion.tag nested object 實體所代表的標記。
mergeConflict[].entityInBaseVersion.trigger nested object 以實體表示的觸發條件。
mergeConflict[].entityInBaseVersion.variable nested object 實體所代表的變數。
mergeConflict[].entityInBaseVersion.folder nested object 實體代表的資料夾。
mergeConflict[].entityInBaseVersion.changeStatus string 代表工作區中的實體已變更。

可接受的值為：
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object 實體代表的用戶端。
mergeConflict[].entityInBaseVersion.client nested object 實體代表的用戶端。
mergeConflict[].entityInWorkspace.transformation nested object 以實體表示的轉換。
mergeConflict[].entityInBaseVersion.transformation nested object 以實體表示的轉換。

試試看！

您可以使用下方的 APIs Explorer，針對即時資料呼叫這個方法，然後查看回應。