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 יכיל אפס פרמטרים או יותר, ההזמנה עשויה/עשויה להיות לא משנה; 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"
  }
]