REST Resource: accounts.containers.workspaces.triggers

แหล่งข้อมูล: ทริกเกอร์

แสดงถึงทริกเกอร์ Google Tag Manager

การแสดง JSON
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "triggerId": string,
  "name": string,
  "type": enum (EventType),
  "customEventFilter": [
    {
      object (Condition)
    }
  ],
  "filter": [
    {
      object (Condition)
    }
  ],
  "autoEventFilter": [
    {
      object (Condition)
    }
  ],
  "waitForTags": {
    object (Parameter)
  },
  "checkValidation": {
    object (Parameter)
  },
  "waitForTagsTimeout": {
    object (Parameter)
  },
  "uniqueTriggerId": {
    object (Parameter)
  },
  "eventName": {
    object (Parameter)
  },
  "interval": {
    object (Parameter)
  },
  "limit": {
    object (Parameter)
  },
  "fingerprint": string,
  "parentFolderId": string,
  "selector": {
    object (Parameter)
  },
  "intervalSeconds": {
    object (Parameter)
  },
  "maxTimerLengthSeconds": {
    object (Parameter)
  },
  "verticalScrollPercentageList": {
    object (Parameter)
  },
  "horizontalScrollPercentageList": {
    object (Parameter)
  },
  "visibilitySelector": {
    object (Parameter)
  },
  "visiblePercentageMin": {
    object (Parameter)
  },
  "visiblePercentageMax": {
    object (Parameter)
  },
  "continuousTimeMinMilliseconds": {
    object (Parameter)
  },
  "totalTimeMinMilliseconds": {
    object (Parameter)
  },
  "tagManagerUrl": string,
  "notes": string,
  "parameter": [
    {
      object (Parameter)
    }
  ]
}
ช่อง
path

string

เส้นทางแบบสัมพัทธ์ของ API ของทริกเกอร์ GTM

accountId

string

รหัสบัญชี GTM

containerId

string

รหัสคอนเทนเนอร์ GTM

workspaceId

string

รหัสพื้นที่ทํางาน GTM

triggerId

string

รหัสทริกเกอร์จะระบุทริกเกอร์ GTM ได้อย่างไม่ซ้ำกัน

name

string

ชื่อที่แสดงของทริกเกอร์

type

enum (EventType)

กําหนดเหตุการณ์ในชั้นข้อมูลที่ทริกเกอร์เหตุการณ์นี้

customEventFilter[]

object (Condition)

ใช้ในกรณีที่เป็นเหตุการณ์ที่กําหนดเอง ซึ่งจะทํางานก็ต่อเมื่อเงื่อนไขทั้งหมดเป็นจริง

filter[]

object (Condition)

ทริกเกอร์จะทํางานก็ต่อเมื่อเงื่อนไขทั้งหมดเป็นจริง

autoEventFilter[]

object (Condition)

ใช้ในกรณีที่มีการติดตามเหตุการณ์อัตโนมัติ

waitForTags

object (Parameter)

เราต้องชะลอการส่งแบบฟอร์มหรือการเปิดลิงก์จนกว่าแท็กทั้งหมดจะเริ่มทํางานหรือไม่ (โดยการป้องกันการดําเนินการเริ่มต้นและจําลองการดําเนินการเริ่มต้นในภายหลัง) ใช้ได้กับทริกเกอร์การส่งแบบฟอร์มและการคลิกลิงก์เท่านั้น

checkValidation

object (Parameter)

เราต้องเริ่มทํางานแท็กเฉพาะในกรณีที่เหตุการณ์การส่งแบบฟอร์มหรือการคลิกลิงก์ไม่ได้รับการยกเลิกโดยตัวแฮนเดิลเหตุการณ์อื่น (เช่น เนื่องจากการตรวจสอบ) หรือไม่ ใช้ได้กับทริกเกอร์การส่งแบบฟอร์มและการคลิกลิงก์เท่านั้น

waitForTagsTimeout

object (Parameter)

ระยะเวลารอ (เป็นมิลลิวินาที) เพื่อให้แท็กเริ่มทํางานเมื่อ "waits_for_tags" ด้านบนมีค่าเป็น

true

ใช้ได้กับทริกเกอร์การส่งแบบฟอร์มและการคลิกลิงก์เท่านั้น

uniqueTriggerId

object (Parameter)

รหัสที่ไม่ซ้ำกันทั่วโลกของทริกเกอร์ที่สร้างรายการนี้โดยอัตโนมัติ (Listener การคลิกลิงก์ การส่งแบบฟอร์ม หรือตัวจับเวลา) หากมี ใช้เพื่อทําให้เหตุการณ์อัตโนมัติที่เข้ากันไม่ได้ทํางานร่วมกับการกรองทริกเกอร์ตามรหัสทริกเกอร์ ระบบจะป้อนข้อมูลค่านี้ระหว่างการสร้างเอาต์พุต เนื่องจากแท็กที่ระบบจะสร้างจากทริกเกอร์ยังไม่เกิดขึ้น ใช้ได้กับทริกเกอร์การส่งแบบฟอร์ม การคลิกลิงก์ และตัวจับเวลาเท่านั้น

eventName

object (Parameter)

ชื่อเหตุการณ์ GTM ที่เริ่มทํางาน ใช้ได้กับทริกเกอร์ตัวจับเวลาเท่านั้น

interval

object (Parameter)

ระยะเวลาระหว่างการทริกเกอร์เหตุการณ์ตัวจับเวลาที่เกิดซ้ำ (เป็นมิลลิวินาที) ใช้ได้กับทริกเกอร์ตัวจับเวลาเท่านั้น

limit

object (Parameter)

จํากัดจํานวนเหตุการณ์ GTM ที่ทริกเกอร์ตัวจับเวลานี้จะเรียกให้แสดง หากไม่ได้ตั้งค่าขีดจํากัดไว้ เราจะทริกเกอร์เหตุการณ์ GTM ต่อไปจนกว่าผู้ใช้จะออกจากหน้า ใช้ได้กับทริกเกอร์ตัวจับเวลาเท่านั้น

fingerprint

string

ลายนิ้วมือของทริกเกอร์ GTM ที่คำนวณ ณ เวลาจัดเก็บ ระบบจะคํานวณค่านี้ใหม่ทุกครั้งที่มีการแก้ไขทริกเกอร์

parentFolderId

string

รหัสโฟลเดอร์หลัก

selector

object (Parameter)

ตัวเลือก CSS ของทริกเกอร์การคลิก (เช่น "a" "button" ฯลฯ) ใช้ได้กับทริกเกอร์การคลิก AMP เท่านั้น

intervalSeconds

object (Parameter)

ระยะเวลาระหว่างที่เหตุการณ์ตัวจับเวลาเริ่มทํางาน (เป็นวินาที) ใช้ได้กับทริกเกอร์ตัวจับเวลา AMP เท่านั้น

maxTimerLengthSeconds

object (Parameter)

เวลาสูงสุดที่จะทริกเกอร์เหตุการณ์ตัวจับเวลา (เป็นวินาที) ใช้ได้กับทริกเกอร์ตัวจับเวลา AMP เท่านั้น

verticalScrollPercentageList

object (Parameter)

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

horizontalScrollPercentageList

object (Parameter)

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

visibilitySelector

object (Parameter)

ตัวเลือก CSS ของทริกเกอร์การแสดงผล (เช่น "#id") ใช้ได้กับทริกเกอร์การแสดงผล AMP เท่านั้น

visiblePercentageMin

object (Parameter)

เปอร์เซ็นต์การมองเห็นขั้นต่ำของทริกเกอร์การแสดงผล ใช้ได้กับทริกเกอร์การแสดงผล AMP เท่านั้น

visiblePercentageMax

object (Parameter)

การแสดงผลสูงสุดของทริกเกอร์การแสดงผล ใช้ได้กับทริกเกอร์การแสดงผล AMP เท่านั้น

continuousTimeMinMilliseconds

object (Parameter)

ระยะเวลาที่มองเห็นได้ต่อเนื่องขั้นต่ำของทริกเกอร์การแสดงผล (เป็นมิลลิวินาที) ใช้ได้กับทริกเกอร์การแสดงผล AMP เท่านั้น

totalTimeMinMilliseconds

object (Parameter)

เวลาที่มองเห็นได้ทั้งหมดขั้นต่ำของทริกเกอร์การแสดงผล (เป็นมิลลิวินาที) ใช้ได้กับทริกเกอร์การแสดงผล AMP เท่านั้น

tagManagerUrl

string

ลิงก์ที่สร้างขึ้นโดยอัตโนมัติไปยัง UI ของเครื่องมือจัดการแท็ก

notes

string

หมายเหตุของผู้ใช้เกี่ยวกับวิธีใช้ทริกเกอร์นี้ในคอนเทนเนอร์

parameter[]

object (Parameter)

พารามิเตอร์เพิ่มเติม

EventType

Enum
eventTypeUnspecified
pageview
domReady
windowLoaded
customEvent
triggerGroup
init
consentInit
serverPageview
always
firebaseAppException
firebaseAppUpdate
firebaseCampaign
firebaseFirstOpen
firebaseInAppPurchase
firebaseNotificationDismiss
firebaseNotificationForeground
firebaseNotificationOpen
firebaseNotificationReceive
firebaseOsUpdate
firebaseSessionStart
firebaseUserEngagement
formSubmission
click
linkClick
jsError
historyChange
timer
ampClick
ampTimer
ampScroll
ampVisibility
youTubeVideo
scrollDepth
elementVisibility

เมธอด

create

สร้างทริกเกอร์ GTM

delete

ลบทริกเกอร์ GTM

get

รับทริกเกอร์ GTM

list

แสดงรายการทริกเกอร์ GTM ทั้งหมดของคอนเทนเนอร์

revert

เปลี่ยนการเปลี่ยนแปลงทริกเกอร์ GTM ในเวิร์กสเปซ GTM กลับ

update

อัปเดตทริกเกอร์ GTM