Tags

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

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

מייצג תג של 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
    }
  }
}
שם הנכס Value התיאור הערות
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 הפעלת מזהים של טריגרים. תג יופעל כשכל אחד מהטריגרים שמופיעים ברשימה יהיה TRUE וכל ה-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 של כלי קיבול.
revert
מחזיר את השינויים בתג GTM ב-GTM Workspace.
עדכון
מעדכן תג GTM.