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 2 รายการ และพารามิเตอร์ 1 รายการ พารามิเตอร์ประเภท list:

"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 1 รายการ และ map 1 รายการ พารามิเตอร์ประเภท:

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