Variables: update

נדרשת הרשאה

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

בקשה

בקשת HTTP

PUT https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/variables/variableId

פרמטרים

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

הרשאות

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

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

גוף הבקשה

בגוף הבקשה, מספקים משאב Variables (משתנים) עם המאפיינים הבאים:

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

תשובה

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

דוגמאות

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

Java

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

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

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

// Create the variable object.
Variable variable = new Variable();
variable.setName("RandomNumber");
variable.setType("r"); // The random number type.

try {
  Variable response = tagmanager.accounts().containers().
      variables().update("12345", "54321", "2", variable).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 variable.
try:
  response = tagmanager.accounts().containers().variables().update(
      accountId='123456',
      containerId='54321',
      variableId='4',
      body={
          'name': 'updated_random_number',
          'type': 'r'
      }
  ).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 שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.