Variables: update

承認が必要です

GTM 変数を更新します。 実際に試す

リクエスト

HTTP リクエスト

PUT https://www.googleapis.com/tagmanager/v2/path

パラメータ

パラメータ名 説明
パスパラメータ
path string GTM 変数の API 相対パス。 例: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id}
省略可能なクエリ パラメータ
fingerprint string 指定する場合は、ストレージ内の変数と同じフィンガープリントを使用する必要があります。

承認

このリクエストは、次のスコープでの承認が必要です(認証と承認の詳細をご確認ください)。

スコープ
https://www.googleapis.com/auth/tagmanager.edit.containers

リクエスト本文

リクエストの本文には、以下のプロパティを使用して Variables リソースを指定します。

プロパティ名 説明 メモ
必須プロパティ
formatValue.convertFalseToValue.type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)
  • trigger_reference: トリガーを表す値(トリガー ID)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
formatValue.convertNullToValue.type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)
  • trigger_reference: トリガーを表す値(トリガー ID)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
formatValue.convertTrueToValue.type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)
  • trigger_reference: トリガーを表す値(トリガー ID)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
formatValue.convertUndefinedToValue.type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)
  • trigger_reference: トリガーを表す値(トリガー ID)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
name string 変数の表示名。 書き込み可能
parameter[].type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)
  • trigger_reference: トリガーを表す値(トリガー ID)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
type string GTM 変数の型。 書き込み可能
省略可能なプロパティ
disablingTriggerId[] list モバイル コンテナのみ: 条件変数を無効にするためのトリガー ID のリスト。すべての無効化トリガーが false である一方で、有効化トリガーの 1 つが true の場合、変数は有効になります。順不同のセットとして扱われます。 書き込み可能
enablingTriggerId[] list モバイル コンテナのみ: 条件変数を有効にするためのトリガー ID のリスト。すべての無効化トリガーが false である一方で、有効化トリガーの 1 つが true の場合、変数は有効になります。順不同のセットとして扱われます。 書き込み可能
formatValue.convertFalseToValue.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
formatValue.convertFalseToValue.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
formatValue.convertFalseToValue.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
formatValue.convertFalseToValue.value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
formatValue.convertNullToValue.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
formatValue.convertNullToValue.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
formatValue.convertNullToValue.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
formatValue.convertNullToValue.value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
formatValue.convertTrueToValue.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
formatValue.convertTrueToValue.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
formatValue.convertTrueToValue.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
formatValue.convertTrueToValue.value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
formatValue.convertUndefinedToValue.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
formatValue.convertUndefinedToValue.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
formatValue.convertUndefinedToValue.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
formatValue.convertUndefinedToValue.value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
notes string コンテナでこの変数を利用する方法についてのユーザーのメモ。 書き込み可能
parameter[] list 変数のパラメータ。 書き込み可能
parameter[].key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
parameter[].list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
parameter[].map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
parameter[].value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
scheduleEndMs long 変数をスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 書き込み可能
scheduleStartMs long 変数をスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 書き込み可能

レスポンス

成功すると、このメソッドによりレスポンスの本文で Variables リソースが返されます。

演習

以下の API Explorer を使ってライブデータでこのメソッドを呼び出し、レスポンスを確認してみましょう。