Tags: create

สร้างแท็ก GTM ลองเลย

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/tagmanager/v2/+parent/tags

พารามิเตอร์

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

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

คำขอนี้ต้องได้รับสิทธิ์ด้วยขอบเขตต่อไปนี้

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

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

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

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

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


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


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


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
เขียนได้
type string ประเภทแท็ก GTM เขียนได้
พร็อพเพอร์ตี้ที่ไม่บังคับ
blockingRuleId[] list รหัสกฎการบล็อก หากกฎใดๆ ที่ระบุไว้ประเมินได้ว่าเป็น "จริง" แท็กจะไม่เริ่มทํางาน เขียนได้
blockingTriggerId[] list รหัสทริกเกอร์การบล็อก หากทริกเกอร์ใดๆ ในรายการประเมินค่าเป็น "จริง" แท็กจะไม่เริ่มทํางาน เขียนได้
consentSettings nested object การตั้งค่าคํายินยอมของแท็ก เขียนได้
consentSettings.consentType.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
consentSettings.consentType.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
consentSettings.consentType.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
consentSettings.consentType.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
firingRuleId[] list รหัสกฎการเริ่มทำงาน แท็กจะเริ่มทำงานเมื่อกฎใดๆ ที่ระบุไว้เป็นจริง และ blockingRuleIds ทั้งหมด (หากระบุไว้) เป็นเท็จ เขียนได้
firingTriggerId[] list รหัสทริกเกอร์การเริ่มทำงาน แท็กจะเริ่มทำงานเมื่อทริกเกอร์ใดๆ ที่ระบุไว้เป็นจริง และ blockingTriggerIds ทั้งหมด (หากระบุไว้) เป็นเท็จ เขียนได้
liveOnly boolean หากตั้งค่าเป็น "จริง" แท็กนี้จะเริ่มทำงานในสภาพแวดล้อมจริงเท่านั้น (เช่น ไม่อยู่ในโหมดแสดงตัวอย่างหรือแก้ไขข้อบกพร่อง) เขียนได้
monitoringMetadata nested object แมปของคู่คีย์-ค่าของข้อมูลเมตาแท็กที่จะรวมไว้ในข้อมูลเหตุการณ์สำหรับการตรวจสอบแท็ก หมายเหตุ:
  • พารามิเตอร์นี้ต้องเป็นประเภท MAP
  • พารามิเตอร์แต่ละรายการในแผนที่เป็นประเภท TEMPLATE แต่ไม่สามารถมีการอ้างอิงตัวแปรได้
เขียนได้
monitoringMetadata.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
monitoringMetadata.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
monitoringMetadata.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
monitoringMetadata.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
monitoringMetadataTagNameKey string หากไม่ว่างเปล่า ชื่อที่แสดงของแท็กจะรวมอยู่ในแมปข้อมูลเมตาการตรวจสอบโดยใช้คีย์ที่ระบุ เขียนได้
notes string ผู้ใช้ระบุวิธีใช้แท็กนี้ในคอนเทนเนอร์ เขียนได้
parameter[] list พารามิเตอร์ของแท็ก เขียนได้
parameter[].key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
parameter[].list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
parameter[].map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
parameter[].value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
paused boolean ระบุว่าแท็กถูกหยุดชั่วคราวหรือไม่ ซึ่งป้องกันไม่ให้แท็กเริ่มทํางาน เขียนได้
priority nested object ตัวเลขลำดับความสำคัญของแท็กที่ผู้ใช้กำหนด แท็กจะเริ่มทำงานแบบอะซิงโครนัสตามลำดับความสำคัญ แท็กที่มีค่าตัวเลขสูงกว่าจะเริ่มทำงานก่อน ลำดับความสำคัญของแท็กอาจเป็นค่าบวกหรือค่าลบก็ได้ ค่าเริ่มต้นคือ 0 เขียนได้
priority.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
priority.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
priority.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
priority.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
scheduleEndMs long การประทับเวลาสิ้นสุดเป็นมิลลิวินาทีเพื่อตั้งเวลาแท็ก เขียนได้
scheduleStartMs long การประทับเวลาเริ่มต้นเป็นมิลลิวินาทีเพื่อตั้งเวลาแท็ก เขียนได้

คำตอบ

หากสำเร็จ เมธอดนี้จะแสดงทรัพยากรแท็กในเนื้อหาของการตอบสนอง

ลองใช้เลย

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