Tags

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

بازنمایی منابع

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

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
نام ملک ارزش شرح یادداشت
accountId string شناسه حساب GTM.
blockingRuleId[] list مسدود کردن شناسه قوانین اگر هر یک از قوانین ذکر شده درست ارزیابی شود، تگ فعال نمی شود. قابل نوشتن
blockingTriggerId[] list مسدود کردن شناسه های ماشه اگر هر یک از محرک های فهرست شده درست ارزیابی شود، تگ فعال نمی شود. قابل نوشتن
consentSettings nested object تنظیمات رضایت یک برچسب قابل نوشتن
consentSettings. consentStatus string وضعیت رضایت برچسب اگر روی NEEDED تنظیم شود، زمان اجرا بررسی می‌کند که آیا انواع رضایت مشخص‌شده در قسمت consent_type اعطا شده‌اند.

مقادیر قابل قبول عبارتند از:
  • " needed "
  • " notNeeded "
  • " notSet "
consentSettings. consentType nested object نوع رضایت‌هایی که در حین شلیک برچسب، در صورت نیاز به رضایت، بررسی می‌شوند. این پارامتر باید از نوع LIST باشد که در آن هر مورد لیست از نوع STRING است.
consentSettings.consentType. isWeakReference boolean اینکه آیا یک پارامتر نوع مرجع به شدت یا ضعیف ارجاع داده می شود یا خیر. فقط توسط Transformations استفاده می شود. قابل نوشتن
consentSettings.consentType. key string کلید نامگذاری شده که به طور منحصر به فرد یک پارامتر را شناسایی می کند. برای پارامترهای سطح بالا و همچنین مقادیر نقشه مورد نیاز است. برای مقادیر لیست نادیده گرفته شد. قابل نوشتن
consentSettings.consentType. list[] list پارامترهای این پارامتر فهرست (کلیدها نادیده گرفته خواهند شد). قابل نوشتن
consentSettings.consentType. map[] list پارامترهای این پارامتر نقشه (باید کلید داشته باشد؛ کلیدها باید منحصر به فرد باشند). قابل نوشتن
consentSettings.consentType. type string نوع پارامتر مقادیر معتبر عبارتند از:
  • boolean : مقدار یک بولی را نشان می دهد که به صورت "درست" یا "نادرست" نمایش داده می شود.
  • integer : این مقدار یک مقدار عدد صحیح امضا شده 64 بیتی را در پایه 10 نشان می دهد
  • list : لیستی از پارامترها باید مشخص شود
  • map : یک نقشه از پارامترها باید مشخص شود
  • template : مقدار هر متنی را نشان می دهد. این می تواند شامل مراجع متغیر باشد (حتی مراجع متغیری که ممکن است انواع غیر رشته ای را برگرداند)
  • trigger_reference : مقدار نشان دهنده یک ماشه است که به عنوان شناسه ماشه نشان داده می شود
  • tag_reference : مقدار نشان دهنده یک برچسب است که به عنوان نام برچسب نشان داده می شود


مقادیر قابل قبول عبارتند از:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
قابل نوشتن
consentSettings.consentType. value string مقدار یک پارامتر (ممکن است حاوی ارجاعات متغیری مانند "") متناسب با نوع مشخص شده باشد. قابل نوشتن
containerId string شناسه کانتینر GTM.
fingerprint string اثر انگشت برچسب GTM همانطور که در زمان ذخیره سازی محاسبه می شود. این مقدار هر زمان که تگ اصلاح شود دوباره محاسبه می شود.
firingRuleId[] list شناسه قوانین شلیک یک تگ زمانی فعال می شود که هر یک از قوانین فهرست شده درست باشد و همه blockingRuleIds آن (در صورت مشخص بودن) نادرست باشند. قابل نوشتن
firingTriggerId[] list فعال کردن شناسه های ماشه. یک برچسب زمانی فعال می شود که هر یک از محرک های فهرست شده درست باشد و تمام blockingTriggerIds آن (در صورت مشخص شدن) نادرست باشند. قابل نوشتن
liveOnly boolean اگر روی true تنظیم شود، این تگ فقط در محیط زنده فعال می شود (مثلاً در حالت پیش نمایش یا اشکال زدایی). قابل نوشتن
monitoringMetadata nested object نقشه‌ای از جفت‌های کلید-مقدار متادیتای برچسب که در داده‌های رویداد برای نظارت بر برچسب گنجانده می‌شود. یادداشت:
  • این پارامتر باید از نوع MAP باشد.
  • هر پارامتر در نقشه از نوع TEMPLATE است، اما نمی تواند حاوی ارجاعات متغیر باشد.
قابل نوشتن
monitoringMetadata. isWeakReference boolean اینکه آیا یک پارامتر نوع مرجع به شدت یا ضعیف ارجاع داده می شود یا خیر. فقط توسط Transformations استفاده می شود. قابل نوشتن
monitoringMetadata. key string کلید نامگذاری شده که به طور منحصر به فرد یک پارامتر را شناسایی می کند. برای پارامترهای سطح بالا و همچنین مقادیر نقشه مورد نیاز است. برای مقادیر لیست نادیده گرفته شد. قابل نوشتن
monitoringMetadata. list[] list پارامترهای این پارامتر فهرست (کلیدها نادیده گرفته خواهند شد). قابل نوشتن
monitoringMetadata. map[] list پارامترهای این پارامتر نقشه (باید کلید داشته باشد؛ کلیدها باید منحصر به فرد باشند). قابل نوشتن
monitoringMetadata. type string نوع پارامتر مقادیر معتبر عبارتند از:
  • boolean : مقدار یک بولی را نشان می دهد که به صورت "درست" یا "نادرست" نمایش داده می شود.
  • integer : این مقدار یک مقدار عدد صحیح امضا شده 64 بیتی را در پایه 10 نشان می دهد
  • list : لیستی از پارامترها باید مشخص شود
  • map : یک نقشه از پارامترها باید مشخص شود
  • template : مقدار هر متنی را نشان می دهد. این می تواند شامل مراجع متغیر باشد (حتی مراجع متغیری که ممکن است انواع غیر رشته ای را برگرداند)
  • trigger_reference : مقدار نشان دهنده یک ماشه است که به عنوان شناسه ماشه نشان داده می شود
  • tag_reference : مقدار نشان دهنده یک برچسب است که به عنوان نام برچسب نشان داده می شود


مقادیر قابل قبول عبارتند از:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
قابل نوشتن
monitoringMetadata. value string مقدار یک پارامتر (ممکن است حاوی ارجاعات متغیری مانند "") متناسب با نوع مشخص شده باشد. قابل نوشتن
monitoringMetadataTagNameKey string اگر خالی نباشد، نام نمایش برچسب با استفاده از کلید مشخص شده در نقشه ابرداده نظارتی گنجانده می شود. قابل نوشتن
name string نام نمایشی برچسب قابل نوشتن
notes string یادداشت های کاربر در مورد نحوه اعمال این برچسب در ظرف. قابل نوشتن
parameter[] list پارامترهای برچسب قابل نوشتن
parameter[]. isWeakReference boolean اینکه آیا یک پارامتر نوع مرجع به شدت یا ضعیف ارجاع داده می شود یا خیر. فقط توسط Transformations استفاده می شود. قابل نوشتن
parameter[]. key string کلید نامگذاری شده که به طور منحصر به فرد یک پارامتر را شناسایی می کند. برای پارامترهای سطح بالا و همچنین مقادیر نقشه مورد نیاز است. برای مقادیر لیست نادیده گرفته شد. قابل نوشتن
parameter[]. list[] list پارامترهای این پارامتر فهرست (کلیدها نادیده گرفته خواهند شد). قابل نوشتن
parameter[]. map[] list پارامترهای این پارامتر نقشه (باید کلید داشته باشد؛ کلیدها باید منحصر به فرد باشند). قابل نوشتن
parameter[]. type string نوع پارامتر مقادیر معتبر عبارتند از:
  • boolean : مقدار یک بولی را نشان می دهد که به صورت "درست" یا "نادرست" نمایش داده می شود.
  • integer : این مقدار یک مقدار عدد صحیح امضا شده 64 بیتی را در پایه 10 نشان می دهد
  • list : لیستی از پارامترها باید مشخص شود
  • map : یک نقشه از پارامترها باید مشخص شود
  • template : مقدار هر متنی را نشان می دهد. این می تواند شامل مراجع متغیر باشد (حتی مراجع متغیری که ممکن است انواع غیر رشته ای را برگرداند)
  • trigger_reference : مقدار نشان دهنده یک ماشه است که به عنوان شناسه ماشه نشان داده می شود
  • tag_reference : مقدار نشان دهنده یک برچسب است که به عنوان نام برچسب نشان داده می شود


مقادیر قابل قبول عبارتند از:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
قابل نوشتن
parameter[]. value string مقدار یک پارامتر (ممکن است حاوی ارجاعات متغیری مانند "") متناسب با نوع مشخص شده باشد. قابل نوشتن
parentFolderId string شناسه پوشه والد
path string مسیر نسبی API تگ GTM.
paused boolean نشان می دهد که آیا برچسب متوقف شده است یا خیر، که از شلیک برچسب جلوگیری می کند. قابل نوشتن
priority nested object اولویت عددی تگ تعریف شده توسط کاربر. برچسب ها به ترتیب اولویت به صورت ناهمزمان شلیک می شوند. برچسب هایی با ارزش عددی بالاتر ابتدا فعال می شوند. اولویت یک برچسب می تواند یک مقدار مثبت یا منفی باشد. مقدار پیش فرض 0 است. قابل نوشتن
priority. isWeakReference boolean اینکه آیا یک پارامتر نوع مرجع به شدت یا ضعیف ارجاع داده می شود یا خیر. فقط توسط Transformations استفاده می شود. قابل نوشتن
priority. key string کلید نامگذاری شده که به طور منحصر به فرد یک پارامتر را شناسایی می کند. برای پارامترهای سطح بالا و همچنین مقادیر نقشه مورد نیاز است. برای مقادیر لیست نادیده گرفته شد. قابل نوشتن
priority. list[] list پارامترهای این پارامتر فهرست (کلیدها نادیده گرفته خواهند شد). قابل نوشتن
priority. map[] list پارامترهای این پارامتر نقشه (باید کلید داشته باشد؛ کلیدها باید منحصر به فرد باشند). قابل نوشتن
priority. type string نوع پارامتر مقادیر معتبر عبارتند از:
  • boolean : مقدار یک بولی را نشان می دهد که به صورت "درست" یا "نادرست" نمایش داده می شود.
  • integer : این مقدار یک مقدار عدد صحیح امضا شده 64 بیتی را در پایه 10 نشان می دهد
  • list : لیستی از پارامترها باید مشخص شود
  • map : یک نقشه از پارامترها باید مشخص شود
  • template : مقدار هر متنی را نشان می دهد. این می تواند شامل مراجع متغیر باشد (حتی مراجع متغیری که ممکن است انواع غیر رشته ای را برگرداند)
  • trigger_reference : مقدار نشان دهنده یک ماشه است که به عنوان شناسه ماشه نشان داده می شود
  • tag_reference : مقدار نشان دهنده یک برچسب است که به عنوان نام برچسب نشان داده می شود


مقادیر قابل قبول عبارتند از:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
قابل نوشتن
priority. value string مقدار یک پارامتر (ممکن است حاوی ارجاعات متغیری مانند "") متناسب با نوع مشخص شده باشد. قابل نوشتن
scheduleEndMs long مهر زمانی پایان در میلی ثانیه برای برنامه ریزی یک برچسب. قابل نوشتن
scheduleStartMs long مهر زمان شروع در میلی ثانیه برای برنامه ریزی یک برچسب. قابل نوشتن
setupTag[] list لیست تگ های راه اندازی در حال حاضر فقط یک مورد را مجاز می‌دانیم.
setupTag[]. stopOnSetupFailure boolean اگر درست است، اگر و فقط در صورتی که تگ راه اندازی با موفقیت فعال شود، تگ اصلی را فعال کنید. اگر نادرست است، برچسب اصلی را بدون توجه به وضعیت شلیک تگ راه‌اندازی فعال کنید.
setupTag[]. tagName string نام تگ راه اندازی.
tagFiringOption string گزینه ای برای فعال کردن این برچسب.

مقادیر قابل قبول عبارتند از:
  • " oncePerEvent "
  • " oncePerLoad "
  • " tagFiringOptionUnspecified "
  • " unlimited "
tagId string شناسه برچسب به طور منحصر به فرد برچسب GTM را شناسایی می کند.
tagManagerUrl string پیوند ایجاد شده خودکار به رابط کاربری تگ مدیر
teardownTag[] list لیست تگ های پاره کردن. در حال حاضر فقط یک مورد را مجاز می‌دانیم.
teardownTag[]. stopTeardownOnFailure boolean اگر درست است، اگر و فقط در صورتی که تگ اصلی با موفقیت فعال شود، برچسب پارگی را فعال کنید. اگر نادرست است، بدون در نظر گرفتن وضعیت شلیک برچسب اصلی، برچسب پارگی را شلیک کنید.
teardownTag[]. tagName string نام تگ Teardown.
type string نوع برچسب GTM قابل نوشتن
workspaceId string شناسه فضای کاری GTM.

مواد و روش ها

ايجاد كردن
یک تگ GTM ایجاد می کند.
حذف
برچسب GTM را حذف می کند.
گرفتن
یک برچسب GTM دریافت می کند.
فهرست
همه برچسب‌های GTM یک کانتینر را فهرست می‌کند.
برگرداندن
تغییرات را به یک برچسب GTM در یک فضای کاری GTM برمی‌گرداند.
به روز رسانی
یک برچسب GTM را به روز می کند.