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
    }
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
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: ค่าแสดงถึงบูลีนซึ่งแสดงเป็น "จริง" หรือ "เท็จ"
  • 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: ค่าแสดงถึงบูลีนซึ่งแสดงเป็น "จริง" หรือ "เท็จ"
  • 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: ค่าแสดงถึงบูลีนซึ่งแสดงเป็น "จริง" หรือ "เท็จ"
  • integer: ค่านี้จะแสดงค่าจำนวนเต็มที่มีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุการแมปพารามิเตอร์
  • template: ค่านี้จะแสดงข้อความใดก็ได้ ข้อมูลนี้อาจรวมถึงการอ้างอิงตัวแปร (รวมถึงการอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่าแสดงถึงทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์
  • tag_reference: ค่าแสดงแท็ก ซึ่งแสดงเป็นชื่อแท็ก


ค่าที่ยอมรับได้ มีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
เขียนได้
parameter[].value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
parentFolderId string รหัสโฟลเดอร์หลัก
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: ค่าแสดงถึงบูลีนซึ่งแสดงเป็น "จริง" หรือ "เท็จ"
  • 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 หากเป็นจริง ให้แท็กลบล้างเริ่มทำงานเมื่อแท็กหลักเริ่มทำงานสำเร็จเท่านั้น หากเป็น "เท็จ" ให้แท็กลบล้างเริ่มทำงานโดยไม่คำนึงถึงสถานะการเริ่มทำงานของแท็กหลัก
teardownTag[].tagName string ชื่อของแท็ก Teardown
type string ประเภทแท็ก GTM เขียนได้
workspaceId string รหัสพื้นที่ทำงาน GTM

เมธอด

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