API مدیر برچسب - مرجع پارامتر

این سند هدف و نمایش شی پارامتر Tag Manager را شرح می دهد.

مقدمه

API Tag Manager به شما امکان می دهد منابع Tag Manager مانند برچسب ها ، قوانین و ماکروها را ایجاد و مدیریت کنید.

اکثر انواع برچسب و ماکرو دارای پارامترهای اضافی هستند که مختص برچسب یا ماکرو هستند و می‌توانند هنگام ایجاد/به‌روزرسانی منبع تنظیم شوند. فهرست پارامترها ( key ، جفت type ) برای هر نوع برچسب و ماکرو در مرجع دیکشنری برچسب و مرجع فرهنگ لغت ماکرو فهرست شده است.

برای پیکربندی این پارامترهای خاص Tag یا Macro، یک شی پارامتر تعریف شده و به عنوان مقدار ویژگی parameter منبع Tag یا Macro تنظیم می شود.

شی پارامتر

شی زیر یک شی پارامتر را نشان می دهد:

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

نوع پارامتر تگ یا ماکرو در حال پیکربندی.

ویژگی type تعیین می کند که آیا یک value ، list یا ویژگی map باید در شی پارامتر گنجانده شود، همانطور که در جدول زیر توضیح داده شده است.

به عنوان مثال، اگر type روی boolean تنظیم شود، باید یک ویژگی value در شی پارامتر گنجانده شود و روی true یا false تنظیم شود.

ارزش	دارایی اضافی برای گنجاندن	ویژگی اضافی را به چه چیزی تنظیم کنیم
template	value	value هر رشته ای است، از جمله مراجع کلان، به عنوان مثال foo .
boolean	value	value یا true است یا false .
number	value	value یک عدد صحیح است.
list	list	list شامل صفر یا چند پارامتر خواهد بود، ترتیب ممکن است مهم نباشد. key هر پارامتر در list نادیده گرفته می شود.
map	map	map شامل صفر یا چند پارامتر خواهد بود، ترتیب مهم نیست. key هر پارامتر در map باید منحصر به فرد باشد.

key

کلید پارامتر برچسب یا ماکرو در حال پیکربندی.

فیلد key برای شناسایی پارامتر برچسب ها یا ماکروهای خاصی که در حال تنظیم هستند استفاده می شود. همه انواع پارامترها به یک ویژگی key نیاز دارند (به جز پارامترهای list ).

نمونه ها

یک شی پارامتر برای یک تگ HTML سفارشی ، که دارای یک پارامتر نوع template و دو پارامتر نوع boolean است:

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

یک شی پارامتر برای یک ماکرو جدول جستجو ، که دارای دو پارامتر نوع template و یک پارامتر نوع list است:

"parameter": [
  {
    "type": "template",
    "key": "input",
    "value": "{{event}}"
  },
  {
    "type": "list",
    "key": "map",
    "list": [
      {
        "type": "map",
        "map": [
          {
            "type": "template",
            "key": "key",
            "value": "EventEqualsThis"
          },
          {
            "type": "template",
            "key": "value",
            "value": "ThenSetToThis"
          }
        ]
      }
    ]
  },
  {
    "type": "template",
    "key": "defaultValue",
    "value": "MyDefaultValue"
  }
]

یک شی پارامتر برای یک برچسب فراخوانی تابع ، که دارای یک پارامتر نوع template و یک پارامتر نوع map است:

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]