Tag Manager API - ข้อมูลอ้างอิงเกี่ยวกับพารามิเตอร์

เอกสารนี้อธิบายวัตถุประสงค์และการแสดงถึงออบเจ็กต์พารามิเตอร์ 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 และพารามิเตอร์ประเภท map 1 รายการดังนี้

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]