במסמך הזה מתוארים המטרה והייצוג של אובייקט הפרמטר של Tag Manager.
מבוא
באמצעות Tag Manager API אפשר ליצור ולנהל משאבים ב-Tag Manager, כמו Tags, Triggers ו-Variables.
לרוב סוגי התגים והמשתנים יש פרמטרים נוספים שספציפיים לתג או למשתנה, ואפשר להגדיר אותם כשיוצרים או מעדכנים את המשאב. רשימת הפרמטרים (צמדים של key
, type
) לכל תג וסוג משתנה מופיעה במאמר Tag Dictionary (הפניה למילון תגים).
כדי להגדיר את הפרמטרים האלה של Tag או של Variable, מוגדר אובייקט פרמטר בתור הערך של המאפיין 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
ופרמטר אחד מסוג map
:
"parameter": [ { "key": "functionName", "type": "template", "value": "fn" }, { "key": "functionArgument", "map": [ { "key": "argkey1", "type": "template", "value": "argval1" } ], "type": "map" } ]