Workspaces: sync

Sincronizza un'area di lavoro con l'ultima versione del contenitore aggiornando tutte le entità dell'area di lavoro non modificate e visualizzando i conflitti per le entità modificate. Prova subito.

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametro Valore Descrizione
Parametri percorso
path string Percorso relativo dell'API di GTM Workspace. Esempio: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito:

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

Per ulteriori informazioni, consulta la pagina Autenticazione e autorizzazione.

Corpo della richiesta

Non fornire un corpo della richiesta con questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "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 proprietà Valore Descrizione Note
syncStatus nested object Indica se la sincronizzazione ha causato un conflitto di unione o un errore di sincronizzazione.
syncStatus.mergeConflict boolean L'operazione di sincronizzazione ha rilevato un conflitto di unione.
syncStatus.syncError boolean Si è verificato un errore durante l'operazione di sincronizzazione.
mergeConflict[] list Conflitto di unione dopo la sincronizzazione. Se questo campo non è vuoto, la sincronizzazione viene comunque considerata riuscita. Tuttavia, non è possibile creare una versione finché non sono stati risolti tutti i conflitti.
mergeConflict[].entityInWorkspace nested object L'entità dell'area di lavoro con modifiche in conflitto rispetto alla versione di base. Se un'entità viene eliminata in un'area di lavoro, continuerà a essere visualizzata con lo stato di modifica Eliminata.
mergeConflict[].entityInWorkspace.tag nested object Il tag rappresentato dall'entità.
mergeConflict[].entityInWorkspace.trigger nested object L'attivatore rappresentato dall'entità.
mergeConflict[].entityInWorkspace.variable nested object La variabile rappresentata dall'entità.
mergeConflict[].entityInWorkspace.folder nested object La cartella rappresentata dall'entità.
mergeConflict[].entityInWorkspace.changeStatus string Rappresenta il modo in cui l'entità è stata modificata nell'area di lavoro.

I valori accettati sono:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object L'entità della versione di base (dall'ultima operazione di sincronizzazione) con modifiche in conflitto rispetto all'area di lavoro. Se questo campo non è presente, significa che l'entità Workspace è stata eliminata dalla versione di base.
mergeConflict[].entityInBaseVersion.tag nested object Il tag rappresentato dall'entità.
mergeConflict[].entityInBaseVersion.trigger nested object L'attivatore rappresentato dall'entità.
mergeConflict[].entityInBaseVersion.variable nested object La variabile rappresentata dall'entità.
mergeConflict[].entityInBaseVersion.folder nested object La cartella rappresentata dall'entità.
mergeConflict[].entityInBaseVersion.changeStatus string Rappresenta il modo in cui l'entità è stata modificata nell'area di lavoro.

I valori accettati sono:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object Il cliente rappresentato dall'entità.
mergeConflict[].entityInBaseVersion.client nested object Il cliente rappresentato dall'entità.
mergeConflict[].entityInWorkspace.transformation nested object La trasformazione rappresentata dall'entità.
mergeConflict[].entityInBaseVersion.transformation nested object La trasformazione rappresentata dall'entità.
mergeConflict[].entityInWorkspace.zone nested object La zona rappresentata dall'entità.
mergeConflict[].entityInWorkspace.customTemplate nested object Il modello personalizzato rappresentato dall'entità.
mergeConflict[].entityInWorkspace.builtInVariable nested object La variabile creata in modo che sia rappresentata dall'entità.
mergeConflict[].entityInWorkspace.builtInVariable.path string Percorso relativo dell'API di GTM integrato.
mergeConflict[].entityInWorkspace.builtInVariable.accountId string ID account GTM.
mergeConflict[].entityInWorkspace.builtInVariable.containerId string ID contenitore GTM.
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string ID area di lavoro GTM.
mergeConflict[].entityInWorkspace.builtInVariable.type string Tipo di variabile integrata.

I valori accettati sono:
  • "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 della variabile integrata da utilizzare per fare riferimento alla variabile integrata.
mergeConflict[].entityInWorkspace.gtagConfig nested object Il gtag config rappresentato dall'entità.
mergeConflict[].entityInBaseVersion.zone nested object La zona rappresentata dall'entità.
mergeConflict[].entityInBaseVersion.customTemplate nested object Il modello personalizzato rappresentato dall'entità.
mergeConflict[].entityInBaseVersion.builtInVariable nested object La variabile creata in modo che sia rappresentata dall'entità.
mergeConflict[].entityInBaseVersion.builtInVariable.path string Percorso relativo dell'API di GTM integrato.
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string ID account GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string ID contenitore GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string ID area di lavoro GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.type string Tipo di variabile integrata.

I valori accettati sono:
  • "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 della variabile integrata da utilizzare per fare riferimento alla variabile integrata.
mergeConflict[].entityInBaseVersion.gtagConfig nested object Il gtag config rappresentato dall'entità.

Prova.

Usa Explorer API in basso per chiamare questo metodo sui dati in tempo reale e visualizzare la risposta.