Tags: update

נדרשת הרשאה

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

בקשה

בקשת HTTP

PUT https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/tags/tagId

פרמטרים

שם הפרמטר Value התיאור
פרמטרים של נתיב
accountId string מספר החשבון ב-GTM.
containerId string מזהה מאגר התגים של GTM.
tagId string המזהה של תג ה-GTM.
פרמטרים אופציונליים של שאילתה
fingerprint string כשמזינים את טביעת האצבע, היא צריכה להתאים לטביעת האצבע של התג באחסון.

הרשאות

בקשה זו מחייבת הרשאה בהיקף הבא (למידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/tagmanager.edit.containers

גוף הבקשה

בגוף הבקשה, מציינים משאב תגים עם המאפיינים הבאים:

שם הנכס Value התיאור הערות
מאפיינים נדרשים
name string השם המוצג של התג. ניתן לכתיבה
parameter[].type string סוג הפרמטר. הערכים החוקיים הם:
  • boolean: הערך מייצג בוליאני, מיוצג כ-true או כ-false
  • integer: הערך מייצג ערך של מספר שלם חתום של 64 ביט, בבסיס 10
  • list: יש לציין רשימה של פרמטרים
  • map: יש לציין מפה של פרמטרים
  • template: הערך מייצג כל טקסט. הוא יכול לכלול הפניות למשתנים (גם הפניות למשתנים שעשויות להחזיר סוגים שאינם מחרוזות)
  • trigger_reference: הערך מייצג טריגר, שמיוצג כמזהה הטריגר


הערכים הקבילים הם:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
ניתן לכתיבה
priority.type string סוג הפרמטר. הערכים החוקיים הם:
  • boolean: הערך מייצג בוליאני, מיוצג כ-true או כ-false
  • integer: הערך מייצג ערך של מספר שלם חתום של 64 ביט, בבסיס 10
  • list: יש לציין רשימה של פרמטרים
  • map: יש לציין מפה של פרמטרים
  • template: הערך מייצג כל טקסט. הוא יכול לכלול הפניות למשתנים (גם הפניות למשתנים שעשויות להחזיר סוגים שאינם מחרוזות)
  • trigger_reference: הערך מייצג טריגר, שמיוצג כמזהה הטריגר


הערכים הקבילים הם:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
ניתן לכתיבה
מאפיינים אופציונליים
blockingRuleId[] list חסימה של מזהי כללים. אם אחד מהכללים ברשימה הוא True, התג לא יופעל. ניתן לכתיבה
blockingTriggerId[] list חסימה של מזהי טריגרים. אם גורם כלשהו מהטריגרים שמופיעים ברשימה מקבל את הערך True, התג לא יופעל. ניתן לכתיבה
firingRuleId[] list מזהים של כללי הפעלה. תג יופעל כאשר אחד מהכללים ברשימה מתקיים וכל blockingRuleIds שלו (אם צוין) שגוי. ניתן לכתיבה
firingTriggerId[] list הפעלת מזהים של טריגרים. תג יופעל כשכל אחד מהטריגרים שמופיעים ברשימה יהיה TRUE וכל ה-blockingTriggerIds שלו (אם צוין) false. ניתן לכתיבה
liveOnly boolean אם המדיניות מוגדרת כ-True, התג יופעל רק בסביבה הפעילה (למשל, לא במצב תצוגה מקדימה או ניפוי באגים). ניתן לכתיבה
notes string משתמש הערות לגבי אופן ההחלה של התג הזה בכלי הקיבול. ניתן לכתיבה
parameter[] list הפרמטרים של התג. ניתן לכתיבה
parameter[].key string המפתח בעל השם שמזהה פרמטר באופן ייחודי. נדרש לפרמטרים ברמה העליונה, וגם לערכי מפה. המערכת התעלמה מערכים ברשימה. ניתן לכתיבה
parameter[].list[] list הפרמטרים של פרמטר הרשימה הזו (המערכת תתעלם מהמפתחות). ניתן לכתיבה
parameter[].map[] list הפרמטרים של פרמטר המפה הזה (חייבים לכלול מפתחות, המפתחות חייבים להיות ייחודיים). ניתן לכתיבה
parameter[].value string ערך של פרמטר (עשוי להכיל הפניות למשתנים כגון "") בהתאם לסוג שצוין. ניתן לכתיבה
paused boolean הערך יהיה True אם התג מושהה. ניתן לכתיבה
priority nested object עדיפות מספרית בהגדרת המשתמש של התג. התגים מופעלים באופן אסינכרוני לפי סדר העדיפות שלהם. תגים עם ערך מספרי גבוה יותר מופעלים קודם. עדיפות התג יכולה להיות ערך חיובי או שלילי. ערך ברירת המחדל הוא 0. ניתן לכתיבה
priority.key string המפתח בעל השם שמזהה פרמטר באופן ייחודי. נדרש לפרמטרים ברמה העליונה, וגם לערכי מפה. המערכת התעלמה מערכים ברשימה. ניתן לכתיבה
priority.list[] list הפרמטרים של פרמטר הרשימה הזו (המערכת תתעלם מהמפתחות). ניתן לכתיבה
priority.map[] list הפרמטרים של פרמטר המפה הזה (חייבים לכלול מפתחות, המפתחות חייבים להיות ייחודיים). ניתן לכתיבה
priority.value string ערך של פרמטר (עשוי להכיל הפניות למשתנים כגון "") בהתאם לסוג שצוין. ניתן לכתיבה
scheduleEndMs long חותמת הזמן של הסיום באלפיות השנייה לתזמון תג. ניתן לכתיבה
scheduleStartMs long חותמת הזמן של ההתחלה באלפיות השנייה לתזמון תג. ניתן לכתיבה
type string סוג התג ב-GTM. ניתן לכתיבה

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאב תגים בגוף התגובה.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

Java

משתמש בספריית הלקוח של Java.

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request updates an existing tag for the authorized user.
 */

// Construct the parameters.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("trackingId");
arg0.setValue("UA-123456-1");

Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("type");
arg1.setValue("TRACK_TRANSACTION");

// Construct the tag object.
Tag tag = new Tag();
tag.setName("Sample Universal Analytics");
tag.setType("ua");
tag.setLiveOnly(false);
tag.setParameter(Arrays.asList(arg0, arg1));

try {
  Tag response = tagmanager.accounts().
      containers().tags().update("123456", "54321", "1", tag).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the update method are stored in the response object.
 * The following code shows how to access the updated name and fingerprint.
 */
System.out.println("Updated Name = " + response.getName());
System.out.println("Updated Fingerprint = " + response.getFingerprint());

Python

עושה שימוש בספריית הלקוח של Python.

# Note: This code assumes you have an authorized tagmanager service object.

# This request updates an existing new container tag.
try:
  response = tagmanager.accounts().containers().tags().update(
      accountId='123456',
      containerId='54321',
      tagId='1',
      body={
          'name': 'Universal Analytics Tag',
          'type': 'ua',
          'liveOnly': False,
          'parameter': [
              {
                  'type': 'template',
                  'key': 'trackingId',
                  'value': 'UA-123456-1'
              },
              {
                  'type': 'template',
                  'key': 'type',
                  'value': 'TRACK_TRANSACTION'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the update method are stored in the response object.
# The following code shows how to access the updated name and fingerprint.
print 'Updated Name = %s' % response.get('name')
print 'Updated Fingerprint = %s' % response.get('fingerprint')

רוצה לנסות?

ניתן להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.