REST Resource: accounts.containers.workspaces.tags

منبع: برچسب

نشان دهنده یک برچسب Google Tag Manager است.

نمایندگی JSON 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
فیلدها
path

string

مسیر نسبی API تگ GTM.

accountId

string

شناسه حساب GTM.

containerId

string

شناسه کانتینر GTM.

workspaceId

string

شناسه فضای کاری GTM.

tagId

string

شناسه برچسب به طور منحصر به فرد برچسب GTM را شناسایی می کند.

name

string

نام نمایشی برچسب

type

string

نوع برچسب GTM

liveOnly

boolean

اگر روی true تنظیم شود، این تگ فقط در محیط زنده فعال می شود (مثلاً در حالت پیش نمایش یا اشکال زدایی).

priority

object ( Parameter )

اولویت عددی تگ تعریف شده توسط کاربر. برچسب ها به ترتیب اولویت به صورت ناهمزمان شلیک می شوند. برچسب هایی با ارزش عددی بالاتر ابتدا فعال می شوند. اولویت یک برچسب می تواند یک مقدار مثبت یا منفی باشد. مقدار پیش فرض 0 است.

notes

string

یادداشت های کاربر در مورد نحوه اعمال این برچسب در ظرف.

scheduleStartMs

string ( int64 format)

مهر زمان شروع در میلی ثانیه برای برنامه ریزی یک برچسب.

scheduleEndMs

string ( int64 format)

مهر زمانی پایان در میلی ثانیه برای برنامه ریزی یک برچسب.

parameter[]

object ( Parameter )

پارامترهای برچسب

fingerprint

string

اثر انگشت برچسب GTM همانطور که در زمان ذخیره سازی محاسبه می شود. این مقدار هر زمان که تگ اصلاح شود دوباره محاسبه می شود.

firingTriggerId[]

string

فعال کردن شناسه های ماشه. یک برچسب زمانی فعال می شود که هر یک از محرک های لیست شده درست باشد و تمام موارد آن درست باشد

blockingTriggerIds

(در صورت مشخص بودن) نادرست هستند.

blockingTriggerId[]

string

مسدود کردن شناسه های ماشه اگر هر یک از محرک های فهرست شده درست ارزیابی شود، تگ فعال نمی شود.

setupTag[]

object ( SetupTag )

لیست تگ های راه اندازی در حال حاضر فقط یک مورد را مجاز می‌دانیم.

teardownTag[]

object ( TeardownTag )

لیست تگ های پاره کردن. در حال حاضر فقط یک مورد را مجاز می‌دانیم.

parentFolderId

string

شناسه پوشه والد

tagFiringOption

enum ( TagFiringOption )

گزینه ای برای فعال کردن این برچسب.

tagManagerUrl

string

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

paused

boolean

نشان می دهد که آیا برچسب متوقف شده است یا خیر، که از شلیک برچسب جلوگیری می کند.

monitoringMetadata

object ( Parameter )

نقشه‌ای از جفت‌های کلید-مقدار متادیتای برچسب که در داده‌های رویداد برای نظارت بر برچسب گنجانده می‌شود. یادداشت ها:

  • این پارامتر باید نوع باشد

    MAP

    .

  • هر پارامتر در نقشه نوع است

    TEMPLATE

    ، اما نمی تواند حاوی ارجاعات متغیر باشد.

monitoringMetadataTagNameKey

string

اگر خالی نباشد، نام نمایش برچسب با استفاده از کلید مشخص شده در نقشه ابرداده نظارتی گنجانده می شود.

consentSettings

object ( ConsentSetting )

تنظیمات رضایت یک برچسب

SetupTag

نشان دهنده ارجاع به برچسبی است که قبل از تگ دیگری فعال می شود تا وابستگی ها را تنظیم کند.

نمایندگی JSON 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
فیلدها
tagName

string

نام تگ راه اندازی.

stopOnSetupFailure

boolean

اگر درست است، اگر و فقط در صورتی که تگ راه اندازی با موفقیت فعال شود، تگ اصلی را فعال کنید. اگر نادرست است، برچسب اصلی را بدون توجه به وضعیت شلیک تگ راه‌اندازی فعال کنید.

TeardownTag

نشان دهنده برچسبی است که پس از تگ دیگر فعال می شود تا وابستگی ها را از بین ببرد.

نمایندگی JSON 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
فیلدها
tagName

string

نام تگ Teardown.

stopTeardownOnFailure

boolean

اگر درست است، اگر و فقط در صورتی که تگ اصلی با موفقیت فعال شود، تگ پارگی را فعال کنید. اگر نادرست است، بدون در نظر گرفتن وضعیت شلیک برچسب اصلی، برچسب پارگی را شلیک کنید.

TagFiringOption

Enums
tagFiringOptionUnspecified
unlimited برچسب می تواند چندین بار در هر رویداد شلیک شود.
oncePerEvent برچسب را فقط در هر رویداد می‌توان اجرا کرد، اما می‌توان آن را چندین بار در هر بار اجرا کرد (مثلاً بارگذاری برنامه یا بارگیری صفحه).
oncePerLoad برچسب فقط در هر بارگذاری قابل اجرا است (مثلاً بارگذاری برنامه یا بارگیری صفحه).

ConsentSetting

نمایندگی JSON 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
فیلدها
consentStatus

enum ( ManualConsentOption )

وضعیت رضایت برچسب اگر روی NEEDED تنظیم شود، زمان اجرا بررسی می کند که آیا انواع رضایت مشخص شده توسط

consentType

زمینه اعطا شده است.

consentType

object ( Parameter )

نوع رضایت‌هایی که در حین شلیک برچسب، در صورت نیاز به رضایت، بررسی می‌شوند. این پارامتر باید از نوع باشد

LIST

که در آن هر مورد لیست از نوع خود است

STRING

.

ManualConsentOption

Enums
notSet مقدار پیش‌فرض جایی که کاربر هیچ تنظیمی روی آن تعیین نکرده است.
notNeeded برچسب به تنظیمات رضایت اضافی نیاز ندارد.
needed برچسب به تنظیمات رضایت اضافی نیاز دارد.

روش ها

create

 یک تگ GTM ایجاد می کند.

delete

 برچسب GTM را حذف می کند.

get

 یک برچسب GTM دریافت می کند.

list

 همه برچسب‌های GTM یک کانتینر را فهرست می‌کند.

revert

 تغییرات را به یک برچسب GTM در یک فضای کاری GTM برمی‌گرداند.

update

 یک برچسب GTM را به روز می کند.