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

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

מבוא

Tag Manager API מאפשר ליצור ולנהל משאבים של Tag Manager כמו Tags (תגים), Triggers (טריגרים) ו-Variables (משתנים).

לרוב סוגי התגים והמשתנים יש פרמטרים נוספים ספציפיים לתג או למשתנה, ואפשר להגדיר אותו בזמן יצירה/עדכון של המשאב. הרשימה של פרמטרים (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 יכיל אפס פרמטרים או יותר, ההזמנה עשויה/עשויה להיות לא משנה; 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 ופרמטר אחד מסוג map סוג פרמטר:

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