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 變數值是「否」時要轉換的值。
formatValue.convertFalseToValue.isWeakReference boolean 某個參照類型參數是否為嚴格參照或弱式參照。只會用於轉換。 可寫入
formatValue.convertFalseToValue.key string 專門用於識別參數的具名鍵。頂層參數和對應值的必要項目。系統會忽略清單值。 可寫入
formatValue.convertFalseToValue.list[] list 這份清單參數的參數 (金鑰會忽略)。 可寫入
formatValue.convertFalseToValue.map[] list 此對應參數的參數 (必須具有鍵；索引鍵不得重複)。 可寫入
formatValue.convertFalseToValue.type string 參數類型。有效的值包括：
  • boolean：值代表布林值，以「true」表示或「false」
  • integer：值代表以 10 為底的 64 位元帶正負號整數值
  • 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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：值代表以 10 為底的 64 位元帶正負號整數值
  • 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 變數的 API 相對路徑。
scheduleEndMs long 結束變數的結束時間戳記 (以毫秒為單位)。 可寫入
scheduleStartMs long 排定變數的開始時間戳記 (以毫秒為單位)。 可寫入
tagManagerUrl string 自動產生的代碼管理工具使用者介面連結
type string GTM 變數類型。 可寫入
variableId string 變數 ID 是用來識別 GTM 變數的專屬 ID。
workspaceId string GTM 工作區 ID。

方法

建立
建立 GTM 變數。
刪除
刪除 GTM 變數。
取得
取得 GTM 變數。
list
列出容器的所有 GTM 變數。
復原
在 GTM 工作區中將變更還原為 GTM 變數。
更新
更新 GTM 變數。