Workspaces: sync

Menyinkronkan ruang kerja ke versi penampung terbaru dengan memperbarui semua entity ruang kerja yang tidak dimodifikasi dan menampilkan konflik untuk entitas yang dimodifikasi. Coba sekarang.

Permintaan

Permintaan HTTP

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

Parameter

Nama parameter Nilai Deskripsi
Parameter jalur
path string Jalur relatif API Workspace GTM. Contoh: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Otorisasi

Permintaan ini memerlukan otorisasi dengan cakupan berikut:

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

Untuk informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Jangan memberikan isi permintaan dengan metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "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
      }
    }
  ]
}
Nama properti Nilai Deskripsi Catatan
syncStatus nested object Menunjukkan apakah sinkronisasi menyebabkan konflik penggabungan atau error sinkronisasi.
syncStatus.mergeConflict boolean Operasi sinkronisasi mendeteksi konflik penggabungan.
syncStatus.syncError boolean Terjadi error selama operasi sinkronisasi.
mergeConflict[] list Penggabungan bentrok setelah sinkronisasi. Jika kolom ini tidak kosong, sinkronisasi tetap dianggap berhasil. Namun, versi tidak dapat dibuat sampai semua konflik diselesaikan.
mergeConflict[].entityInWorkspace nested object Entitas ruang kerja yang memiliki perubahan yang bertentangan dibandingkan dengan versi dasar. Jika dihapus di ruang kerja, entitas akan tetap muncul dengan status perubahan yang dihapus.
mergeConflict[].entityInWorkspace.tag nested object Tag yang diwakili oleh entitas.
mergeConflict[].entityInWorkspace.trigger nested object Pemicu yang direpresentasikan oleh entity.
mergeConflict[].entityInWorkspace.variable nested object Variabel yang direpresentasikan oleh entity.
mergeConflict[].entityInWorkspace.folder nested object Folder yang diwakili oleh entity.
mergeConflict[].entityInWorkspace.changeStatus string Menunjukkan bagaimana entity telah diubah di ruang kerja.

Nilai yang dapat diterima adalah:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object Entitas versi dasar (sejak operasi sinkronisasi terakhir) yang memiliki perubahan yang bertentangan dibandingkan dengan ruang kerja. Jika kolom ini tidak ada, berarti entitas ruang kerja dihapus dari versi dasar.
mergeConflict[].entityInBaseVersion.tag nested object Tag yang diwakili oleh entitas.
mergeConflict[].entityInBaseVersion.trigger nested object Pemicu yang direpresentasikan oleh entity.
mergeConflict[].entityInBaseVersion.variable nested object Variabel yang direpresentasikan oleh entity.
mergeConflict[].entityInBaseVersion.folder nested object Folder yang diwakili oleh entity.
mergeConflict[].entityInBaseVersion.changeStatus string Menunjukkan bagaimana entity telah diubah di ruang kerja.

Nilai yang dapat diterima adalah:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object Klien yang diwakili oleh entitas.
mergeConflict[].entityInBaseVersion.client nested object Klien yang diwakili oleh entitas.
mergeConflict[].entityInWorkspace.transformation nested object Transformasi yang diwakili oleh entity.
mergeConflict[].entityInBaseVersion.transformation nested object Transformasi yang diwakili oleh entity.

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan melihat respons.