ממשק ה-API של Tag Manager – חומר עזר בנושא מילון מאקרו

מסמך זה מתאר את המאפיינים שניתן להגדיר לפקודות מאקרו של מנהל התגים של Google.

מבוא

לכל מאקרו של Google Tag Manager יש קוד type לזיהוי פקודת המאקרו. בנוסף, לרוב פקודות המאקרו יש פרמטרים (key, צמדים type) שאפשר להגדיר כחלק מ'אובייקט פרמטר' כשיוצרים או מעדכנים מאקרו. למידע נוסף על הגדרת הפרמטרים האלה באמצעות אובייקט פרמטר, תוכלו לעיין בחומר העזר בנושא פרמטרים.

בהמשך המסמך מפורטים הפרטים של כל פקודות המאקרו הנתמכות.

קובץ cookie מהדומיין הנוכחי

הקלדת קוד

k

פרמטרים

מפתח	תיאור	הערות
name	template	שם קובץ Cookie.

דוגמה

 {
   "name": "Sample 1st Party Cookie Macro",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

משתנה אירוע אוטומטי

הקלדת קוד

aev

פרמטרים

מפתח	תיאור	הערות
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

פרמטרים

מפתח	תיאור
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

פרמטרים

מפתח	תיאור
javascript	template

דוגמה

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

משתנה של שכבת נתונים

הקלדת קוד

v

פרמטרים

מפתח	תיאור	הערות
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 Macro",
   "type": "dbg"
  }

רכיב DOM

הקלדת קוד

d

פרמטרים

מפתח	תיאור	הערות
elementId	template
attributeName	template	אפשרות.

דוגמה

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

מקור ההפניה של HTTP

הקלדת קוד

f

פרמטרים

מפתח	תיאור	הערות
component	template	אחד מהערכים האלה: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
stripWww	boolean	לרכיב = HOST
queryKey	template	לרכיב = QUERY

דוגמה

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

משתנה JavaScript

הקלדת קוד

j

פרמטרים

מפתח	תיאור	הערות
name	template	שם משתנה גלובלי.

דוגמה

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

טבלת חיפוש

הקלדת קוד

smm

פרמטרים

מפתח	תיאור	הערות
input	template	הערך שמשמש לחיפוש, צריך להיות הפניית מאקרו.
map	list	רשימה של מפות, כשלכל אחת מהן יש צמד [key, value] יחיד.
map[].key	template
map[].value	template
defaultValue	template	אפשרות.

דוגמה

  {
   "name": "Sample Lookup Table Macro",
   "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 Macro",
   "type": "r"
  }

כתובת URL

הקלדת קוד

u

פרמטרים

מפתח	תיאור	הערות
component	template	אחד מהערכים האלה: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
customUrlSource	template	אפשרות.
stripWww	boolean	לרכיב = HOST.
queryKey	template	לרכיב = QUERY.

דוגמה

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