Workspaces: sync

Synchronise un espace de travail avec la dernière version du conteneur en mettant à jour toutes les entités d'espace de travail non modifiées et en affichant les conflits associés aux 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 d'accès relatif de l'API de l'espace de travail 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:

Définition du champ d'application
https://www.googleapis.com/auth/tagmanager.edit.containers

Pour en savoir plus, 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,
        "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
      }
    }
  ]
}
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 L'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 considérée comme réussie. Toutefois, il n'est pas possible de créer une version tant que tous les conflits ne sont pas résolus.
mergeConflict[].entityInWorkspace nested object Entité de l'espace de travail dont les modifications sont incompatibles par rapport à la version de base. Si une entité est supprimée d'un espace de travail, son état de modification "supprimée" apparaît toujours.
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.

Valeurs acceptées :
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object Entité de la version de base (depuis la dernière opération de synchronisation) dont les modifications sont incompatibles par rapport à l'espace de travail. Si ce champ est manquant, 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.

Valeurs acceptées :
  • "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é.

Essayer

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