Workspaces: sync

Synchronisiert einen Arbeitsbereich mit der neuesten Containerversion, indem alle unveränderten Arbeitsbereichsentitäten aktualisiert und Konflikte für geänderte Entitäten angezeigt werden. Jetzt testen

Anfrage

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Pfadparameter
path string Der relative API-Pfad von GTM Workspace. Beispiel: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Autorisierung

Für diese Anfrage ist eine Autorisierung in folgendem Bereich erforderlich:

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

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "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
      }
    }
  ]
}
Name der Eigenschaft Wert Beschreibung Hinweise
syncStatus nested object Gibt an, ob die Synchronisierung einen Zusammenführungskonflikt oder einen Synchronisierungsfehler verursacht hat.
syncStatus.mergeConflict boolean Bei der Synchronisierung wurde ein Zusammenführungskonflikt festgestellt.
syncStatus.syncError boolean Bei der Synchronisierung ist ein Fehler aufgetreten.
mergeConflict[] list Der Zusammenführungskonflikt nach der Synchronisierung. Wenn dieses Feld nicht leer ist, wird die Synchronisierung trotzdem als erfolgreich betrachtet. Eine Version kann jedoch erst erstellt werden, wenn alle Konflikte behoben sind.
mergeConflict[].entityInWorkspace nested object Die Arbeitsbereichsentität mit widersprüchlichen Änderungen im Vergleich zur Basisversion. Wenn eine Entität in einem Arbeitsbereich gelöscht wird, wird sie weiterhin mit dem Status „Gelöscht“ angezeigt.
mergeConflict[].entityInWorkspace.tag nested object Das Tag, das von der Entität dargestellt wird.
mergeConflict[].entityInWorkspace.trigger nested object Der Trigger, der durch die Entität dargestellt wird.
mergeConflict[].entityInWorkspace.variable nested object Die Variable, die durch die Entität dargestellt wird.
mergeConflict[].entityInWorkspace.folder nested object Der Ordner, der durch die Entität dargestellt wird.
mergeConflict[].entityInWorkspace.changeStatus string Stellt dar, wie die Entität im Arbeitsbereich geändert wurde.

Zulässige Werte sind:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object Die Basisversionsentität (seit dem letzten Synchronisierungsvorgang), die widersprüchliche Änderungen im Vergleich zum Arbeitsbereich aufweist. Wenn dieses Feld fehlt, bedeutet dies, dass die Arbeitsbereichsentität aus der Basisversion gelöscht wurde.
mergeConflict[].entityInBaseVersion.tag nested object Das Tag, das von der Entität dargestellt wird.
mergeConflict[].entityInBaseVersion.trigger nested object Der Trigger, der durch die Entität dargestellt wird.
mergeConflict[].entityInBaseVersion.variable nested object Die Variable, die durch die Entität dargestellt wird.
mergeConflict[].entityInBaseVersion.folder nested object Der Ordner, der durch die Entität dargestellt wird.
mergeConflict[].entityInBaseVersion.changeStatus string Stellt dar, wie die Entität im Arbeitsbereich geändert wurde.

Zulässige Werte sind:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object Der Client, der durch die Entität repräsentiert wird.
mergeConflict[].entityInBaseVersion.client nested object Der Client, der durch die Entität repräsentiert wird.
mergeConflict[].entityInWorkspace.transformation nested object Die Transformation, die durch die Entität dargestellt wird.
mergeConflict[].entityInBaseVersion.transformation nested object Die Transformation, die durch die Entität dargestellt wird.

Jetzt testen

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.