Tag Manager API – הפניה לפרמטרים

במסמך הזה מתוארים המטרה והייצוג של אובייקט הפרמטר של Tag Manager.

מבוא

ב-Tag Manager API אפשר ליצור ולנהל משאבים ב-Tag Manager, כמו תגים, כללים ורכיבי מאקרו.

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

כדי להגדיר את הפרמטרים הספציפיים ל-Tag או ל-מאקרו, אובייקט פרמטר מוגדר כערך למאפיין parameter של המשאב Tag או מאקרו.

אובייקט הפרמטר

האובייקט הבא מייצג אובייקט פרמטר:

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

סוג הפרמטר של התג או המאקרו שמוגדרים.

המאפיין type יקבע אם צריך לכלול את המאפיין value, list או map באובייקט הפרמטר, כפי שמתואר בטבלה שבהמשך.

לדוגמה, אם המדיניות type מוגדרת לערך boolean, צריך לכלול את המאפיין value באובייקט הפרמטר ולהגדיר את הערך true או false.

Value	נכס נוסף להכללה	איך מגדירים נכס נוסף
template	value	value הוא כל מחרוזת, כולל הפניות מאקרו. למשל: foo{{bar}}.
boolean	value	הערך של value הוא true או false.
number	value	value הוא מספר שלם.
list	list	הערך list יכלול אפס פרמטרים או יותר, הסדר עשוי או לא חשוב. המערכת תתעלם מה-key של כל פרמטר ב-list.
map	map	הערך map יכלול אפס פרמטרים או יותר, הסדר לא משנה. ה-key בכל פרמטר ב-map צריך להיות ייחודי.

key

מפתח הפרמטר של התג או המאקרו שמוגדרים.

השדה key משמש לזיהוי הפרמטר של תגים או פקודות מאקרו ספציפיים שמוגדרים. לכל סוגי הפרמטרים נדרש מאפיין key (מלבד פרמטרים מסוג list).

דוגמאות

אובייקט פרמטר עבור תג HTML מותאם אישית, שמכיל פרמטר אחד מסוג template ושני פרמטרים מסוג boolean:

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

אובייקט פרמטר למאקרו של טבלת חיפוש, שכולל שני פרמטרים מסוג template ופרמטר אחד מסוג 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 ופרמטר אחד מסוג map:

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