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

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