Google の新しいタグ プラットフォームに関するドキュメントをご覧いただきありがとうございます。このサイトは公開ベータ版です。(フィードバック

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)
      ]
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  }
}
プロパティ名 説明 備考
accountId string GTM アカウント ID。
containerId string GTM コンテナ ID。
disablingTriggerId[] list モバイル コンテナのみ: 条件変数を有効にするためのトリガー ID のリスト。すべての無効化トリガーが false である一方で、有効化トリガーの 1 つが true の場合、変数は有効になります。順不同のセットとして扱われます。 書き込み可能
enablingTriggerId[] list モバイル コンテナのみ: 条件変数を有効にするためのトリガー ID のリスト。すべての無効化トリガーが false である一方で、有効化トリガーの 1 つが true の場合、変数は有効になります。順不同のセットとして扱われます。 書き込み可能
fingerprint string 保存時に計算された GTM 変数のフィンガープリント。この値は、変数が変更されるたびに再計算されます。
formatValue nested object 変数値を他の値に変換するオプション。
formatValue.caseConversionType string 文字列型の変数値を小文字または大文字に変換するオプション。

有効な値は次のとおりです。
  • lowercase
  • none
  • uppercase
formatValue.convertFalseToValue nested object 変数値が false の場合に変換する値。
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 変数値が null の場合に変換する値。
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.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.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[].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 変数の API 相対パス。
scheduleEndMs long 変数をスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 書き込み可能
scheduleStartMs long 変数をスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 書き込み可能
tagManagerUrl string タグ マネージャー管理画面への自動生成リンク。
type string GTM 変数の型。 書き込み可能
variableId string GTM 変数を一意に識別する変数 ID。
workspaceId string GTM ワークスペース ID。

Methods

create
GTM 変数を作成します。
delete
GTM 変数を削除します。
get
GTM 変数を取得します。
list
コンテナのすべての GTM 変数を一覧表示します。
revert
GTM ワークスペースの GTM 変数に加えた変更を元に戻します。
update
GTM 変数を更新します。