Tag Manager API - Referensi Parameter

Dokumen ini menjelaskan tujuan dan representasi 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 spesifik pada Tag atau Variabel dan dapat ditetapkan saat membuat/memperbarui resource. Daftar parameter (pasangan key, type) untuk setiap Tag dan Variabel tercantum dalam Kamus Tag Referensi.

Untuk mengonfigurasi parameter khusus Tag atau Variabel ini, parameter objek ditentukan dan ditetapkan sebagai nilai untuk parameter properti Tag atau Resource 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 dalam tabel di bawah ini.

Misalnya, jika type ditetapkan ke boolean, maka Properti value harus disertakan dalam objek parameter dan disetel ke true atau false.

Nilai Properti tambahan yang akan disertakan Apa yang harus ditetapkan untuk 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, pesanan mungkin/mungkin tidak masalah; key dari parameter apa pun dalam list akan diabaikan.
map map map akan berisi nol atau beberapa parameter, urutan tidak masalah; key pada parameter apa pun di map harus harus unik.

key

Kunci parameter Tag atau Variabel yang sedang dikonfigurasi.

Kolom key digunakan untuk mengidentifikasi parameter Tag atau Variabel yang sedang ditetapkan. Semua jenis parameter memerlukan key (kecuali parameter list).

Contoh

Objek parameter untuk Tag HTML Kustom, yang memiliki satu parameter jenis template dan dua jenis boolean parameter:

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

Objek parameter untuk Panggilan Fungsi Tag, yang memiliki satu parameter jenis template dan satu map parameter jenis:

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