Tags

רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.

ייצוגי משאבים

מייצג תג של Google Tag Manager.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
שם הנכס ערך תיאור הערות
accountId string מספר חשבון GTM.
blockingRuleId[] list מזהים של כללי חסימה. אם הערך של אחד מהכללים שברשימה הוא True, התג לא יופעל. ניתן לכתיבה
blockingTriggerId[] list חסימת מזהי טריגרים. אם אחד מהטריגרים שברשימה הוא True, התג לא יופעל. ניתן לכתיבה
consentSettings nested object הגדרות ההסכמה בתג. ניתן לכתיבה
consentSettings.consentStatus string סטטוס ההסכמה של התג. אם המדיניות מוגדרת כ-NEEDED, בסביבת זמן הריצה המערכת תבדוק אם סוגי ההסכמה שצוינו בשדה consent_type ניתנו.

הערכים הקבילים הם:
  • "needed"
  • "notNeeded"
  • "notSet"
consentSettings.consentType nested object סוג ההסכמות שצריך לבדוק במהלך הפעלת התגים, אם במצב ההסכמה נדרשת. הפרמטר הזה חייב להיות מסוג LIST, כאשר כל פריט ברשימה הוא מסוג STRING.
consentSettings.consentType.isWeakReference boolean האם יש הפניה חזקה או חלשה לפרמטר של סוג הפניה. משמש רק לטרנספורמציות. ניתן לכתיבה
consentSettings.consentType.key string המפתח בעל השם שמזהה את הפרמטר באופן ייחודי. חובה לפרמטרים ברמה העליונה וגם לערכי מפה. המערכת התעלמה מערכי הרשימה. ניתן לכתיבה
consentSettings.consentType.list[] list הפרמטרים של הפרמטר ברשימה הזו (המערכת תתעלם ממפתחות). ניתן לכתיבה
consentSettings.consentType.map[] list הפרמטרים של פרמטר המפה הזה (חייבים לכלול מפתחות, המפתחות חייבים להיות ייחודיים). ניתן לכתיבה
consentSettings.consentType.type string סוג הפרמטר הערכים החוקיים הם:
  • boolean: הערך מייצג ערך בוליאני, שמיוצג כ-'true'. או 'false'
  • integer: הערך מייצג ערך של מספר שלם חתום של 64 ביט, בבסיס 10
  • list: יש לציין רשימת פרמטרים
  • map: יש לציין מפה של פרמטרים
  • template: הערך מייצג כל טקסט שהוא. כתובת זו יכולה לכלול הפניות למשתנים (גם הפניות למשתנים שעשויות להחזיר סוגים שאינם מחרוזות)
  • trigger_reference: הערך מייצג טריגר, שמיוצג כמזהה הטריגר
  • tag_reference: הערך מייצג תג שמיוצג כשם התג


הערכים הקבילים הם:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
ניתן לכתיבה
consentSettings.consentType.value string ערך של פרמטר (עשוי להכיל הפניות למשתנים כמו "") בהתאם לסוג שצוין. ניתן לכתיבה
containerId string מזהה מאגר התגים של GTM.
fingerprint string טביעת האצבע של תג ה-GTM כפי שמחושב בזמן האחסון. ערך זה מחושב מחדש בכל פעם שהתג משתנה.
firingRuleId[] list מזהי כללי הפעלה. תג יופעל כשאחד מהכללים המפורטים מתקיים וכל blockingRuleIds שלו (אם צוין) לא נכון. ניתן לכתיבה
firingTriggerId[] list מזהי טריגרים. תג יופעל כשאחד מהטריגרים שצוינו יתקיים וכל blockingTriggerIds שלו (אם צוין) מוגדר כ-False. ניתן לכתיבה
liveOnly boolean אם הוא מוגדר כ-True, התג הזה יופעל רק בסביבה הפעילה (למשל, לא במצב תצוגה מקדימה או במצב ניפוי באגים). ניתן לכתיבה
monitoringMetadata nested object מפה של צמדי מפתח/ערך של מטא-נתונים של תג שייכללו בנתוני האירועים לצורך מעקב אחרי תגים. הערות:
  • הפרמטר הזה חייב להיות מסוג MAP.
  • כל פרמטר במפה הוא מסוג TEMPLATE, אבל הוא לא יכול להכיל הפניות למשתנים.
ניתן לכתיבה
monitoringMetadata.isWeakReference boolean האם יש הפניה חזקה או חלשה לפרמטר של סוג הפניה. משמש רק לטרנספורמציות. ניתן לכתיבה
monitoringMetadata.key string המפתח בעל השם שמזהה את הפרמטר באופן ייחודי. חובה לפרמטרים ברמה העליונה וגם לערכי מפה. המערכת התעלמה מערכי הרשימה. ניתן לכתיבה
monitoringMetadata.list[] list הפרמטרים של הפרמטר ברשימה הזו (המערכת תתעלם ממפתחות). ניתן לכתיבה
monitoringMetadata.map[] list הפרמטרים של פרמטר המפה הזה (חייבים לכלול מפתחות, המפתחות חייבים להיות ייחודיים). ניתן לכתיבה
monitoringMetadata.type string סוג הפרמטר הערכים החוקיים הם:
  • boolean: הערך מייצג ערך בוליאני, שמיוצג כ-'true'. או 'false'
  • integer: הערך מייצג ערך של מספר שלם חתום של 64 ביט, בבסיס 10
  • list: יש לציין רשימת פרמטרים
  • map: יש לציין מפה של פרמטרים
  • template: הערך מייצג כל טקסט שהוא. כתובת זו יכולה לכלול הפניות למשתנים (גם הפניות למשתנים שעשויות להחזיר סוגים שאינם מחרוזות)
  • trigger_reference: הערך מייצג טריגר, שמיוצג כמזהה הטריגר
  • tag_reference: הערך מייצג תג שמיוצג כשם התג


הערכים הקבילים הם:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
ניתן לכתיבה
monitoringMetadata.value string ערך של פרמטר (עשוי להכיל הפניות למשתנים כמו "") בהתאם לסוג שצוין. ניתן לכתיבה
monitoringMetadataTagNameKey string אם השדה לא ריק, השם המוצג של התג ייכלל במפת המטא-נתונים למעקב באמצעות המפתח שצוין. ניתן לכתיבה
name string השם המוצג של התג. ניתן לכתיבה
notes string הערות משתמש לגבי אופן ההחלה של התג הזה במאגר. ניתן לכתיבה
parameter[] list הפרמטרים של התג ניתן לכתיבה
parameter[].isWeakReference boolean האם יש הפניה חזקה או חלשה לפרמטר של סוג הפניה. משמש רק לטרנספורמציות. ניתן לכתיבה
parameter[].key string המפתח בעל השם שמזהה את הפרמטר באופן ייחודי. חובה לפרמטרים ברמה העליונה וגם לערכי מפה. המערכת התעלמה מערכי הרשימה. ניתן לכתיבה
parameter[].list[] list הפרמטרים של הפרמטר ברשימה הזו (המערכת תתעלם ממפתחות). ניתן לכתיבה
parameter[].map[] list הפרמטרים של פרמטר המפה הזה (חייבים לכלול מפתחות, המפתחות חייבים להיות ייחודיים). ניתן לכתיבה
parameter[].type string סוג הפרמטר הערכים החוקיים הם:
  • boolean: הערך מייצג ערך בוליאני, שמיוצג כ-'true'. או 'false'
  • integer: הערך מייצג ערך של מספר שלם חתום של 64 ביט, בבסיס 10
  • list: יש לציין רשימת פרמטרים
  • map: יש לציין מפה של פרמטרים
  • template: הערך מייצג כל טקסט שהוא. כתובת זו יכולה לכלול הפניות למשתנים (גם הפניות למשתנים שעשויות להחזיר סוגים שאינם מחרוזות)
  • trigger_reference: הערך מייצג טריגר, שמיוצג כמזהה הטריגר
  • tag_reference: הערך מייצג תג שמיוצג כשם התג


הערכים הקבילים הם:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
ניתן לכתיבה
parameter[].value string ערך של פרמטר (עשוי להכיל הפניות למשתנים כמו "") בהתאם לסוג שצוין. ניתן לכתיבה
parentFolderId string המזהה של תיקיית ההורה.
path string הנתיב היחסי של ה-API של תג GTM.
paused boolean בעמודה הזו מציינים אם התג מושהה, ולכן הוא לא יופעל. ניתן לכתיבה
priority nested object העדיפות המספרית של התג, שהוגדרה על ידי המשתמש. התגים מופעלים באופן אסינכרוני לפי סדר העדיפות. תגים עם ערך מספרי גבוה יותר מופעלים ראשונים. עדיפות של תג יכולה להיות ערך חיובי או שלילי. ערך ברירת המחדל הוא 0. ניתן לכתיבה
priority.isWeakReference boolean האם יש הפניה חזקה או חלשה לפרמטר של סוג הפניה. משמש רק לטרנספורמציות. ניתן לכתיבה
priority.key string המפתח בעל השם שמזהה את הפרמטר באופן ייחודי. חובה לפרמטרים ברמה העליונה וגם לערכי מפה. המערכת התעלמה מערכי הרשימה. ניתן לכתיבה
priority.list[] list הפרמטרים של הפרמטר ברשימה הזו (המערכת תתעלם ממפתחות). ניתן לכתיבה
priority.map[] list הפרמטרים של פרמטר המפה הזה (חייבים לכלול מפתחות, המפתחות חייבים להיות ייחודיים). ניתן לכתיבה
priority.type string סוג הפרמטר הערכים החוקיים הם:
  • boolean: הערך מייצג ערך בוליאני, שמיוצג כ-'true'. או 'false'
  • integer: הערך מייצג ערך של מספר שלם חתום של 64 ביט, בבסיס 10
  • list: יש לציין רשימת פרמטרים
  • map: יש לציין מפה של פרמטרים
  • template: הערך מייצג כל טקסט שהוא. כתובת זו יכולה לכלול הפניות למשתנים (גם הפניות למשתנים שעשויות להחזיר סוגים שאינם מחרוזות)
  • trigger_reference: הערך מייצג טריגר, שמיוצג כמזהה הטריגר
  • tag_reference: הערך מייצג תג שמיוצג כשם התג


הערכים הקבילים הם:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
ניתן לכתיבה
priority.value string ערך של פרמטר (עשוי להכיל הפניות למשתנים כמו "") בהתאם לסוג שצוין. ניתן לכתיבה
scheduleEndMs long חותמת הזמן של הסיום באלפיות השנייה כדי לתזמן תג. ניתן לכתיבה
scheduleStartMs long חותמת הזמן של ההתחלה באלפיות השנייה כדי לתזמן תג. ניתן לכתיבה
setupTag[] list רשימת התגים להגדרה. כרגע אנחנו מאפשרים שימוש רק באחד מהם.
setupTag[].stopOnSetupFailure boolean אם הערך הוא True, התג הראשי יופעל אם ורק אם תג ההגדרה מופעל בהצלחה. אם הערך הוא false, יש להפעיל את התג הראשי ללא קשר לסטטוס ההפעלה של התג.
setupTag[].tagName string השם של תג ההגדרה.
tagFiringOption string אפשרות להפעלת התג.

הערכים הקבילים הם:
  • "oncePerEvent"
  • "oncePerLoad"
  • "tagFiringOptionUnspecified"
  • "unlimited"
tagId string מזהה התג הוא מזהה ייחודי של תג ה-GTM.
tagManagerUrl string קישור שנוצר באופן אוטומטי לממשק המשתמש של Tag Manager
teardownTag[] list הרשימה של תגי ניתוק. כרגע אנחנו מאפשרים שימוש רק באחד מהם.
teardownTag[].stopTeardownOnFailure boolean אם הפרמטר מקבל את הערך True, הוא יופעל רק אם התג הראשי מופעל בהצלחה. אם הערך הוא False, יש להפעיל את תג ההסרה ללא קשר לסטטוס ההפעלה של התג הראשי.
teardownTag[].tagName string השם של תג הקרקוע.
type string סוג התג של GTM. ניתן לכתיבה
workspaceId string מזהה GTM של Workspace.

שיטות

יצירה
יצירת תג GTM.
מחיקה
מחיקת תג GTM.
הורדה
מקבלים תג GTM.
list
רשימה של כל תגי GTM של קונטיינר.
חזרה
ביטול השינויים בתג GTM ב-GTM Workspace.
עדכון
מעדכנים תג GTM.