Dokumen ini menjelaskan tujuan dan representasi objek parameter Tag Manager.
Pengantar
Tag Manager API memungkinkan Anda membuat dan mengelola resource Tag Manager seperti Tag, Pemicu, dan Variabel.
Sebagian besar jenis Tag dan Variabel memiliki parameter tambahan yang dikhususkan untuk Tag atau Variabel dan dapat ditetapkan saat membuat/memperbarui resource. Daftar parameter (pasangan key
, type
) untuk setiap jenis Tag dan Variabel tercantum di Referensi Kamus Tag.
Untuk mengonfigurasi parameter khusus Tag atau Variabel ini, objek parameter ditentukan dan ditetapkan sebagai nilai untuk properti parameter
dari resource Tag atau
Variabel.
Objek parameter
Objek berikut mewakili objek parameter:
[ { "type": string, "key": string, "value": string, "list": [ (Parameter) ], "map": [ (Parameter) ] } ]
type
Jenis parameter Tag atau Variabel yang sedang dikonfigurasi.
Properti type
akan menentukan apakah properti value
, list
, atau map
perlu disertakan dalam objek parameter, seperti yang dijelaskan pada tabel di bawah.
Misalnya, jika type
ditetapkan ke boolean
, properti value
harus disertakan dalam objek parameter dan ditetapkan ke true
atau false
.
Nilai | Properti tambahan yang akan disertakan | Apa yang harus ditetapkan ke properti tambahan |
---|---|---|
template |
value |
value adalah string apa pun, termasuk referensi variabel, misalnya,
foo{{bar}} . |
boolean |
value |
value adalah true atau false .
|
number |
value |
value adalah bilangan bulat. |
list |
list |
list akan berisi nol parameter atau lebih, urutannya mungkin/mungkin
tidak penting; key dari parameter apa pun dalam list
akan diabaikan. |
map |
map |
map akan berisi nol parameter atau lebih, urutan tidak
berpengaruh; key pada parameter mana pun di map harus
unik. |
key
Kunci parameter Tag atau Variabel yang sedang dikonfigurasi.
Kolom key
digunakan untuk mengidentifikasi parameter Tag atau Variabel tertentu yang sedang ditetapkan. Semua jenis parameter memerlukan properti key
(kecuali parameter list
).
Contoh
Objek parameter untuk Tag HTML Kustom, yang memiliki satu parameter jenis template
dan dua parameter jenis boolean
:
"parameter": [ { "key": "html", "type": "template", "value": "<script>alert('hello world')</script>" }, { "key": "supportDocumentWrite", "type": "boolean", "value": "false" } ]
Objek parameter untuk Tag Panggilan Fungsi, yang memiliki satu parameter jenis template
dan satu parameter jenis map
:
"parameter": [ { "key": "functionName", "type": "template", "value": "fn" }, { "key": "functionArgument", "map": [ { "key": "argkey1", "type": "template", "value": "argval1" } ], "type": "map" } ]