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,
        "zone": accounts.containers.workspaces.zones Resource,
        "customTemplate": accounts.containers.workspaces.templates Resource,
        "builtInVariable": {
          "path": string,
          "accountId": string,
          "containerId": string,
          "workspaceId": string,
          "type": string,
          "name": string
        },
        "gtagConfig": accounts.containers.workspaces.gtag_config 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,
        "zone": accounts.containers.workspaces.zones Resource,
        "customTemplate": accounts.containers.workspaces.templates Resource,
        "builtInVariable": {
          "path": string,
          "accountId": string,
          "containerId": string,
          "workspaceId": string,
          "type": string,
          "name": string
        },
        "gtagConfig": accounts.containers.workspaces.gtag_config 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 實體代表的轉換。
mergeConflict[].entityInWorkspace.zone nested object 實體代表的區域。
mergeConflict[].entityInWorkspace.customTemplate nested object 實體代表的自訂範本。
mergeConflict[].entityInWorkspace.builtInVariable nested object 實體代表的內建變數。
mergeConflict[].entityInWorkspace.builtInVariable.path string GTM BuiltInVariable 的 API 相對路徑。
mergeConflict[].entityInWorkspace.builtInVariable.accountId string GTM 帳戶 ID。
mergeConflict[].entityInWorkspace.builtInVariable.containerId string GTM 容器 ID。
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string GTM 工作區 ID。
mergeConflict[].entityInWorkspace.builtInVariable.type string 內建變數類型。

可接受的值為：
  • 「advertiserId」
  • 「advertisingTrackingEnabled」
  • 「ampBrowserLanguage」
  • 「ampCanonicalHost」
  • 「ampCanonicalPath」
  • 「ampCanonicalUrl」
  • 「ampClientId」
  • 「ampClientMaxScrollX」
  • 「ampClientMaxScrollY」
  • 「ampClientScreenHeight」
  • 「ampClientScreenWidth」
  • 「ampClientScrollX」
  • 「ampClientScrollY」
  • 「ampClientTimestamp」
  • 「ampClientTimezone」
  • 「ampGtmEvent」
  • 「ampPageDownloadTime」
  • 「ampPageLoadTime」
  • 「ampPageViewId」
  • 「ampReferrer」
  • 「ampTitle」
  • 「ampTotalEngagedTime」
  • 「appId」
  • 「appName」
  • 「appVersionCode」
  • 「appVersionName」
  • 「builtInVariableTypeUnspecified」
  • 「clickClasses」
  • 「clickElement」
  • 「clickId」
  • 「clickTarget」
  • 「clickText」
  • 「clickUrl」
  • 「clientName」
  • 「containerId」
  • 「containerVersion」
  • 「debugMode」
  • 「deviceName」
  • 「elementVisibilityFirstTime」
  • 「elementVisibilityRatio」
  • 「elementVisibilityRecentTime」
  • 「elementVisibilityTime」
  • 「environmentName」
  • 「errorLine」
  • 「errorMessage」
  • 「errorUrl」
  • 「event」
  • 「eventName」
  • 「firebaseEventParameterCampaign」
  • 「firebaseEventParameterCampaignAclid」
  • 「firebaseEventParameterCampaignAnid」
  • 「firebaseEventParameterCampaignClickTimestamp」
  • 「firebaseEventParameterCampaignContent」
  • 「firebaseEventParameterCampaignCp1」
  • 「firebaseEventParameterCampaignGclid」
  • 「firebaseEventParameterCampaignSource」
  • 「firebaseEventParameterCampaignTerm」
  • 「firebaseEventParameterCurrency」
  • 「firebaseEventParameterDynamicLinkAcceptTime」
  • 「firebaseEventParameterDynamicLinkLinkid」
  • 「firebaseEventParameterNotificationMessageDeviceTime」
  • 「firebaseEventParameterNotificationMessageId」
  • 「firebaseEventParameterNotificationMessageName」
  • 「firebaseEventParameterNotificationMessageTime」
  • 「firebaseEventParameterNotificationTopic」
  • 「firebaseEventParameterPreviousAppVersion」
  • 「firebaseEventParameterPreviousOsVersion」
  • 「firebaseEventParameterPrice」
  • 「firebaseEventParameterProductId」
  • 「firebaseEventParameterQuantity」
  • 「firebaseEventParameterValue」
  • 「firstPartyServingUrl」
  • 「formClasses」
  • 「formElement」
  • 「formId」
  • 「formTarget」
  • 「formText」
  • 「formUrl」
  • 「historySource」
  • 「htmlId」
  • 「language」
  • 「newHistoryFragment」
  • 「newHistoryState」
  • 「newHistoryUrl」
  • 「oldHistoryFragment」
  • 「oldHistoryState」
  • 「oldHistoryUrl」
  • 「osVersion」
  • 「pageHostname」
  • 「pagePath」
  • 「pageUrl」
  • 「platform」
  • 「queryString」
  • 「randomNumber」
  • 「referrer」
  • 「requestMethod」
  • 「requestPath」
  • 「resolution」
  • 「scrollDepthDirection」
  • 「scrollDepthThreshold」
  • 「scrollDepthUnits」
  • 「sdkVersion」
  • 「serverPageLocationHostname」
  • 「serverPageLocationPath」
  • 「serverPageLocationUrl」
  • 「videoCurrentTime」
  • 「videoDuration」
  • 「videoPercent」
  • 「videoProvider」
  • 「videoStatus」
  • 「videoTitle」
  • 「videoUrl」
  • 「videoVisible」
  • 「visitorRegion」
mergeConflict[].entityInWorkspace.builtInVariable.name string 參照內建變數的內建變數名稱。
mergeConflict[].entityInWorkspace.gtagConfig nested object 實體代表的 gtag 設定。
mergeConflict[].entityInBaseVersion.zone nested object 實體代表的區域。
mergeConflict[].entityInBaseVersion.customTemplate nested object 實體代表的自訂範本。
mergeConflict[].entityInBaseVersion.builtInVariable nested object 實體代表的內建變數。
mergeConflict[].entityInBaseVersion.builtInVariable.path string GTM BuiltInVariable 的 API 相對路徑。
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string GTM 帳戶 ID。
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string GTM 容器 ID。
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string GTM 工作區 ID。
mergeConflict[].entityInBaseVersion.builtInVariable.type string 內建變數類型。

可接受的值為：
  • 「advertiserId」
  • 「advertisingTrackingEnabled」
  • 「ampBrowserLanguage」
  • 「ampCanonicalHost」
  • 「ampCanonicalPath」
  • 「ampCanonicalUrl」
  • 「ampClientId」
  • 「ampClientMaxScrollX」
  • 「ampClientMaxScrollY」
  • 「ampClientScreenHeight」
  • 「ampClientScreenWidth」
  • 「ampClientScrollX」
  • 「ampClientScrollY」
  • 「ampClientTimestamp」
  • 「ampClientTimezone」
  • 「ampGtmEvent」
  • 「ampPageDownloadTime」
  • 「ampPageLoadTime」
  • 「ampPageViewId」
  • 「ampReferrer」
  • 「ampTitle」
  • 「ampTotalEngagedTime」
  • 「appId」
  • 「appName」
  • 「appVersionCode」
  • 「appVersionName」
  • 「builtInVariableTypeUnspecified」
  • 「clickClasses」
  • 「clickElement」
  • 「clickId」
  • 「clickTarget」
  • 「clickText」
  • 「clickUrl」
  • 「clientName」
  • 「containerId」
  • 「containerVersion」
  • 「debugMode」
  • 「deviceName」
  • 「elementVisibilityFirstTime」
  • 「elementVisibilityRatio」
  • 「elementVisibilityRecentTime」
  • 「elementVisibilityTime」
  • 「environmentName」
  • 「errorLine」
  • 「errorMessage」
  • 「errorUrl」
  • 「event」
  • 「eventName」
  • 「firebaseEventParameterCampaign」
  • 「firebaseEventParameterCampaignAclid」
  • 「firebaseEventParameterCampaignAnid」
  • 「firebaseEventParameterCampaignClickTimestamp」
  • 「firebaseEventParameterCampaignContent」
  • 「firebaseEventParameterCampaignCp1」
  • 「firebaseEventParameterCampaignGclid」
  • 「firebaseEventParameterCampaignSource」
  • 「firebaseEventParameterCampaignTerm」
  • 「firebaseEventParameterCurrency」
  • 「firebaseEventParameterDynamicLinkAcceptTime」
  • 「firebaseEventParameterDynamicLinkLinkid」
  • 「firebaseEventParameterNotificationMessageDeviceTime」
  • 「firebaseEventParameterNotificationMessageId」
  • 「firebaseEventParameterNotificationMessageName」
  • 「firebaseEventParameterNotificationMessageTime」
  • 「firebaseEventParameterNotificationTopic」
  • 「firebaseEventParameterPreviousAppVersion」
  • 「firebaseEventParameterPreviousOsVersion」
  • 「firebaseEventParameterPrice」
  • 「firebaseEventParameterProductId」
  • 「firebaseEventParameterQuantity」
  • 「firebaseEventParameterValue」
  • 「firstPartyServingUrl」
  • 「formClasses」
  • 「formElement」
  • 「formId」
  • 「formTarget」
  • 「formText」
  • 「formUrl」
  • 「historySource」
  • 「htmlId」
  • 「language」
  • 「newHistoryFragment」
  • 「newHistoryState」
  • 「newHistoryUrl」
  • 「oldHistoryFragment」
  • 「oldHistoryState」
  • 「oldHistoryUrl」
  • 「osVersion」
  • 「pageHostname」
  • 「pagePath」
  • 「pageUrl」
  • 「platform」
  • 「queryString」
  • 「randomNumber」
  • 「referrer」
  • 「requestMethod」
  • 「requestPath」
  • 「resolution」
  • 「scrollDepthDirection」
  • 「scrollDepthThreshold」
  • 「scrollDepthUnits」
  • 「sdkVersion」
  • 「serverPageLocationHostname」
  • 「serverPageLocationPath」
  • 「serverPageLocationUrl」
  • 「videoCurrentTime」
  • 「videoDuration」
  • 「videoPercent」
  • 「videoProvider」
  • 「videoStatus」
  • 「videoTitle」
  • 「videoUrl」
  • 「videoVisible」
  • 「visitorRegion」
mergeConflict[].entityInBaseVersion.builtInVariable.name string 參照內建變數的內建變數名稱。
mergeConflict[].entityInBaseVersion.gtagConfig nested object 實體代表的 gtag 設定。

試試看！

使用下方的 APIs Explorer，針對即時資料呼叫這個方法，看看會有什麼結果。