Workspaces: sync

Sincroniza um espaço de trabalho com a versão mais recente do contêiner atualizando todas as entidades de espaço de trabalho não modificadas e exibindo os conflitos das que foram modificadas. Faça um teste.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
path string Caminho relacionado à API do Workspace do GTM. Por exemplo: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/tagmanager.edit.containers

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "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
      }
    }
  ]
}
Nome da propriedade Valor Descrição Observações
syncStatus nested object Indica se a sincronização causou um conflito de integração ou um erro de sincronização.
syncStatus.mergeConflict boolean A operação de sincronização detectou um conflito de integração.
syncStatus.syncError boolean Ocorreu um erro durante a operação de sincronização.
mergeConflict[] list Conflito de integração após a sincronização. Se esse campo estiver preenchido, a sincronização será tratada como bem-sucedida. No entanto, não é possível criar uma versão até que todos os conflitos sejam resolvidos.
mergeConflict[].entityInWorkspace nested object Entidade do espaço de trabalho que tem alterações conflitantes em comparação com a versão original. Se uma entidade for excluída de um espaço de trabalho, ela ainda aparecerá com um status de alteração excluído.
mergeConflict[].entityInWorkspace.tag nested object Tag representada pela entidade.
mergeConflict[].entityInWorkspace.trigger nested object Acionador representado pela entidade.
mergeConflict[].entityInWorkspace.variable nested object Variável representada pela entidade.
mergeConflict[].entityInWorkspace.folder nested object Pasta representada pela entidade.
mergeConflict[].entityInWorkspace.changeStatus string Representa como a entidade foi alterada no espaço de trabalho.

Os valores aceitáveis são:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object Entidade da versão original (desde a operação de sincronização mais recente) que tem alterações conflitantes em comparação com o espaço de trabalho. Se este campo estiver ausente, significa que a entidade do espaço de trabalho foi excluída da versão original.
mergeConflict[].entityInBaseVersion.tag nested object Tag representada pela entidade.
mergeConflict[].entityInBaseVersion.trigger nested object Acionador representado pela entidade.
mergeConflict[].entityInBaseVersion.variable nested object Variável representada pela entidade.
mergeConflict[].entityInBaseVersion.folder nested object Pasta representada pela entidade.
mergeConflict[].entityInBaseVersion.changeStatus string Representa como a entidade foi alterada no espaço de trabalho.

Os valores aceitáveis são:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object O cliente sendo representado pela entidade.
mergeConflict[].entityInBaseVersion.client nested object O cliente sendo representado pela entidade.
mergeConflict[].entityInWorkspace.transformation nested object A transformação que está sendo representada pela entidade.
mergeConflict[].entityInBaseVersion.transformation nested object A transformação que está sendo representada pela entidade.

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.