Tags

コンテナに関連付けられたタグです。タグは通常、1 つ以上の配信ルール(下記の firingRuleId を参照)と、オプションの 1 つ以上のブロックルール(下記の blockingRuleId 参照)に関連付けられます。true の配信ルールが 1 つ以上あり、true のブロックルールが 1 つもない場合に、タグが配信(実行)されます。オプションの priority プロパティを使用すると、他のタグより先に配信するタグを設定できます。dependencies プロパティを使用すると、そのタグの配信前に配信して完了させる必要がある他のタグを指定できます。Google タグ マネージャーのタグに設定できるパラメータの詳細については、タグ辞書リファレンスをご覧ください。

このリソースのメソッドの一覧については、このページの最後をご覧ください。

リソースの表記

Google タグ マネージャーのタグを表します。

{
  "accountId": string,
  "containerId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "fingerprint": string,
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "paused": boolean
}
プロパティ名 説明 備考
accountId string GTM アカウント ID。
blockingRuleId[] list ブロックルール ID。リストにあるルールのいずれかが true の場合、タグは配信されません。 書き込み可能
blockingTriggerId[] list ブロック トリガー ID。リストにあるトリガーのいずれかが true の場合、タグは配信されません。 書き込み可能
containerId string GTM コンテナ ID。
fingerprint string 保存時に計算された GTM タグのフィンガープリント。この値は、タグが変更されるたびに再計算されます。
firingRuleId[] list 配信ルール ID。リストにあるルールのいずれかが true で、blockingRuleIds のすべてが false の場合(指定されている場合)は、タグが配信されます。 書き込み可能
firingTriggerId[] list 配信トリガー ID。リストにあるトリガーのいずれかが true で、blockingTriggerIds のすべてが false の場合(指定されている場合)は、タグが配信されます。 書き込み可能
liveOnly boolean true に設定すると、このタグは実際の環境でのみ配信されます(プレビュー モードやデバッグモードでは配信されません)。 書き込み可能
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: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
書き込み可能
parameter[].value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
parentFolderId string 親フォルダ ID。
paused boolean タグが一時停止になっている場合は true です。 書き込み可能
priority nested object ユーザー定義のタグの優先度(数値)。タグは優先度の高い順に非同期で配信されます。優先度の数値が最も大きいタグが最初に配信されます。タグの優先度は正または負の値で指定できます。デフォルト値は 0 です。 書き込み可能
priority.key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
priority.list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
priority.map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
priority.type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
書き込み可能
priority.value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
scheduleEndMs long タグをスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 書き込み可能
scheduleStartMs long タグをスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 書き込み可能
setupTag[] list 設定タグのリスト。現在は 1 つのみ許可されます。
setupTag[].stopOnSetupFailure boolean true の場合は、設定タグが正常に配信された場合に限りメインのタグが配信されます。false の場合は、設定タグの配信状況に関係なくメインのタグが配信されます。
setupTag[].tagName string 設定タグの名前。
tagFiringOption string このタグの配信オプションです。

有効な値は次のとおりです。
  • "oncePerEvent"
  • "oncePerLoad"
  • "unlimited"
tagId string GTM タグを一意に識別するタグ ID。
teardownTag[] list ティアダウン タグのリスト。現在は 1 つのみ許可されます。
teardownTag[].stopTeardownOnFailure boolean true の場合は、メインのタグが正常に配信された場合に限りティアダウン タグが配信されます。false の場合は、メインのタグの配信状況に関係なくティアダウン タグが配信されます。
teardownTag[].tagName string ティアダウン タグの名前。
type string GTM タグのタイプ。 書き込み可能

メソッド

タグを作成、変更、削除、または取得するためのメソッドは以下のとおりです。

create
GTM タグを作成します。
delete
GTM タグを削除します。
get
GTM タグを取得します。
list
コンテナのすべての GTM タグを一覧表示します。
update
GTM タグを更新します。