Rules

コンテナのルールです。ルールは、ランタイムに true または false に評価されます。ルールを使えば、タグを配信するタイミングや配信をブロックするタイミングのほか、モバイル コンテナ内のマクロを有効または無効にするタイミングを制御できます。詳しくは、タグの設定の配信ルールと無効化ルール、マクロ設定の有効化ルールと無効化ルールをそれぞれご覧ください。

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

リソースの表記

Google タグ マネージャーのルールの表現は以下のとおりです。

{
  "accountId": string,
  "containerId": string,
  "ruleId": string,
  "name": string,
  "notes": string,
  "condition": [
    {
      "type": string,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ]
        }
      ]
    }
  ],
  "fingerprint": string
}
プロパティ名 説明 メモ
accountId string GTM アカウント ID。
condition[] list このルールを構成する条件のリスト(条件は暗黙的に「AND」で連結)。 書き込み可能
condition[].parameter[] list 条件の種類に応じた名前付きパラメータ(Key-Value)のリスト。備考:
  • 二項演算子の場合は、arg0 および arg1 というパラメータで、左と右のオペランドをそれぞれ指定します。
  • このとき、左側のオペランド(arg0)はマクロへの参照でなければなりません。
  • 正規表現のマッチングで大文字と小文字を区別しない場合は、ignore_case というブール型パラメータを true に設定します。このパラメータが設定されていない場合や、他の値が設定されている場合は、大文字と小文字が区別されます。
  • 演算子を無効にするには、negate という名前のブール値パラメータを追加し、true に設定します。
書き込み可能
condition[].parameter[].key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
condition[].parameter[].list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
condition[].parameter[].map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
condition[].parameter[].type string パラメータの型。有効な値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキストを表します。マクロ参照も含めることができます(文字列以外の型を返すマクロ参照も含みます)。


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
書き込み可能
condition[].parameter[].value string 指定された型のパラメータ値(「」などマクロの参照も使用できます)。 書き込み可能
condition[].type string この条件の演算子。

有効な値は次のとおりです。
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
書き込み可能
containerId string GTM コンテナ ID。
fingerprint string 保存時に計算された GTM ルールのフィンガープリント。この値は、ルールが変更されるたびに再計算されます。
name string ルールの表示名。 書き込み可能
notes string コンテナでこのルールを利用する方法についてのユーザーのメモ。 書き込み可能
ruleId string GTM ルールを一意に識別するルール ID。

Methods

ルールを作成、変更、削除、取得するには、以下の方法を使用します。

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