Tag Manager API - การอ้างอิงพจนานุกรมตัวแปร

เอกสารนี้อธิบายพร็อพเพอร์ตี้ที่ตั้งค่าสำหรับตัวแปร Google Tag Manager ได้

เกริ่นนำ

ตัวแปร Google Tag Manager แต่ละรายการมีโค้ด type เพื่อระบุตัวแปร นอกจากนี้ ตัวแปรส่วนใหญ่มีพารามิเตอร์ (คู่ key, type) ที่คุณตั้งค่าเป็นส่วนหนึ่งของ "ออบเจ็กต์พารามิเตอร์" ได้เมื่อสร้างหรืออัปเดตตัวแปร ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีตั้งค่าพารามิเตอร์เหล่านี้โดยใช้ออบเจ็กต์พารามิเตอร์ได้ที่ข้อมูลอ้างอิงพารามิเตอร์

ส่วนที่เหลือของเอกสารนี้แสดงรายละเอียดของตัวแปรที่สนับสนุนทั้งหมด

คุกกี้ของบุคคลที่หนึ่ง

พิมพ์โค้ด

k

พารามิเตอร์

คีย์	Type	Notes
name	template	ชื่อคุกกี้

ตัวอย่าง

 {
   "name": "Sample First Party Cookie Variable",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

ตัวแปรเหตุการณ์อัตโนมัติ

พิมพ์โค้ด

aev

พารามิเตอร์

คีย์	Type	Notes
varType	template	อย่างใดอย่างหนึ่ง ELEMENT,CLASSES, ID, TARGET, TEXT, URL, HISTORY_NEW_URL_FRAGMENT, HISTORY_OLD_URL_FRAGMENT, HISTORY_NEW_STATE, HISTORY_OLD_STATE, HISTORY_CHANGE_SOURCE
defaultValue	template	ไม่บังคับ

ตัวอย่าง

  {
   "name": "Sample AutoEvent Variable",
   "type": "aev",
   "parameter": [
    {
     "type": "template",
     "key": "varType",
     "value": "CLASSES"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefault"
    }
   ]
  }

สตริงค่าคงที่

พิมพ์โค้ด

c

พารามิเตอร์

คีย์	Type
value	template

ตัวอย่าง

  {
   "name": "Sample Constant String",
   "type": "c",
   "parameter": [
    {
     "type": "template",
     "key": "value",
     "value": "MyString"
    }
   ]
  }

หมายเลขเวอร์ชันคอนเทนเนอร์

พิมพ์โค้ด

ctv

พารามิเตอร์

ไม่มีข้อมูล

ตัวอย่าง

  {
   "name": "Sample Container Version Number",
   "type": "ctv"
  }

เหตุการณ์ที่กำหนดเอง

พิมพ์โค้ด

พารามิเตอร์

ไม่มีข้อมูล

ตัวอย่าง

  {
   "name": "Custom Event Name",
   "type": "e"
  }

JavaScript ที่กำหนดเอง

พิมพ์โค้ด

jsm

พารามิเตอร์

คีย์	Type
javascript	template

ตัวอย่าง

  {
   "name": "Sample Custom Javascript",
   "type": "jsm",
   "parameter": [
    {
     "type": "template",
     "key": "javascript",
     "value": "function() {\n return \"Hello World\";\n}"
    }
   ]
  }

ตัวแปรชั้นข้อมูล

พิมพ์โค้ด

v

พารามิเตอร์

คีย์	Type	Notes
name	template	ชื่อตัวแปรชั้นข้อมูล
defaultValue	template
dataLayerVersion	integer	1 หรือ 2

ตัวอย่าง

  {
   "name": "Sample Data Layer Variable",
   "type": "v",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "DL Variable Name"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "DEFAULT"
    },
    {
     "type": "integer",
     "key": "dataLayerVersion",
     "value": "2"
    }
   ]
  }

โหมดแก้ไขข้อบกพร่อง

พิมพ์โค้ด

dbg

พารามิเตอร์

ไม่มีข้อมูล

ตัวอย่าง

  {
   "name": "Sample Debug Mode Variable",
   "type": "dbg"
  }

องค์ประกอบ DOM

พิมพ์โค้ด

d

พารามิเตอร์

คีย์	Type	Notes
elementId	template
attributeName	template	ไม่บังคับ

ตัวอย่าง

  {
   "name": "Sample DOM Element Variable",
   "type": "d",
   "parameter": [
    {
     "type": "template",
     "key": "elementId",
     "value": "MyElementId"
    },
    {
     "type": "template",
     "key": "attributeName",
     "value": "MyAttributeName"
    }
   ]
  }

URL ที่มา HTTP

พิมพ์โค้ด

f

พารามิเตอร์

คีย์	Type	Notes
component	template	รายการที่ 1 จาก URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT
stripWww	boolean	สำหรับคอมโพเนนต์ = HOST
queryKey	template	สำหรับคอมโพเนนต์ = QUERY

ตัวอย่าง

  {
   "name": "Sample HTTP Referrer Variable",
   "type": "f",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    }
   ]
  }

ตัวแปร JavaScript

พิมพ์โค้ด

j

พารามิเตอร์

คีย์	Type	Notes
name	template	ชื่อตัวแปรร่วม

ตัวอย่าง

  {
   "name": "Sample Javascript Variable",
   "type": "j",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "MyGlobalVarName"
    }
   ]
  }

ตารางตรวจสอบ

พิมพ์โค้ด

smm

พารามิเตอร์

คีย์	Type	Notes
input	template	ค่าที่ใช้สำหรับการค้นหาควรเป็นการอ้างอิงตัวแปร
map	list	รายการแผนที่ แต่ละรายการมีคู่ [key, value] คู่เดียว
map[].key	template
map[].value	template
defaultValue	template	ไม่บังคับ

ตัวอย่าง

  {
   "name": "Sample Lookup Table Variable",
   "type": "smm",
   "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"
    }
   ]
  }

ตัวเลขสุ่ม

พิมพ์โค้ด

r

พารามิเตอร์

ไม่มีข้อมูล

ตัวอย่าง

  {
   "name": "Sample Random Number Variable",
   "type": "r"
  }

URL

พิมพ์โค้ด

u

พารามิเตอร์

คีย์	Type	Notes
component	template	รายการที่ 1 จาก URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT
customUrlSource	template	ไม่บังคับ
stripWww	boolean	สำหรับคอมโพเนนต์ = HOST
queryKey	template	สำหรับคอมโพเนนต์ = QUERY

ตัวอย่าง

  {
   "name": "Sample URL Variable",
   "type": "u",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    },
    {
     "type": "template",
     "key": "customUrlSource",
     "value": "{{element}}"
    }
   ]
  }