Workspaces: sync

ซิงค์พื้นที่ทำงานกับคอนเทนเนอร์เวอร์ชันล่าสุดด้วยการอัปเดตเอนทิตีพื้นที่ทำงานที่ไม่มีการแก้ไขทั้งหมดและแสดงความขัดแย้งของเอนทิตีที่แก้ไขแล้ว ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
path string เส้นทางที่เกี่ยวข้อง API ของ GTM Workspace ตัวอย่าง: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

การให้สิทธิ์

คำขอนี้ต้องได้รับการให้สิทธิ์ตามขอบเขตต่อไปนี้

ขอบเขต
https://www.googleapis.com/auth/tagmanager.edit.containers

สำหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อหาของคำขอ

โปรดอย่าให้เนื้อหาคำขอตามวิธีการนี้

คำตอบ

หากสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับซึ่งมีโครงสร้างต่อไปนี้

{
  "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
      }
    }
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
syncStatus nested object ระบุว่าการซิงค์ทำให้เกิดความขัดแย้งของการรวมหรือข้อผิดพลาดในการซิงค์หรือไม่
syncStatus.mergeConflict boolean การดำเนินการซิงค์ตรวจพบความขัดแย้งในการรวม
syncStatus.syncError boolean เกิดข้อผิดพลาดในระหว่างการซิงค์
mergeConflict[] list เกิดความขัดแย้งของการผสานหลังจากการซิงค์ หากช่องนี้ไม่ว่าง ระบบจะยังคงถือว่าการซิงค์สำเร็จ แต่จะสร้างเวอร์ชันไม่ได้จนกว่าจะแก้ไขความขัดแย้งทั้งหมดเรียบร้อยแล้ว
mergeConflict[].entityInWorkspace nested object เอนทิตีพื้นที่ทำงานที่มีการเปลี่ยนแปลงที่ขัดแย้งกันเมื่อเทียบกับเวอร์ชันฐาน หากลบเอนทิตีในพื้นที่ทำงาน เอนทิตีจะยังคงปรากฏโดยมีสถานะการเปลี่ยนแปลงที่ถูกลบ
mergeConflict[].entityInWorkspace.tag nested object แท็กที่เอนทิตีแสดงไว้
mergeConflict[].entityInWorkspace.trigger nested object ทริกเกอร์ที่เอนทิตีแสดง
mergeConflict[].entityInWorkspace.variable nested object ตัวแปรที่เอนทิตีแสดง
mergeConflict[].entityInWorkspace.folder nested object โฟลเดอร์ที่เอนทิตีแสดงไว้
mergeConflict[].entityInWorkspace.changeStatus string แสดงให้เห็นว่ามีการเปลี่ยนแปลงเอนทิตีในพื้นที่ทำงานอย่างไร

ค่าที่ยอมรับได้ มีดังนี้
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object เอนทิตีเวอร์ชันฐาน (นับตั้งแต่การดำเนินการซิงค์ล่าสุด) ที่มีการเปลี่ยนแปลงที่ขัดแย้งกันเมื่อเทียบกับพื้นที่ทำงาน หากช่องนี้ขาดหายไป แสดงว่าเอนทิตี Workspace ถูกลบออกจากเวอร์ชันฐานแล้ว
mergeConflict[].entityInBaseVersion.tag nested object แท็กที่เอนทิตีแสดงไว้
mergeConflict[].entityInBaseVersion.trigger nested object ทริกเกอร์ที่เอนทิตีแสดง
mergeConflict[].entityInBaseVersion.variable nested object ตัวแปรที่เอนทิตีแสดง
mergeConflict[].entityInBaseVersion.folder nested object โฟลเดอร์ที่เอนทิตีแสดงไว้
mergeConflict[].entityInBaseVersion.changeStatus string แสดงให้เห็นว่ามีการเปลี่ยนแปลงเอนทิตีในพื้นที่ทำงานอย่างไร

ค่าที่ยอมรับได้ มีดังนี้
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInWorkspace.client nested object ลูกค้าที่เอนทิตีเป็นตัวแทน
mergeConflict[].entityInBaseVersion.client nested object ลูกค้าที่เอนทิตีเป็นตัวแทน
mergeConflict[].entityInWorkspace.transformation nested object การเปลี่ยนรูปแบบที่เอนทิตีแสดง
mergeConflict[].entityInBaseVersion.transformation nested object การเปลี่ยนรูปแบบที่เอนทิตีแสดง
mergeConflict[].entityInWorkspace.zone nested object โซนที่เอนทิตีเป็นตัวแทน
mergeConflict[].entityInWorkspace.customTemplate nested object เทมเพลตที่กำหนดเองซึ่งเอนทิตีแสดงไว้
mergeConflict[].entityInWorkspace.builtInVariable nested object ตัวแปรบิวท์อินที่เอนทิตีแสดง
mergeConflict[].entityInWorkspace.builtInVariable.path string เส้นทางที่เกี่ยวข้อง API ของ GTM BuiltInVariable
mergeConflict[].entityInWorkspace.builtInVariable.accountId string รหัสบัญชี GTM
mergeConflict[].entityInWorkspace.builtInVariable.containerId string รหัสคอนเทนเนอร์ GTM
mergeConflict[].entityInWorkspace.builtInVariable.workspaceId string รหัสพื้นที่ทำงาน GTM
mergeConflict[].entityInWorkspace.builtInVariable.type string ประเภทของตัวแปรบิวท์อิน

ค่าที่ยอมรับได้ มีดังนี้
  • "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 ชื่อของตัวแปรบิวท์อินที่จะใช้เพื่ออ้างถึงตัวแปรบิวท์อิน
mergeConflict[].entityInWorkspace.gtagConfig nested object การกําหนดค่า gtag ที่แสดงโดยเอนทิตี
mergeConflict[].entityInBaseVersion.zone nested object โซนที่เอนทิตีเป็นตัวแทน
mergeConflict[].entityInBaseVersion.customTemplate nested object เทมเพลตที่กำหนดเองซึ่งเอนทิตีแสดงไว้
mergeConflict[].entityInBaseVersion.builtInVariable nested object ตัวแปรบิวท์อินที่เอนทิตีแสดง
mergeConflict[].entityInBaseVersion.builtInVariable.path string เส้นทางที่เกี่ยวข้อง API ของ GTM BuiltInVariable
mergeConflict[].entityInBaseVersion.builtInVariable.accountId string รหัสบัญชี GTM
mergeConflict[].entityInBaseVersion.builtInVariable.containerId string รหัสคอนเทนเนอร์ GTM
mergeConflict[].entityInBaseVersion.builtInVariable.workspaceId string รหัสพื้นที่ทำงาน GTM
mergeConflict[].entityInBaseVersion.builtInVariable.type string ประเภทของตัวแปรบิวท์อิน

ค่าที่ยอมรับได้ มีดังนี้
  • "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 ชื่อของตัวแปรบิวท์อินที่จะใช้เพื่ออ้างถึงตัวแปรบิวท์อิน
mergeConflict[].entityInBaseVersion.gtagConfig nested object การกําหนดค่า gtag ที่แสดงโดยเอนทิตี

ลองใช้เลย

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ