REST Resource: accounts.containers.environments

משאב: סביבה

מייצג סביבה ב-Google Tag Manager. הערה: משתמשים יכולים ליצור, למחוק ולעדכן סביבות מסוג USER, אבל הם יכולים לעדכן רק את השדות enableDebug ו-url של סביבות מסוגים אחרים.

ייצוג ב-JSON 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": enum (EnvironmentType),
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestamp": string,
  "tagManagerUrl": string,

  // Union field Link can be only one of the following:
  "containerVersionId": string,
  "workspaceId": string
  // End of list of possible types for union field Link.
}
שדות
path

string

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

string

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

string

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

string

מזהה הסביבה ב-GTM הוא מזהה ייחודי של הסביבה ב-GTM.
type

enum (EnvironmentType)

הסוג של הסביבה הזו.
fingerprint

string

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

string

שם הסביבה המוצג. אפשר להגדיר או לשנות את ההגדרה הזו רק בסביבות מסוג USER.
description

string

תיאור הסביבה. אפשר להגדיר או לשנות את ההגדרה הזו רק בסביבות מסוג USER.
enableDebug

boolean

האם להפעיל ניפוי באגים כברירת מחדל בסביבה.
url

string

כתובת ה-URL של דף התצוגה המקדימה שמוגדרת כברירת מחדל בסביבה.
authorizationCode

string

קוד ההרשאה של הסביבה.
authorizationTimestamp

string (Timestamp format)

חותמת הזמן של העדכון האחרון של קוד ההרשאה.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
tagManagerUrl

string

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

string

מייצג קישור לגרסה של מאגר תגים.
workspaceId

string

מייצג קישור לתצוגה מקדימה מהירה של סביבת עבודה.

EnvironmentType

טיפוסים בני מנייה (enum)
user מפנה לסביבה מוגדרת על ידי משתמש.
live מצביע על גרסת הקונטיינר הנוכחית שפעילה.
latest מפנה לגרסה האחרונה של הקונטיינר.
workspace סביבה בניהול אוטומטי שמצביעה על גרסה או תצוגה מקדימה של סביבת עבודה שנוצרה על ידי סביבת עבודה.

Methods

create

 יצירת סביבה ב-GTM.

delete

 מחיקה של סביבה ב-GTM.

get

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

list

 רשימה של כל הסביבות ב-GTM של מאגר תגים ב-GTM.

reauthorize

 יצירת מחדש של קוד ההרשאה לסביבת GTM.

update

 עדכון של סביבה ב-GTM.