Workspaces: sync

Menyinkronkan ruang kerja ke versi penampung terbaru dengan memperbarui semua entity ruang kerja yang tidak diubah dan menampilkan konflik untuk entitas yang diubah. 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 mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Jangan berikan 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,
        "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
      }
    }
  ]
}
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 kesalahan selama operasi sinkronisasi.
mergeConflict[] list Konflik penggabungan setelah sinkronisasi. Jika kolom ini tidak kosong, sinkronisasi tetap dianggap berhasil. Namun, versi tidak dapat dibuat sebelum 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 telah dihapus.
mergeConflict[].entityInWorkspace.tag nested object Tag yang diwakili oleh entitas.
mergeConflict[].entityInWorkspace.trigger nested object Pemicu yang diwakili oleh entity.
mergeConflict[].entityInWorkspace.variable nested object Variabel yang diwakili oleh entity.
mergeConflict[].entityInWorkspace.folder nested object Folder yang diwakili oleh entity.
mergeConflict[].entityInWorkspace.changeStatus string Menunjukkan bagaimana entitas telah diubah di ruang kerja.

Nilai yang dapat diterima:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object Entitas versi dasar (sejak operasi sinkronisasi terbaru) 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 diwakili oleh entity.
mergeConflict[].entityInBaseVersion.variable nested object Variabel yang diwakili oleh entity.
mergeConflict[].entityInBaseVersion.folder nested object Folder yang diwakili oleh entity.
mergeConflict[].entityInBaseVersion.changeStatus string Menunjukkan bagaimana entitas telah diubah di ruang kerja.

Nilai yang dapat diterima:
  • "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 direpresentasikan oleh entity.
mergeConflict[].entityInBaseVersion.transformation nested object Transformasi yang direpresentasikan oleh entity.
mergeConflict[].entityInWorkspace.zone nested object Zona yang diwakili oleh entity.
mergeConflict[].entityInWorkspace.customTemplate nested object Template kustom yang direpresentasikan oleh entitas.
mergeConflict[].entityInWorkspace.builtInVariable nested object Variabel built-in yang direpresentasikan oleh entity.
mergeConflict[].entityInWorkspace.builtInVariable.path string Jalur relatif API BuiltInVariable GTM.
mergeConflict[].entityInWorkspace.builtInVariable.accountId string ID Akun GTM.
mergeConflict[].entityInWorkspace.builtInVariable.containerId string ID Penampung GTM.
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string ID Workspace GTM.
mergeConflict[].entityInWorkspace.builtInVariable.type string Jenis variabel built-in.

Nilai yang dapat diterima:
  • "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 Nama variabel built-in yang akan digunakan untuk merujuk ke variabel built-in.
mergeConflict[].entityInWorkspace.gtagConfig nested object Konfigurasi gtag yang diwakili oleh entity.
mergeConflict[].entityInBaseVersion.zone nested object Zona yang diwakili oleh entity.
mergeConflict[].entityInBaseVersion.customTemplate nested object Template kustom yang direpresentasikan oleh entitas.
mergeConflict[].entityInBaseVersion.builtInVariable nested object Variabel built-in yang direpresentasikan oleh entity.
mergeConflict[].entityInBaseVersion.builtInVariable.path string Jalur relatif API BuiltInVariable GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string ID Akun GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string ID Penampung GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string ID Workspace GTM.
mergeConflict[].entityInBaseVersion.builtInVariable.type string Jenis variabel built-in.

Nilai yang dapat diterima:
  • "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 Nama variabel built-in yang akan digunakan untuk merujuk ke variabel built-in.
mergeConflict[].entityInBaseVersion.gtagConfig nested object Konfigurasi gtag yang diwakili oleh entity.

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data langsung dan melihat responsnya.