Etiket Yöneticisi API'si - Parametre Referansı

Bu belgede Etiket Yöneticisi'nin amacı ve temsili açıklanmaktadır. parametresi nesnesidir.

Giriş

Tag Manager API, Etiket Yöneticisi kaynaklarını oluşturmanıza ve yönetmenize olanak tanır. (ör. Etiketler, Kurallar ve Makrolar).

Çoğu Etiket ve Makro türünün kendine özgü ek parametreleri vardır Etiket veya Makro'ya eklenir ve kaynağı oluştururken/güncellerken ayarlanabilir. Liste her bir Etiket ve Makro için parametre (key, type çift) aşağıda listelenen türleri Etiket Sözlüğü Referans ve Makro Sözlük Referans.

Bu Etikete veya Makroya özgü parametreleri yapılandırmak için, bir parametre nesne tanımlanır ve parameter için değer olarak ayarlanır Etiketin özelliği veya Makro kaynağı.

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 Makro'nun parametre türü.

type özelliği şunları belirler: value, list veya map mülkü olup olmadığı tabloda açıklandığı gibi parametre nesnesine eklenmesi gerekir bölümüne göz atın.

Örneğin, type boolean olarak ayarlanırsa bir value özelliği, parametre nesnesine dahil edilmeli ve true veya false adlı alıcıya.

Değer	Dahil edilecek ek mülk	Ek mülk ne olarak ayarlanır?
template	value	value, makro referansları dahil herhangi bir dizedir (ör. foo{{bar}}.
boolean	value	value, true veya false olur.
number	value	value, bir tam sayıdır.
list	list	list sıfır veya daha fazla parametre içerecek, sipariş şunu içerebilir/sıralama önemli değildir. list içindeki herhangi bir parametrenin key değeri yok sayılır.
map	map	map sıfır veya daha fazla parametre içerir, sıra içermez konu; map içindeki herhangi bir parametredeki key benzersiz olması gerekir.

key

Yapılandırılan Etiket veya Makro'nun parametre anahtarı.

key alanı, belirli bir öğenin parametresini tanımlamak için kullanılır. Ayarlanan etiketler veya makrolar. Tüm parametre türleri için key gereklidir özelliği (list parametreler hariç).

Örnekler

Özel HTML Etiketi için parametre nesnesi Bu öğe, bir template türü parametresi ve iki boolean türüne sahip parametre:

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

Arama Tablosu için bir parametre nesnesi İki template türü parametre ve bir parametre içeren makro list türü parametre:

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

İşlev Çağrısı için bir parametre nesnesi Etiket (bir template türü parametresi ve bir map) type parametresi:

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