REST Resource: accounts.containers.workspaces.tags

משאב: תג

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

ייצוג ב-JSON 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
שדות
path

string

הנתיב היחסי של ה-API של תג GTM.
accountId

string

מזהה החשבון ב-GTM.
containerId

string

מזהה מאגר התגים של GTM.
workspaceId

string

מזהה סביבת העבודה ב-GTM.
tagId

string

מזהה התג מזהה באופן ייחודי את תג GTM.
name

string

השם המוצג של התג.
type

string

סוג התג ב-GTM.
liveOnly

boolean

אם הערך מוגדר כ-true, התג הזה יופעל רק בסביבת הייצור (למשל, לא בתצוגה המקדימה או במצב ניפוי באגים).
priority

object (Parameter)

תעדוף מספרי של התג שהוגדר על ידי המשתמש. התגים מופעלים באופן אסינכרוני לפי סדר העדיפות. תגים עם ערך מספרי גבוה יותר מופעלים קודם. העדיפות של התג יכולה להיות ערך חיובי או שלילי. ערך ברירת המחדל הוא 0.
notes

string

הערות של משתמשים לגבי האופן שבו מחילים את התג הזה במאגר.
scheduleStartMs

string (int64 format)

חותמת הזמן של ההתחלה באלפיות השנייה לתזמון תג.
scheduleEndMs

string (int64 format)

חותמת הזמן של הסיום באלפיות השנייה לקביעת לוח זמנים לתג.
parameter[]

object (Parameter)

הפרמטרים של התג.
fingerprint

string

טביעת האצבע של תג GTM כפי שחושב בזמן האחסון. הערך הזה מחושב מחדש בכל פעם שהתג משתנה.
firingTriggerId[]

string

מזהי טריגרים שהופעלו. תג יופעל כאשר אחד מהטריגרים המפורטים יהיה נכון וכל

blockingTriggerIds

(אם צוינו) הם שגויים.
blockingTriggerId[]

string

מזהי טריגרים לחסימה. אם אחד מהטריגרים המפורטים מקבל את הערך True, התג לא יופעל.
setupTag[]

object (SetupTag)

רשימת תגי ההגדרה. בשלב זה אנחנו מאפשרים להוסיף רק אחד.
teardownTag[]

object (TeardownTag)

רשימת התגים של ניתוק השירות. בשלב זה אנחנו מאפשרים להוסיף רק אחד.
parentFolderId

string

מזהה התיקייה הראשית.
tagFiringOption

enum (TagFiringOption)

אפשרות להפעיל את התג הזה.
tagManagerUrl

string

קישור שנוצר באופן אוטומטי לממשק המשתמש של Tag Manager
paused

boolean

מציין אם התג מושהה, וכתוצאה מכך הוא לא יופעל.
monitoringMetadata

object (Parameter)

מפה של צמדי מפתח/ערך של מטא-נתונים של תגים שכלולים בנתוני האירועים למעקב אחר תגים. הערות:

  • הפרמטר הזה חייב להיות מסוג

    MAP

    .

  • כל פרמטר במפה הוא מסוג

    TEMPLATE

    , אבל לא יכולות להכיל הפניות למשתנים.
monitoringMetadataTagNameKey

string

אם השדה לא ריק, שם התג יופיע במפת המטא-נתונים של המעקב באמצעות המפתח שצוין.
consentSettings

object (ConsentSetting)

הגדרות ההסכמה של תג.

SetupTag

מייצג הפניה לתג שמופעל לפני תג אחר כדי להגדיר יחסי תלות.

ייצוג ב-JSON 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
שדות
tagName

string

השם של תג ההגדרה.
stopOnSetupFailure

boolean

אם הערך הוא true, התג הראשי יופעל רק אם תג ההגדרה יופעל בהצלחה. אם הערך הוא false, התג הראשי יופעל ללא קשר לסטטוס ההפעלה של תג ההגדרה.

TeardownTag

מייצג תג שפועל אחרי תג אחר כדי לבטל את התלות.

ייצוג ב-JSON 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
שדות
tagName

string

השם של תג ה-teardown.
stopTeardownOnFailure

boolean

אם הערך הוא True, תג ה-teardown יופעל רק אם התג הראשי יופעל בהצלחה. אם הערך הוא false, תג ה-teardown יופעל ללא קשר לסטטוס ההפעלה של התג הראשי.

TagFiringOption

טיפוסים בני מנייה (enum)
tagFiringOptionUnspecified
unlimited אפשר להפעיל את התג כמה פעמים בכל אירוע.
oncePerEvent אפשר להפעיל את התג רק לכל אירוע, אבל אפשר להפעיל אותו כמה פעמים לכל טעינת דף (למשל, טעינת אפליקציה או טעינת דף).
oncePerLoad אפשר להפעיל את התג רק לכל טעינת דף (למשל, טעינת אפליקציה או טעינת דף).

ConsentSetting

ייצוג ב-JSON 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
שדות
consentStatus

enum (ManualConsentOption)

סטטוס ההסכמה של התג. אם הערך מוגדר כ-NEEDED, סביבת זמן הריצה תבדוק שסוגי ההסכמה שצוינו על ידי

consentType

ניתנו.
consentType

object (Parameter)

סוג ההסכמות שצריך לבדוק במהלך הפעלת התג אם הוא נמצא בסטטוס 'נדרשת הסכמה'. הסוג של הפרמטר הזה חייב להיות

LIST

כאשר כל פריט ברשימה הוא מסוג

STRING

.

ManualConsentOption

טיפוסים בני מנייה (enum)
notSet ערך ברירת המחדל כשהמשתמש לא ציין הגדרה כלשהי.
notNeeded התג לא דורש הגדרות הסכמה נוספות.
needed נדרשות הגדרות הסכמה נוספות בתג.

Methods

create

 יצירת תג GTM.

delete

 מחיקה של תג GTM.

get

 הפונקציה מקבלת תג GTM.

list

 הצגת רשימה של כל תגי GTM של מאגר תגים.

revert

 החזרת השינויים בתג GTM בסביבת עבודה ב-GTM.

update

 עדכון תג GTM.