Tag Manager API - 參數參考資料

本文件將說明代碼管理工具的用途和說明 參數值。

簡介

代碼管理工具 API 可用來建立及管理代碼管理工具資源 ，例如代碼、觸發條件和變數。

大多數的代碼和變數類型都有專屬的額外參數 加入「標記」或「變數」中，且可在建立/更新資源時設定。清單 每個代碼和變數的參數 (key、type 組合) 類型會列於 代碼字典 參考資料。

如要設定這些代碼或變數專屬參數，請參數 object 會定義成 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 會包含 0 個或多個參數，順序為/可能會 無關緊要list 中任何參數的 key 系統就會忽略。
map map map 將包含 0 個或多個參數，順序則沒有 至關重要；map 中任何參數的 key 都應 不得重複

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 類型參數和一個 map 類型參數：

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