Variables: create

נדרשת הרשאה

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

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים של נתיב
accountId string מספר החשבון ב-GTM.
containerId string מזהה מאגר התגים של GTM.

אישור

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

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

גוף הבקשה

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

שם הנכס ערך תיאור הערות
המאפיינים הנדרשים
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 וכל הטריגר להשבתה מוגדר כ-False. טופלו כקבוצה לא ממוינת. ניתן לכתיבה
enablingTriggerId[] list לקונטיינרים לנייד בלבד: רשימה של מזהי טריגר להפעלת משתנים מותנים. המשתנה יהיה פעיל אם אחד מהטריגרים המפעילים מתקיים True וכל הטריגרים להשבתה מוגדרים כ-False. טופלו כקבוצה לא ממוינת. ניתן לכתיבה
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 creates a new 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().create("123456", "54321", variable).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the create method are stored in the response object.
 * The following code shows how to access the created Id and Fingerprint.
 */
System.out.println("Variable Id = " + response.getVariableId());
System.out.println("Variable Fingerprint = " + response.getFingerprint());

Python

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

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

# This request creates a new variable.
try:
  response = tagmanager.accounts().containers().variables().create(
      accountId='23732470',
      containerId='801231',
      body={
          'name': '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 create method are stored in response object.
# The following code shows how to access the created id and fingerprint.
print 'Variable Id = %s' % response.get('variableId')
print 'Variable Fingerprint = %s' % response.get('fingerprint')

נסה בעצמך!

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