Etiket Yöneticisi API'si - Parametre Referansı

Bu belgede, Etiket Yöneticisi parametre nesnesinin amacı ve temsili açıklanmaktadır.

Giriş

Etiket Yöneticisi API'si Etiketler, Kurallar ve Makrolar gibi Etiket Yöneticisi kaynaklarını oluşturup yönetmenize olanak tanır.

Çoğu Etiket ve Makro türü, Etiket veya Makro'ya özel ek parametreler içerir ve kaynağı oluştururken/güncellerken ayarlanabilir. Her bir Etiket ve Makro türü için parametre listesi (key, type çift) Etiket Sözlüğü Referansı'nda ve Makro Sözlük Referansı'nda listelenmiştir.

Bu Etiket veya Makroya özgü parametreleri yapılandırmak için bir parametre nesnesi tanımlanır ve Etiket veya Makro kaynağının parameter özelliğinin değeri olarak ayarlanır.

Parametre nesnesi

Aşağıdaki nesne bir parametre nesnesini temsil eder:

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

type

Yapılandırılan Etiket veya Makronun parametre türü.

type özelliği, aşağıdaki tabloda açıklandığı gibi bir value, list veya map özelliğinin parametre nesnesine dahil edilmesi gerekip gerekmediğini belirler.

Örneğin, type, boolean olarak ayarlanırsa parametre nesnesine bir value özelliği eklenmeli ve true veya false olarak ayarlanmalıdır.

Değer	Dahil edilecek ek özellik	Ek mülkün nasıl ayarlanacağı
template	value	value, makro referansları dahil herhangi bir dizedir (ör. foo{{bar}}).
boolean	value	value, true veya false değerine sahip.
number	value	value bir tam sayıdır.
list	list	list sıfır veya daha fazla parametre içerecek, sıra önemli olabilir veya olmayabilir; list içindeki herhangi bir parametrenin key yoksayılır.
map	map	map sıfır veya daha fazla parametre içerecek, sıra önemli değildir; map içindeki herhangi bir parametredeki key benzersiz olmalıdır.

key

Yapılandırılan Etiketin veya Makronun parametre anahtarı.

key alanı, ayarlanan belirli Etiketlerin veya Makroların parametresini tanımlamak için kullanılır. Tüm parametre türlerinde bir key özelliği gerekir (list parametreleri hariç).

Örnekler

Bir template türü parametresi ve iki boolean türü parametreye sahip olan Özel HTML Etiketi için bir parametre nesnesi:

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

İki template tür parametresi ve bir list türü parametresi olan Arama Tablosu Makrosu için bir parametre nesnesi:

"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"
  }
]

Bir template türü parametresi ve bir map türü parametresi olan İşlev Çağrısı Etiketi için bir parametre nesnesi:

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