เอกสารนี้อธิบายวัตถุประสงค์และการแสดงถึงออบเจ็กต์พารามิเตอร์ Tag Manager
เกริ่นนำ
Tag Manager API ช่วยให้คุณสร้างและจัดการทรัพยากรของ Tag Manager เช่น แท็ก กฎ และมาโครได้
ประเภทแท็กและมาโครส่วนใหญ่มีพารามิเตอร์เพิ่มเติมที่เฉพาะเจาะจง
สำหรับแท็กหรือมาโคร และสามารถกำหนดได้เมื่อสร้าง/อัปเดตทรัพยากร รายการพารามิเตอร์ (คู่ key
, type
) ของแท็กและมาโครแต่ละประเภทแสดงอยู่ในข้อมูลอ้างอิงพจนานุกรมแท็กและข้อมูลอ้างอิงพจนานุกรมมาโคร
หากต้องการกำหนดค่าพารามิเตอร์เฉพาะแท็กหรือมาโครเหล่านี้ ออบเจ็กต์พารามิเตอร์จะได้รับการกำหนดและตั้งเป็นค่าสำหรับพร็อพเพอร์ตี้ parameter
ของแท็กหรือทรัพยากร
มาโคร
ออบเจ็กต์พารามิเตอร์
ออบเจ็กต์ต่อไปนี้แสดงออบเจ็กต์พารามิเตอร์
[ { "type": string, "key": string, "value": string, "list": [ (Parameter) ], "map": [ (Parameter) ] } ]
type
ประเภทพารามิเตอร์ของแท็กหรือมาโครที่กำหนดค่า
พร็อพเพอร์ตี้ type
จะกำหนดว่าต้องรวมพร็อพเพอร์ตี้ value
, list
หรือ map
ไว้ในออบเจ็กต์พารามิเตอร์หรือไม่ตามที่อธิบายไว้ในตารางด้านล่าง
ตัวอย่างเช่น หากตั้งค่า type
เป็น boolean
ก็ควรรวมพร็อพเพอร์ตี้ value
ไว้ในออบเจ็กต์พารามิเตอร์และตั้งค่าเป็น true
หรือ false
ค่า | พร็อพเพอร์ตี้เพิ่มเติมที่จะรวม | วิธีตั้งค่าพร็อพเพอร์ตี้เพิ่มเติม |
---|---|---|
template |
value |
value คือสตริงใดก็ได้ รวมถึงการอ้างอิงมาโคร เช่น foo{{bar}} |
boolean |
value |
value เป็น true หรือ false
|
number |
value |
value เป็นจำนวนเต็ม |
list |
list |
list จะมีพารามิเตอร์ตั้งแต่ 0 รายการขึ้นไป ลำดับอาจ/อาจไม่สำคัญ ระบบจะไม่สนใจ key ของพารามิเตอร์ใดๆ ใน list |
map |
map |
map จะมีพารามิเตอร์ตั้งแต่ 0 รายการขึ้นไป ลําดับไม่สำคัญ เนื่องจาก key ในพารามิเตอร์ใดก็ได้ใน map ต้องไม่ซ้ำกัน |
key
คีย์พารามิเตอร์ของแท็กหรือมาโครที่กำหนดค่า
ช่อง key
ใช้เพื่อระบุพารามิเตอร์ของแท็กหรือมาโครที่เจาะจงซึ่งกำลังตั้งค่า พารามิเตอร์ทุกประเภทต้องมีพร็อพเพอร์ตี้ key
(ยกเว้นพารามิเตอร์ list
)
ตัวอย่าง
ออบเจ็กต์พารามิเตอร์สำหรับแท็ก HTML ที่กำหนดเอง ซึ่งมีพารามิเตอร์ประเภท template
1 และพารามิเตอร์ประเภท boolean
2 รายการ ดังนี้
"parameter": [ { "key": "html", "type": "template", "value": "<script>alert('hello world')</script>" }, { "key": "supportDocumentWrite", "type": "boolean", "value": "false" } ]
ออบเจ็กต์พารามิเตอร์สำหรับมาโครตารางตรวจสอบ ซึ่งมีพารามิเตอร์ประเภท template
2 รายการ และพารามิเตอร์ประเภท list
1 รายการ ดังนี้
"parameter": [ { "type": "template", "key": "input", "value": "{{event}}" }, { "type": "list", "key": "map", "list": [ { "type": "map", "map": [ { "type": "template", "key": "key", "value": "EventEqualsThis" }, { "type": "template", "key": "value", "value": "ThenSetToThis" } ] } ] }, { "type": "template", "key": "defaultValue", "value": "MyDefaultValue" } ]
ออบเจ็กต์พารามิเตอร์สำหรับแท็กการเรียกใช้ฟังก์ชัน ซึ่งมีพารามิเตอร์ประเภท template
และพารามิเตอร์ประเภท map
1 รายการดังนี้
"parameter": [ { "key": "functionName", "type": "template", "value": "fn" }, { "key": "functionArgument", "map": [ { "key": "argkey1", "type": "template", "value": "argval1" } ], "type": "map" } ]