สร้างแท็ก 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 |
สำหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
ในเนื้อหาคำขอ ให้ระบุทรัพยากรแท็กพร้อมด้วยพร็อพเพอร์ตี้ต่อไปนี้
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
---|---|---|---|
พร็อพเพอร์ตี้ที่จำเป็น | |||
consentSettings.consentType.type |
string |
ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
ค่าที่ยอมรับได้ มีดังนี้
|
เขียนได้ |
monitoringMetadata.type |
string |
ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
ค่าที่ยอมรับได้ มีดังนี้
|
เขียนได้ |
name |
string |
ชื่อที่แสดงของแท็ก | เขียนได้ |
parameter[].type |
string |
ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
ค่าที่ยอมรับได้ มีดังนี้
|
เขียนได้ |
priority.type |
string |
ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
ค่าที่ยอมรับได้ มีดังนี้
|
เขียนได้ |
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 |
การแมปคู่คีย์-ค่าของข้อมูลเมตาของแท็กที่จะรวมไว้ในข้อมูลเหตุการณ์สําหรับการตรวจสอบแท็ก หมายเหตุ:
|
เขียนได้ |
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 ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ