Workspaces: sync

更新所有未经修改的工作区实体，并显示已修改实体之间的冲突，从而将工作区同步到最新容器版本。立即试用。

请求

HTTP 请求

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

参数

参数名称 值 说明
路径参数
path string GTM 工作区的 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 与基础版本相比，工作区实体存在相互冲突的更改。如果在工作区中删除某个实体，该实体仍会显示，但带有“已删除”更改状态。
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 内置变量的 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 内置变量的 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 配置。

试试看！

请使用下面的 API Explorer 针对实际数据调用此方法并查看响应。