認証が必要です
リクエスト
HTTP リクエスト
PUT https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/triggers/triggerId
パラメータ
| パラメータ名 | 値 | 説明 |
|---|---|---|
| パスパラメータ | ||
accountId |
string |
GTM アカウント ID。 |
containerId |
string |
GTM コンテナ ID。 |
triggerId |
string |
GTM トリガー ID。 |
| 省略可能なクエリ パラメータ | ||
fingerprint |
string |
指定する場合は、ストレージ内のトリガーと同じフィンガープリントを使用する必要があります。 |
承認
このリクエストは、次のスコープでの承認が必要です（認証と承認の詳細をご確認ください）。
| スコープ |
|---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
リクエスト本文
リクエストの本文には、以下のプロパティを使用して Triggers リソースを指定します。
| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
| 必須プロパティ | |||
autoEventFilter[].parameter[] |
list |
条件の種類に応じた名前付きパラメータ（Key-Value）のリスト。備考:
|
書き込み可能 |
autoEventFilter[].parameter[].type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
autoEventFilter[].type |
string |
この条件の演算子。
有効な値は次のとおりです。
|
書き込み可能 |
checkValidation.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
continuousTimeMinMilliseconds.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
customEventFilter[].parameter[] |
list |
条件の種類に応じた名前付きパラメータ（Key-Value）のリスト。備考:
|
書き込み可能 |
customEventFilter[].parameter[].type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
customEventFilter[].type |
string |
この条件の演算子。
有効な値は次のとおりです。
|
書き込み可能 |
eventName.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
filter[].parameter[] |
list |
条件の種類に応じた名前付きパラメータ（Key-Value）のリスト。備考:
|
書き込み可能 |
filter[].parameter[].type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
filter[].type |
string |
この条件の演算子。
有効な値は次のとおりです。
|
書き込み可能 |
horizontalScrollPercentageList.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
interval.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
intervalSeconds.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
limit.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
maxTimerLengthSeconds.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
name |
string |
トリガーの表示名。 | 書き込み可能 |
parameter[].type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
selector.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
totalTimeMinMilliseconds.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
uniqueTriggerId.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
verticalScrollPercentageList.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
visibilitySelector.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
visiblePercentageMax.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
visiblePercentageMin.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
waitForTags.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
waitForTagsTimeout.type |
string |
パラメータの型。有効な値は次のとおりです。
有効な値は次のとおりです。
|
書き込み可能 |
| 省略可能なプロパティ | |||
autoEventFilter[] |
list |
自動イベント トラッキングで使用します。 | 書き込み可能 |
autoEventFilter[].parameter[].key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
autoEventFilter[].parameter[].list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
autoEventFilter[].parameter[].map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
autoEventFilter[].parameter[].value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
checkValidation |
nested object |
フォームの送信やリンクのクリックといったイベントにおいて、（検証の結果などにより）他のイベント ハンドラによってキャンセルされない場合に限ってタグが配信されるようにするかどうかを決めます。フォーム送信トリガーとリンククリック トリガーでのみ有効です。 | 書き込み可能 |
checkValidation.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
checkValidation.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
checkValidation.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
checkValidation.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
continuousTimeMinMilliseconds |
nested object |
表示トリガーの最小の視認可能持続時間（ミリ秒単位）。AMP 表示トリガーでのみ有効です。 | 書き込み可能 |
continuousTimeMinMilliseconds.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
continuousTimeMinMilliseconds.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
continuousTimeMinMilliseconds.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
continuousTimeMinMilliseconds.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
customEventFilter[] |
list |
カスタム イベントで使用。すべての条件が true の場合にイベントが発生します。 | 書き込み可能 |
customEventFilter[].parameter[].key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
customEventFilter[].parameter[].list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
customEventFilter[].parameter[].map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
customEventFilter[].parameter[].value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
eventName |
nested object |
発生する GTM イベントの名前。タイマー トリガーでのみ有効です。 | 書き込み可能 |
eventName.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
eventName.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
eventName.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
eventName.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
filter[] |
list |
すべての条件が true の場合のみ、トリガーが発動します。 | 書き込み可能 |
filter[].parameter[].key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
filter[].parameter[].list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
filter[].parameter[].map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
filter[].parameter[].value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
horizontalScrollPercentageList |
nested object |
スクロール トリガーの割合（整数値）のリスト。水平方向のスクロールで、各割合に達したときにトリガーが発動します。AMP スクロール トリガーでのみ有効です。 | 書き込み可能 |
horizontalScrollPercentageList.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
horizontalScrollPercentageList.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
horizontalScrollPercentageList.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
horizontalScrollPercentageList.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
interval |
nested object |
反復的なタイマー イベントの発生間隔（ミリ秒単位）。タイマー トリガーでのみ有効です。 | 書き込み可能 |
interval.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
interval.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
interval.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
interval.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
intervalSeconds |
nested object |
タイマー イベントの発生間隔（秒単位）。AMP タイマー トリガーでのみ有効です。 | 書き込み可能 |
intervalSeconds.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
intervalSeconds.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
intervalSeconds.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
intervalSeconds.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
limit |
nested object |
このタイマー トリガーによって発生する GTM イベントの数の制限。制限が設定されていない場合は、ユーザーがページを離れるまで GTM イベントが発生します。タイマー トリガーでのみ有効です。 | 書き込み可能 |
limit.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
limit.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
limit.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
limit.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
maxTimerLengthSeconds |
nested object |
タイマー イベントが発生する最大時間（秒単位）。AMP タイマー トリガーでのみ有効です。 | 書き込み可能 |
maxTimerLengthSeconds.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
maxTimerLengthSeconds.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
maxTimerLengthSeconds.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
maxTimerLengthSeconds.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
parameter[].key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
parameter[].list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
parameter[].map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
parameter[].value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
selector |
nested object |
クリック トリガーの CSS セレクタ（<A> タグや <BUTTON> タグなど）。AMP クリック トリガーでのみ有効です。 | 書き込み可能 |
selector.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
selector.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
selector.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
selector.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
totalTimeMinMilliseconds |
nested object |
表示トリガーの最小の合計視認可能時間（ミリ秒単位）。AMP 表示トリガーでのみ有効です。 | 書き込み可能 |
totalTimeMinMilliseconds.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
totalTimeMinMilliseconds.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
totalTimeMinMilliseconds.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
totalTimeMinMilliseconds.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
type |
string |
このトリガーを発動させるデータレイヤー イベントを定義します。
有効な値は次のとおりです。
|
書き込み可能 |
uniqueTriggerId |
nested object |
フォーム送信リスナー、リンククリック リスナー、またはタイマー リスナーを自動生成するトリガーのグローバルに一意の ID。互換性のない自動イベントとトリガー ID に基づくトリガー フィルタリングの連携を図るために使用します。この値は出力の生成時に設定されます（トリガーの暗示するタグがそれまで存在しないため）。フォーム送信、リンククリック、およびタイマーのトリガーでのみ有効です。 | 書き込み可能 |
uniqueTriggerId.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
uniqueTriggerId.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
uniqueTriggerId.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
uniqueTriggerId.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
verticalScrollPercentageList |
nested object |
スクロール トリガーの割合（整数値）のリスト。垂直方向のスクロールで、各割合に達したときにトリガーが発動します。AMP スクロール トリガーでのみ有効です。 | 書き込み可能 |
verticalScrollPercentageList.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
verticalScrollPercentageList.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
verticalScrollPercentageList.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
verticalScrollPercentageList.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
visibilitySelector |
nested object |
表示トリガーの CSS セレクタ（「#id」）。AMP 表示トリガーでのみ有効です。 | 書き込み可能 |
visibilitySelector.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
visibilitySelector.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
visibilitySelector.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
visibilitySelector.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
visiblePercentageMax |
nested object |
表示トリガーの視認の最大割合。AMP 表示トリガーでのみ有効です。 | 書き込み可能 |
visiblePercentageMax.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
visiblePercentageMax.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
visiblePercentageMax.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
visiblePercentageMax.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
visiblePercentageMin |
nested object |
表示トリガーの視認の最小割合。AMP 表示トリガーでのみ有効です。 | 書き込み可能 |
visiblePercentageMin.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
visiblePercentageMin.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
visiblePercentageMin.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
visiblePercentageMin.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
waitForTags |
nested object |
（デフォルトのアクションのタイミングをずらして）すべてのタグが配信されるまでフォームの送信やリンク先の表示を遅らせるかどうかを決めます。フォーム送信トリガーとリンククリック トリガーでのみ有効です。 | 書き込み可能 |
waitForTags.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
waitForTags.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
waitForTags.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
waitForTags.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
waitForTagsTimeout |
nested object |
上記の「waits_for_tags」が true の場合に、タグが配信されるまで待機する時間（ミリ秒単位）。フォーム送信トリガーとリンククリック トリガーでのみ有効です。 |
書き込み可能 |
waitForTagsTimeout.key |
string |
パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 | 書き込み可能 |
waitForTagsTimeout.list[] |
list |
このリスト パラメータのパラメータ（キーは無視されます）。 | 書き込み可能 |
waitForTagsTimeout.map[] |
list |
このマップ パラメータのパラメータ（一意のキーが必要）。 | 書き込み可能 |
waitForTagsTimeout.value |
string |
指定された型のパラメータ値（「」などの変数参照も使用可）。 | 書き込み可能 |
レスポンス
成功すると、このメソッドによりレスポンスの本文で Triggers リソースが返されます。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません（サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください）。
Java
Java クライアント ライブラリを使用します。
/*
* Note: This code assumes you have an authorized tagmanager service object.
*/
/*
* This request updates an existing trigger for the authorized user.
*/
// Create the condition parameters objects.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("arg0");
arg0.setValue("{{Page URL}}");
Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("arg1");
arg1.setValue("timed.html");
// Create the auto event condition object.
Condition condition = new Condition();
condition.setType("contains");
condition.setParameter(Arrays.asList(arg0, arg1));
// Create the event parameter.
Parameter eventName = new Parameter();
eventName.setType("template");
eventName.setValue("gtm.timer");
// Create the interval parameter.
Parameter interval = new Parameter();
interval.setType("template");
interval.setValue("10000");
// Create the limit parameter.
Parameter limit = new Parameter();
limit.setType("template");
limit.setValue("10");
// Create the trigger object.
Trigger trigger = new Trigger();
trigger.setName("Updated Timer Trigger");
trigger.setType("timer");
trigger.setAutoEventFilter(Arrays.asList(condition));
trigger.setEventName(eventName);
trigger.setInterval(interval);
trigger.setLimit(limit);
try {
Trigger response = tagmanager.accounts().containers().
triggers().update("123456", "54321", "1", trigger).execute();
} catch (GoogleJsonResponseException e) {
System.err.println("There was a service error: "
+ e.getDetails().getCode() + " : "
+ e.getDetails().getMessage());
}
/*
* The results of the update method are stored in the response object.
* The following code shows how to access the updated name and fingerprint.
*/
System.out.println("Updated Name = " + response.getName());
System.out.println("Updated Fingerprint = " + response.getFingerprint());
Python
Python クライアント ライブラリを使用します。
# Note: This code assumes you have an authorized tagmanager service object.
# This request updates an existing trigger.
try:
response = tagmanager.accounts().containers().triggers().update(
accountId='123456',
containerId='54321',
triggerId='3',
body={
'name': 'Updated Timed trigger',
'type': 'timer',
'autoEventFilter': [
{
'type': 'contains',
'parameter': [
{
'type': 'template',
'key': 'arg0',
'value': '{{Page URL}}'
},
{
'type': 'template',
'key': 'arg1',
'value': 'timed.html'
}
]
}
],
'eventName': {
'type': 'template',
'value': 'gtm.timer'
},
'interval': {
'type': 'template',
'value': '10000'
},
'limit': {
'type': 'template',
'value': '10'
}
}
).execute()
except TypeError, error:
# Handle errors in constructing a query.
print 'There was an error in constructing your query : %s' % error
except HttpError, error:
# Handle API errors.
print ('There was an API error : %s : %s' %
(error.resp.status, error.resp.reason))
# The results of the update method are stored in the response object.
# The following code shows how to access the updated name and fingerprint.
print 'Updated Name = %s' % response.get('name')
print 'Updated Fingerprint = %s' % response.get('fingerprint')
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。