Tags

โปรดดูรายการวิธีการสำหรับแหล่งข้อมูลนี้ที่ส่วนท้ายของหน้านี้

การรับรองทรัพยากร

แสดงแท็ก Google Tag Manager

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
accountId string รหัสบัญชี GTM
blockingRuleId[] list รหัสกฎการบล็อก หากกฎใดๆ ที่ระบุไว้ประเมินได้ว่าเป็น "จริง" แท็กจะไม่เริ่มทํางาน เขียนได้
blockingTriggerId[] list รหัสทริกเกอร์การบล็อก หากทริกเกอร์ใดๆ ในรายการประเมินค่าเป็น "จริง" แท็กจะไม่เริ่มทํางาน เขียนได้
consentSettings nested object การตั้งค่าคํายินยอมของแท็ก เขียนได้
consentSettings.consentStatus string สถานะความยินยอมของแท็ก หากตั้งค่าเป็น "จำเป็น" รันไทม์จะตรวจสอบว่าประเภทความยินยอมที่ระบุโดยช่อง consent_type ได้รับอนุญาตแล้ว

ค่าที่ยอมรับมีดังนี้
  • "needed"
  • "notNeeded"
  • "notSet"
consentSettings.consentType nested object ประเภทความยินยอมที่ต้องตรวจสอบระหว่างการเริ่มทํางานของแท็กหากอยู่ในสถานะ "ต้องได้รับความยินยอม" พารามิเตอร์นี้ต้องเป็นประเภท LIST ซึ่งแต่ละรายการในลิสต์เป็นประเภท STRING
consentSettings.consentType.isWeakReference boolean พารามิเตอร์ประเภทข้อมูลอ้างอิงมีการอ้างอิงอย่างแน่นหนาหรืออ่อนหรือไม่ ใช้โดยการเปลี่ยนรูปแบบเท่านั้น เขียนได้
consentSettings.consentType.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
consentSettings.consentType.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
consentSettings.consentType.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
consentSettings.consentType.type string ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
  • boolean: ค่านี้แทนค่าบูลีน ซึ่งแสดงเป็น "true" หรือ "false"
  • integer: ค่านี้แสดงค่าจำนวนเต็มแบบมีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุแมปของพารามิเตอร์
  • template: ค่าแสดงถึงข้อความทุกอย่าง ซึ่งอาจรวมถึงการอ้างอิงตัวแปร (แม้แต่การอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่านี้แทนทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์
  • tag_reference: ค่านี้แทนแท็ก ซึ่งแสดงเป็นชื่อแท็ก


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
เขียนได้
consentSettings.consentType.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
containerId string รหัสคอนเทนเนอร์ GTM
fingerprint string ลายนิ้วมือของแท็ก GTM ที่คำนวณ ณ เวลาจัดเก็บข้อมูล ค่านี้จะคำนวณใหม่ทุกครั้งที่มีการแก้ไขแท็ก
firingRuleId[] list รหัสกฎการเริ่มทำงาน แท็กจะเริ่มทำงานเมื่อกฎใดๆ ที่ระบุไว้เป็นจริง และ blockingRuleIds ทั้งหมด (หากระบุไว้) เป็นเท็จ เขียนได้
firingTriggerId[] list รหัสทริกเกอร์การเริ่มทำงาน แท็กจะเริ่มทำงานเมื่อทริกเกอร์ใดๆ ที่ระบุไว้เป็นจริง และ blockingTriggerIds ทั้งหมด (หากระบุไว้) เป็นเท็จ เขียนได้
liveOnly boolean หากตั้งค่าเป็น "จริง" แท็กนี้จะเริ่มทำงานในสภาพแวดล้อมจริงเท่านั้น (เช่น ไม่อยู่ในโหมดแสดงตัวอย่างหรือแก้ไขข้อบกพร่อง) เขียนได้
monitoringMetadata nested object แมปของคู่คีย์-ค่าของข้อมูลเมตาแท็กที่จะรวมไว้ในข้อมูลเหตุการณ์สำหรับการตรวจสอบแท็ก หมายเหตุ:
  • พารามิเตอร์นี้ต้องเป็นประเภท MAP
  • พารามิเตอร์แต่ละรายการในแผนที่เป็นประเภท TEMPLATE แต่ไม่สามารถมีการอ้างอิงตัวแปรได้
เขียนได้
monitoringMetadata.isWeakReference boolean พารามิเตอร์ประเภทข้อมูลอ้างอิงมีการอ้างอิงอย่างแน่นหนาหรืออ่อนหรือไม่ ใช้โดยการเปลี่ยนรูปแบบเท่านั้น เขียนได้
monitoringMetadata.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
monitoringMetadata.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
monitoringMetadata.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
monitoringMetadata.type string ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
  • boolean: ค่านี้แทนค่าบูลีน ซึ่งแสดงเป็น "true" หรือ "false"
  • integer: ค่านี้แสดงค่าจำนวนเต็มแบบมีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุแมปของพารามิเตอร์
  • template: ค่าแสดงถึงข้อความทุกอย่าง ซึ่งอาจรวมถึงการอ้างอิงตัวแปร (แม้แต่การอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่านี้แทนทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์
  • tag_reference: ค่านี้แทนแท็ก ซึ่งแสดงเป็นชื่อแท็ก


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
เขียนได้
monitoringMetadata.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
monitoringMetadataTagNameKey string หากไม่ว่างเปล่า ชื่อที่แสดงของแท็กจะรวมอยู่ในแมปข้อมูลเมตาการตรวจสอบโดยใช้คีย์ที่ระบุ เขียนได้
name string ชื่อที่แสดงของแท็ก เขียนได้
notes string ผู้ใช้ระบุวิธีใช้แท็กนี้ในคอนเทนเนอร์ เขียนได้
parameter[] list พารามิเตอร์ของแท็ก เขียนได้
parameter[].isWeakReference boolean พารามิเตอร์ประเภทข้อมูลอ้างอิงมีการอ้างอิงอย่างแน่นหนาหรืออ่อนหรือไม่ ใช้โดยการเปลี่ยนรูปแบบเท่านั้น เขียนได้
parameter[].key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
parameter[].list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
parameter[].map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
parameter[].type string ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
  • boolean: ค่านี้แทนค่าบูลีน ซึ่งแสดงเป็น "true" หรือ "false"
  • integer: ค่านี้แสดงค่าจำนวนเต็มแบบมีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุแมปของพารามิเตอร์
  • template: ค่าแสดงถึงข้อความทุกอย่าง ซึ่งอาจรวมถึงการอ้างอิงตัวแปร (แม้แต่การอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่านี้แทนทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์
  • tag_reference: ค่านี้แทนแท็ก ซึ่งแสดงเป็นชื่อแท็ก


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
เขียนได้
parameter[].value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
parentFolderId string ID โฟลเดอร์หลัก
path string เส้นทางที่เกี่ยวข้อง API ของแท็ก GTM
paused boolean ระบุว่าแท็กถูกหยุดชั่วคราวหรือไม่ ซึ่งป้องกันไม่ให้แท็กเริ่มทํางาน เขียนได้
priority nested object ตัวเลขลำดับความสำคัญของแท็กที่ผู้ใช้กำหนด แท็กจะเริ่มทำงานแบบอะซิงโครนัสตามลำดับความสำคัญ แท็กที่มีค่าตัวเลขสูงกว่าจะเริ่มทำงานก่อน ลำดับความสำคัญของแท็กอาจเป็นค่าบวกหรือค่าลบก็ได้ ค่าเริ่มต้นคือ 0 เขียนได้
priority.isWeakReference boolean พารามิเตอร์ประเภทข้อมูลอ้างอิงมีการอ้างอิงอย่างแน่นหนาหรืออ่อนหรือไม่ ใช้โดยการเปลี่ยนรูปแบบเท่านั้น เขียนได้
priority.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
priority.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
priority.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
priority.type string ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
  • boolean: ค่านี้แทนค่าบูลีน ซึ่งแสดงเป็น "true" หรือ "false"
  • integer: ค่านี้แสดงค่าจำนวนเต็มแบบมีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุแมปของพารามิเตอร์
  • template: ค่าแสดงถึงข้อความทุกอย่าง ซึ่งอาจรวมถึงการอ้างอิงตัวแปร (แม้แต่การอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่านี้แทนทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์
  • tag_reference: ค่านี้แทนแท็ก ซึ่งแสดงเป็นชื่อแท็ก


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
เขียนได้
priority.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
scheduleEndMs long การประทับเวลาสิ้นสุดเป็นมิลลิวินาทีเพื่อตั้งเวลาแท็ก เขียนได้
scheduleStartMs long การประทับเวลาเริ่มต้นเป็นมิลลิวินาทีเพื่อตั้งเวลาแท็ก เขียนได้
setupTag[] list รายการแท็กสำหรับตั้งค่า ปัจจุบันเราอนุญาตให้มีเพียง 1 รายการเท่านั้น
setupTag[].stopOnSetupFailure boolean หากเป็น "จริง" ให้เริ่มการทำงานของแท็กหลักต่อเมื่อแท็กตั้งค่าเริ่มทำงานสำเร็จเท่านั้น หากเป็น "เท็จ" ให้เริ่มการทํางานของแท็กหลักไม่ว่าแท็กตั้งค่าจะเริ่มทํางานอย่างไร
setupTag[].tagName string ชื่อของแท็กตั้งค่า
tagFiringOption string ตัวเลือกในการทำให้แท็กนี้เริ่มทำงาน

ค่าที่ยอมรับมีดังนี้
  • "oncePerEvent"
  • "oncePerLoad"
  • "tagFiringOptionUnspecified"
  • "unlimited"
tagId string รหัสแท็กจะระบุแท็ก GTM ที่ไม่ซ้ำ
tagManagerUrl string ลิงก์ที่สร้างขึ้นโดยอัตโนมัติไปยัง UI ของ Tag Manager
teardownTag[] list รายการแท็กลบล้าง ปัจจุบันเราอนุญาตให้มีเพียง 1 รายการเท่านั้น
teardownTag[].stopTeardownOnFailure boolean หากเป็น "จริง" ให้เริ่มการทำงานของแท็กลบล้างเมื่อแท็กหลักเริ่มทำงานสำเร็จเท่านั้น หากเป็น "เท็จ" ให้เริ่มการทำงานของแท็ก teardown โดยไม่คำนึงถึงสถานะการเริ่มทำงานของแท็กหลัก
teardownTag[].tagName string ชื่อของแท็กลบล้าง
type string ประเภทแท็ก GTM เขียนได้
workspaceId string รหัสพื้นที่ทำงาน GTM

วิธีการ

สร้าง
สร้างแท็ก GTM
ลบ
ลบแท็ก GTM
รับ
รับแท็ก GTM
list
แสดงรายการแท็ก GTM ทั้งหมดของคอนเทนเนอร์
revert
เปลี่ยนกลับการเปลี่ยนแปลงไปยังแท็ก GTM ในพื้นที่ทำงานของ GTM
อัปเดต
อัปเดตแท็ก GTM