Tags: create

GTM タグを作成します。 実習をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/tagmanager/v2/+parent/tags

パラメータ

パラメータ名 説明
パスパラメータ
parent string GTM ワークスペースの API 相対パス。 例: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

承認

このリクエストには、次のスコープによる認証が必要です。

範囲
https://www.googleapis.com/auth/tagmanager.edit.containers

詳細については、認証と認可のページをご覧ください。

リクエスト本文

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

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


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


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


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
type string GTM タグのタイプ。 書き込み可能
省略可能なプロパティ
blockingRuleId[] list ブロックルール ID。リストにあるルールのいずれかが true の場合、タグは配信されません。 書き込み可能
blockingTriggerId[] list ブロック トリガー ID。リストにあるトリガーのいずれかが true の場合、タグは配信されません。 書き込み可能
consentSettings nested object タグの同意設定。 書き込み可能
consentSettings.consentType.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
consentSettings.consentType.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
consentSettings.consentType.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
consentSettings.consentType.value string 指定された型のパラメータ値(「」などの変数参照も使用可)。 書き込み可能
firingRuleId[] list 配信ルール ID。リストにあるルールのいずれかが true で、blockingRuleIds のすべてが false の場合(指定されている場合)は、タグが配信されます。 書き込み可能
firingTriggerId[] list 配信トリガー ID。リストにあるトリガーのいずれかが true で、blockingTriggerIds のすべてが false の場合(指定されている場合)は、タグが配信されます。 書き込み可能
liveOnly boolean true に設定すると、このタグは実際の環境でのみ配信されます(プレビュー モードやデバッグモードでは配信されません)。 書き込み可能
monitoringMetadata nested object タグのモニタリング対象となるイベントデータに含めるタグメタデータの Key-Value ペアのマップ。備考:
  • このパラメータは MAP 型にする必要があります。
  • マップ内の各パラメータは TEMPLATE 型ですが、変数参照を含めることはできません。
書き込み可能
monitoringMetadata.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
monitoringMetadata.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
monitoringMetadata.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
monitoringMetadata.value string 指定された型のパラメータ値(「」などの変数参照も使用可)。 書き込み可能
monitoringMetadataTagNameKey string 空でない場合、指定されたキーを使ってタグの表示名がモニタリング メタデータ マップに含められます。 書き込み可能
notes string コンテナでこのタグを利用する方法についてのユーザーのメモ。 書き込み可能
parameter[] list タグのパラメータ。 書き込み可能
parameter[].key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
parameter[].list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
parameter[].map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
parameter[].value string 指定された型のパラメータ値(「」などの変数参照も使用可)。 書き込み可能
paused boolean タグが一時停止になっているかどうかを示します。一時停止中のタグは配信されません。 書き込み可能
priority nested object ユーザー定義のタグの優先度(数値)。タグは優先度の高い順に非同期で配信されます。優先度の数値が最も大きいタグが最初に配信されます。タグの優先度は正または負の値で指定できます。デフォルト値は 0 です。 書き込み可能
priority.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
priority.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
priority.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
priority.value string 指定された型のパラメータ値(「」などの変数参照も使用可)。 書き込み可能
scheduleEndMs long タグをスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 書き込み可能
scheduleStartMs long タグをスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 書き込み可能

レスポンス

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

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。