Variables

如需本資源的方法清單，請見本頁結尾。

資源表示法

代表 Google 代碼管理工具變數。

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}

資源名稱	值	說明	附註
accountId	string	GTM 帳戶 ID。
containerId	string	GTM 容器 ID。
disablingTriggerId[]	list	僅適用於行動容器：用於停用條件變數的觸發條件 ID 清單；如果其中一個啟用觸發條件為 True，但所有停用觸發條件都是 False，變數就會啟用。視為未排序的集合。	可寫入
enablingTriggerId[]	list	僅適用於行動容器：用於啟用條件變數的觸發條件 ID 清單；如果其中一個啟用觸發條件為 True，但所有停用觸發條件皆為 false，變數就會啟用。視為未排序的集合。	可寫入
fingerprint	string	儲存時計算的 GTM 變數指紋。每次修改變數時，系統都會重新計算這個值。
formatValue	nested object	可選擇將變數值轉換為其他值的選項。
formatValue.caseConversionType	string	將字串類型變數值轉換為小寫或大寫的選項。 可接受的值為： "lowercase" "none" "uppercase"
formatValue.convertFalseToValue	nested object	變數值為 false 時要轉換的值。
formatValue.convertFalseToValue.isWeakReference	boolean	是否強烈參照參照類型參數。只會由轉換使用。	可寫入
formatValue.convertFalseToValue.key	string	唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。	可寫入
formatValue.convertFalseToValue.list[]	list	此清單參數的參數 (系統會忽略鍵)。	可寫入
formatValue.convertFalseToValue.map[]	list	此對應參數的參數 (必須有鍵，鍵不得重複)。	可寫入
formatValue.convertFalseToValue.type	string	參數類型。有效值如下： boolean：這個值代表布林值，以「true」或「false」表示 integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數 list：應指定參數清單 map：應指定參數對應 template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照) trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示 tag_reference：這個值代表標記，以標記名稱表示 可接受的值為： "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	可寫入
formatValue.convertFalseToValue.value	string	適合指定類型的參數值 (可能包含「」等變數參照。	可寫入
formatValue.convertNullToValue	nested object	變數值為空值時要轉換的值。
formatValue.convertNullToValue.isWeakReference	boolean	是否強烈參照參照類型參數。只會由轉換使用。	可寫入
formatValue.convertNullToValue.key	string	唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。	可寫入
formatValue.convertNullToValue.list[]	list	此清單參數的參數 (系統會忽略鍵)。	可寫入
formatValue.convertNullToValue.map[]	list	此對應參數的參數 (必須有鍵，鍵不得重複)。	可寫入
formatValue.convertNullToValue.type	string	參數類型。有效值如下： boolean：這個值代表布林值，以「true」或「false」表示 integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數 list：應指定參數清單 map：應指定參數對應 template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照) trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示 tag_reference：這個值代表標記，以標記名稱表示 可接受的值為： "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	可寫入
formatValue.convertNullToValue.value	string	適合指定類型的參數值 (可能包含「」等變數參照。	可寫入
formatValue.convertTrueToValue	nested object	變數值是 true 時要轉換的值。
formatValue.convertTrueToValue.isWeakReference	boolean	是否強烈參照參照類型參數。只會由轉換使用。	可寫入
formatValue.convertTrueToValue.key	string	唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。	可寫入
formatValue.convertTrueToValue.list[]	list	此清單參數的參數 (系統會忽略鍵)。	可寫入
formatValue.convertTrueToValue.map[]	list	此對應參數的參數 (必須有鍵，鍵不得重複)。	可寫入
formatValue.convertTrueToValue.type	string	參數類型。有效值如下： boolean：這個值代表布林值，以「true」或「false」表示 integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數 list：應指定參數清單 map：應指定參數對應 template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照) trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示 tag_reference：這個值代表標記，以標記名稱表示 可接受的值為： "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	可寫入
formatValue.convertTrueToValue.value	string	適合指定類型的參數值 (可能包含「」等變數參照。	可寫入
formatValue.convertUndefinedToValue	nested object	未定義變數值時要轉換的值。
formatValue.convertUndefinedToValue.isWeakReference	boolean	是否強烈參照參照類型參數。只會由轉換使用。	可寫入
formatValue.convertUndefinedToValue.key	string	唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。	可寫入
formatValue.convertUndefinedToValue.list[]	list	此清單參數的參數 (系統會忽略鍵)。	可寫入
formatValue.convertUndefinedToValue.map[]	list	此對應參數的參數 (必須有鍵，鍵不得重複)。	可寫入
formatValue.convertUndefinedToValue.type	string	參數類型。有效值如下： boolean：這個值代表布林值，以「true」或「false」表示 integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數 list：應指定參數清單 map：應指定參數對應 template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照) trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示 tag_reference：這個值代表標記，以標記名稱表示 可接受的值為： "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	可寫入
formatValue.convertUndefinedToValue.value	string	適合指定類型的參數值 (可能包含「」等變數參照。	可寫入
name	string	變數顯示名稱。	可寫入
notes	string	使用者說明如何在容器中套用這個變數。	可寫入
parameter[]	list	變數的參數。	可寫入
parameter[].isWeakReference	boolean	是否強烈參照參照類型參數。只會由轉換使用。	可寫入
parameter[].key	string	唯一識別參數的已命名鍵。必須用於頂層參數和對應值。清單值會忽略。	可寫入
parameter[].list[]	list	此清單參數的參數 (系統會忽略鍵)。	可寫入
parameter[].map[]	list	此對應參數的參數 (必須有鍵，鍵不得重複)。	可寫入
parameter[].type	string	參數類型。有效值如下： boolean：這個值代表布林值，以「true」或「false」表示 integer：這個值代表 64 位元的帶正負號整數值，以 10 為底數 list：應指定參數清單 map：應指定參數對應 template：此值代表任何文字，可能包含變數參照 (甚至是可能會傳回非字串類型的變數參照) trigger_reference：這個值代表觸發條件，以觸發條件 ID 表示 tag_reference：這個值代表標記，以標記名稱表示 可接受的值為： "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	可寫入
parameter[].value	string	適合指定類型的參數值 (可能包含「」等變數參照。	可寫入
parentFolderId	string	上層資料夾 ID。
path	string	GTM Variable 的 API 相對路徑。
scheduleEndMs	long	安排變數的結束時間戳記 (以毫秒為單位)。	可寫入
scheduleStartMs	long	安排變數的開始時間戳記 (以毫秒為單位)。	可寫入
tagManagerUrl	string	自動產生的代碼管理工具使用者介面連結
type	string	GTM 變數類型。	可寫入
variableId	string	變數 ID 是用來識別 Google 代碼管理工具變數的唯一識別碼。
workspaceId	string	GTM 工作區 ID。

方法

建立

建立 GTM 變數。

刪除

刪除 GTM 變數。

取得

取得 GTM 變數。

list

列出容器的所有 GTM 變數。

revert

在 GTM 工作區中還原對 GTM 變數所做的變更。

更新

更新 GTM 變數。