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,
        "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
      }
    }
  ]
}
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 representada pela entidade.
mergeConflict[].entityInBaseVersion.transformation nested object A transformação representada pela entidade.
mergeConflict[].entityInWorkspace.zone nested object Zona representada pela entidade.
mergeConflict[].entityInWorkspace.customTemplate nested object O modelo personalizado que é representado pela entidade.
mergeConflict[].entityInWorkspace.builtInVariable nested object Variável integrada representada pela entidade.
mergeConflict[].entityInWorkspace.builtInVariable.path string Caminho relacionado à API do BuiltInVariable do GTM.
mergeConflict[].entityInWorkspace.builtInVariable.accountId string Código do Account do GTM.
mergeConflict[].entityInWorkspace.builtInVariable.containerId string Código do Container do GTM.
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string Código do Workspace do GTM.
mergeConflict[].entityInWorkspace.builtInVariable.type string Tipo de variável incorporada.

Os valores aceitáveis são:
  • "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 Nome da variável incorporada a ser usado para se referir a ela.
mergeConflict[].entityInWorkspace.gtagConfig nested object A configuração da gtag representada pela entidade.
mergeConflict[].entityInBaseVersion.zone nested object Zona representada pela entidade.
mergeConflict[].entityInBaseVersion.customTemplate nested object O modelo personalizado que é representado pela entidade.
mergeConflict[].entityInBaseVersion.builtInVariable nested object Variável integrada representada pela entidade.
mergeConflict[].entityInBaseVersion.builtInVariable.path string Caminho relacionado à API do BuiltInVariable do GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string Código do Account do GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string Código do Container do GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string Código do Workspace do GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.type string Tipo de variável incorporada.

Os valores aceitáveis são:
  • "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 Nome da variável incorporada a ser usado para se referir a ela.
mergeConflict[].entityInBaseVersion.gtagConfig nested object A configuração da gtag representada pela entidade.

Confira!

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