واجهة برمجة تطبيقات إدارة العلامات - مرجع المَعلمات

يصف هذا المستند الغرض من كائن المعلمة في أداة "إدارة العلامات من Google" وتمثيله.

مقدمة

تتيح لك واجهة برمجة تطبيقات "إدارة العلامات من Google" إنشاء موارد أداة "إدارة العلامات من Google" وإدارتها مثل العلامات والعوامل المشغِّلة والمتغيّرات.

تحتوي معظم أنواع العلامات والمتغيرات على معلَمات إضافية خاصة بالعلامة أو المتغير ويمكن ضبطها عند إنشاء أو تعديل المورد. يتم سرد قائمة المعلَمات (key، أزواج type) لكل علامة ونوع متغيّر في مرجع قاموس العلامات.

لضبط هذه المَعلمات الخاصة بالعلامة أو المتغيّر، يتم تحديد كائن مَعلمة وضبطه كقيمة للسمة parameter في مورد العلامة أو المتغيّر.

كائن المعلمة

يمثل الكائن التالي كائن معلَمة:

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

type

نوع المَعلمة للعلامة أو المتغيّر الذي يتم ضبطه.

ستحدد السمة type ما إذا كان يجب تضمين السمة value أو list أو map في كائن المعلَمة، كما هو موضّح في الجدول أدناه.

على سبيل المثال، إذا تم ضبط type على boolean، يجب تضمين السمة value في كائن المَعلمة وضبطها على true أو false.

القيمة	الخاصية الإضافية المطلوب تضمينها	الإعدادات التي يجب ضبط السمة الإضافية عليها
template	value	السمة value هي أي سلسلة، بما في ذلك المراجع المتغيّرة، مثل foo{{bar}}.
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 ومعلمة نوع map واحدة:

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