Workspaces: sync

Synchronise un espace de travail avec la dernière version du conteneur en mettant à jour toutes les entités de l'espace de travail non modifiées et en affichant les conflits pour les entités modifiées. Essayer maintenant

Requête

Requête HTTP

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

Paramètres

Nom du paramètre Valeur Description
Paramètres de chemin d'accès
path string Chemin relatif de l'API Workspace de GTM. Exemple : accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant:

Champ d'application
https://www.googleapis.com/auth/tagmanager.edit.containers

Pour plus d'informations, consultez la page Authentification et autorisation.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "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
      }
    }
  ]
}
Nom de propriété Valeur Description Remarques
syncStatus nested object Indique si la synchronisation a provoqué un conflit de fusion ou une erreur de synchronisation.
syncStatus.mergeConflict boolean Une opération de synchronisation a détecté un conflit de fusion.
syncStatus.syncError boolean Une erreur s'est produite lors de l'opération de synchronisation.
mergeConflict[] list Conflit de fusion après la synchronisation. Si ce champ n'est pas vide, la synchronisation est quand même traitée comme réussie. Toutefois, il est impossible de créer une version tant que tous les conflits ne sont pas résolus.
mergeConflict[].entityInWorkspace nested object Entité d'espace de travail qui présente des modifications en conflit par rapport à la version de base. Si une entité est supprimée d'un espace de travail, elle apparaîtra toujours avec l'état de modification "Supprimée".
mergeConflict[].entityInWorkspace.tag nested object Tag représenté par l'entité.
mergeConflict[].entityInWorkspace.trigger nested object Déclencheur représenté par l'entité.
mergeConflict[].entityInWorkspace.variable nested object Variable représentée par l'entité.
mergeConflict[].entityInWorkspace.folder nested object Dossier représenté par l'entité.
mergeConflict[].entityInWorkspace.changeStatus string Représente la manière dont l'entité a été modifiée dans l'espace de travail.

Les valeurs possibles sont les suivantes :
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object Entité de la version de base (depuis la dernière opération de synchronisation) ayant des modifications conflictuelles par rapport à l'espace de travail. Si ce champ n'est pas renseigné, cela signifie que l'entité d'espace de travail a été supprimée de la version de base.
mergeConflict[].entityInBaseVersion.tag nested object Tag représenté par l'entité.
mergeConflict[].entityInBaseVersion.trigger nested object Déclencheur représenté par l'entité.
mergeConflict[].entityInBaseVersion.variable nested object Variable représentée par l'entité.
mergeConflict[].entityInBaseVersion.folder nested object Dossier représenté par l'entité.
mergeConflict[].entityInBaseVersion.changeStatus string Représente la manière dont l'entité a été modifiée dans l'espace de travail.

Les valeurs possibles sont les suivantes :
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object Client représenté par l'entité.
mergeConflict[].entityInBaseVersion.client nested object Client représenté par l'entité.
mergeConflict[].entityInWorkspace.transformation nested object Transformation représentée par l'entité.
mergeConflict[].entityInBaseVersion.transformation nested object Transformation représentée par l'entité.
mergeConflict[].entityInWorkspace.zone nested object Zone représentée par l'entité.
mergeConflict[].entityInWorkspace.customTemplate nested object Modèle personnalisé représenté par l'entité.
mergeConflict[].entityInWorkspace.builtInVariable nested object Variable intégrée représentée par l'entité.
mergeConflict[].entityInWorkspace.builtInVariable.path string Chemin relatif de l'API de GTM Variable Intégrée.
mergeConflict[].entityInWorkspace.builtInVariable.accountId string ID de compte GTM.
mergeConflict[].entityInWorkspace.builtInVariable.containerId string ID du conteneur GTM.
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string ID d'espace de travail GTM.
mergeConflict[].entityInWorkspace.builtInVariable.type string Type de variable intégrée.

Les valeurs possibles sont les suivantes :
  • "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 Nom de la variable intégrée à utiliser pour faire référence à la variable intégrée.
mergeConflict[].entityInWorkspace.gtagConfig nested object Configuration gtag représentée par l'entité.
mergeConflict[].entityInBaseVersion.zone nested object Zone représentée par l'entité.
mergeConflict[].entityInBaseVersion.customTemplate nested object Modèle personnalisé représenté par l'entité.
mergeConflict[].entityInBaseVersion.builtInVariable nested object Variable intégrée représentée par l'entité.
mergeConflict[].entityInBaseVersion.builtInVariable.path string Chemin relatif de l'API de GTM Variable Intégrée.
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string ID de compte GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string ID du conteneur GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string ID d'espace de travail GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.type string Type de variable intégrée.

Les valeurs possibles sont les suivantes :
  • "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 Nom de la variable intégrée à utiliser pour faire référence à la variable intégrée.
mergeConflict[].entityInBaseVersion.gtagConfig nested object Configuration gtag représentée par l'entité.

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.