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

يوضِّح هذا المستند الغرض من أداة "إدارة العلامات من 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"
  }
]