REST Resource: accounts.containers.environments

منبع: محیط زیست

نشان دهنده یک محیط مدیریت برچسب گوگل است. توجه داشته باشید که کاربر می‌تواند محیط‌هایی از نوع 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

نام نمایشی محیط. فقط در محیط‌های نوع کاربر قابل تنظیم یا تغییر است.

description

string

توضیحات محیط. فقط در محیط‌های نوع کاربر قابل تنظیم یا تغییر است.

enableDebug

boolean

آیا اشکال‌زدایی به‌طور پیش‌فرض برای محیط فعال باشد یا خیر.

url

string

آدرس اینترنتی پیش‌فرض صفحه پیش‌نمایش برای محیط.

authorizationCode

string

کد مجوز محیط زیست

authorizationTimestamp

string ( Timestamp format)

آخرین مهر زمانی به‌روزرسانی برای کد مجوز.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

tagManagerUrl

string

لینک خودکار ایجاد شده به رابط کاربری مدیریت تگ

containerVersionId

string

نشان دهنده لینکی به نسخه کانتینر است.

workspaceId

string

پیوندی به پیش‌نمایش سریع یک فضای کاری را نشان می‌دهد.

نوع محیط

انوم‌ها
user به یک محیط تعریف شده توسط کاربر اشاره می‌کند.
live به نسخه فعلی کانتینر زنده اشاره می‌کند.
latest به آخرین نسخه کانتینر اشاره دارد.
workspace محیطی که به صورت خودکار مدیریت می‌شود و به پیش‌نمایش فضای کاری یا نسخه‌ای که توسط یک فضای کاری ایجاد شده است، اشاره می‌کند.

روش‌ها

create

 یک محیط GTM ایجاد می‌کند.

delete

 یک محیط GTM را حذف می‌کند.

get

 یک محیط GTM دریافت می‌کند.

list

 تمام محیط‌های GTM یک کانتینر GTM را فهرست می‌کند.

reauthorize

 کد مجوز را برای یک محیط GTM دوباره تولید می‌کند.

update

 محیط GTM را به‌روزرسانی می‌کند.