注意:此开发者网站正在向 developers.google.com/tag-platform 迁移,2021 年 9 月 30 日起系统会将您重定向到新的网址

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,
        "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,
        "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

试用一下!

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