オーディエンスルール

オーディエンスルールは、特定の人をカスタムオーディエンスに追加するかどうかを決めるためのものです。それらのルールは、参照URLか、特定のイベントとデータに適用されます。

ルールは、次のようなJSONエンコード文字列として指定します。

オーディエンスルールは、ウェブサイトカスタムオーディエンスモバイルアプリカスタムオーディエンスオフラインカスタムオーディエンスといった、さまざまなタイプのカスタムオーディエンスに使われます。エンゲージメントオーディエンスルールについては、エンゲージメントカスタムオーディエンスをご覧ください。

制限

  • オーディエンスのオーディエンスルールごとに、ルールを最大10個まで指定できます。inclusionsexclusionsrulesの数もこれに含められます。
  • ルールごとに、フィルター(リーフノードと呼ばれる)を最大100個まで指定できます。

オーディエンスルールの構文

オーディエンスルールは、次の構文に従って定義します。

rule: {
   "inclusions": <RULE_SET>,
   "exclusions": <RULE_SET>,
}

利用可能なフィールド

名前 説明

inclusions

型: 文字列

必須。

包含条件を定義するルールセットJSON文字列。ルールセットの構文を参照。

exclusions

型: 文字列

必須。

除外条件を定義するルールセットJSON文字列。ルールセットの構文を参照。

ルールセットの構文

各ルールセットは、次の構造に従います。

{
  "operator" : <BOOLEAN_OPERATOR>,
  "rules" : <JSON_RULE>,
}

利用可能なフィールド

名前 説明

operator

型: 文字列

必須。

andまたはor

rules

型: 文字列

必須。

ルールのJSON文字列(ルールの配列)。包含ルールと除外のルールの構文を参照。

包含ルールと除外ルールの構文

包含ルールと除外ルールは、それぞれは以下の構造に従います。

{
  "event_sources" : <EVENT_SOURCE_DEFINITION>, 
  "retention_seconds" : <SECONDS>,
  "filter" : <FILTER>,
  "aggregation" : <AGGREGATION>, 
}

aggregationretention_secondsが編集可能なフィールドです。ただし、aggregationretention_secondsを編集してもオーディエンスはフラッシュされません。つまり、古いルールや集計のみに一致した利用者は、有効期限が切れるまで引き続きオーディエンスと見なされます。

利用可能なフィールド

名前 説明

event_sources

型: 文字列

必須。

idtypeを含むJSONオブジェクト。


コンマ区切りリスト"store_visits,pixel,app"を使うと、さらに多くのイベントソースをtypeに追加できます。

retention_seconds

型: 整数

必須。

オーディエンスのリテンション期間を指定する整数(秒単位)。retention_days未満でなければなりません。最小値=1;最大値=365日

filter

型: 文字列

必須。

フィルタールールのJSON文字列。フィルターを参照。

aggregation

型: 整数

任意。

集計関数のJSON文字列。集計関数を参照。

フィルター

フィルターの基本形式は次のとおりです。

"filter" : {
  "operator": <BOOLEAN_OPERATOR>,
  "filters": <FILTER_SET>,
  }

利用可能なフィールド

名前 説明

operator

型: 文字列

必須。

andまたはor

filters

型: 文字列

必須。

フィルタールールのJSONオブジェクトの配列。フィルタールールの構文を参照。

フィルターセットの構文

{
    "field": <FIELD>,
    "operator": <COMPARISON_OPERATOR>,
    "value": <VALUE>,
}

利用可能なフィールド

名前 説明

field

型: 文字列

必須。


  • ウェブサイトカスタムオーディエンスの場合、フィルターでイベントを指定するのであれば'event'を使います。ピクセルによって送信されたイベントに一致するパラメーター(例: 'ViewContent''Purchase')。
  • モバイルアプリカスタムオーディエンスの場合、フィルターでイベントを指定するのであれば'event'を使います。アプリによって送信されたアプリイベントに一致するパラメーター(例: "_appVersion"、"_value"など)。

operator

型: 文字列

必須。

  • =
  • !=
  • >=
  • >
  • <=
  • <
  • i_contains
  • i_not_contains
  • contains
  • not_contains
  • is_any
  • is_not_any
  • i_is_any
  • i_is_not_any
  • i_starts_with
  • starts_with
  • "regex_match"[INFO]

fieldeventに設定されている場合は、=を使う必要があります。

value

型: 文字列

必須。

field属性を"event"に設定する場合は、valueをイベント名に設定する必要があります。アプリから報告されたアプリイベントとパラメーターを参照するには、アプリイベントAPIを使います。

集計関数

行動の頻度や強度に基づいてカスタムオーディエンスを作成するには、オーディエンスルールフィールドでaggregationを使います。その上で、次の例のようにして集計関数を定義します。

"aggregation" : {
  "type":"count",
  "operator":">",
  "value":1
}

利用可能なフィールド

名前 説明

type

型: 文字列

必須。

集計関数のタイプ。

  • ウェブサイトカスタムオーディエンスで利用可能な関数は、'count''sum''avg''min''max''time_spent''last_event_time_field'です。
  • モバイルアプリカスタムオーディエンスで利用可能な関数は、"count""sum""avg""min""max"です。

config

特定のタイプの集計関数で必須。

method

型: 文字列

任意。

"absolute" (特定の範囲内でイベントを記録した利用者を追加する)または"percentile"(特定のパーセンタイルの範囲から利用者を追加する)。percentileを選択する場合、演算子はin_rangenot_in_rangeだけでなければなりません。

field

型: 文字列

必須。typeがcountの場合を除く。

集計関数が適用されるパラメーター。

operator

型: 文字列

必須。

=!=>=><=<in_rangenot_in_range

value

型: 文字列

必須。

パラメーターに指定可能な値。

例:

"aggregation" : {
  "type":"count",
  "operator":">",
  "value":1
}

比較演算子

演算子 説明

>またはgt

イベントのパラメーター値が指定値より大きい場合、true。

>=またはgte

イベントのパラメーター値が指定値以上の場合、true。

<またはlt

イベントのパラメーター値が指定値より小さい場合、true。

<=またはlte

イベントのパラメーター値が指定値以下の場合、true。

=またはeq

イベントのパラメーター値が指定値に等しい場合、true。注: これは、演算子を一切指定しない場合、つまり、"'x' : { 'eq' : 'y' }"は"'x' : 'y' }と同じです。

!=またはneq

イベントのパラメーター値が指定値に等しくない場合、true。

contains

イベントのパラメーター値(string)が指定文字列を含む場合、true。指定された値が「shoe」である場合、値「shoe12345」は「contains」を満たします。

not_contains

イベントのパラメーター値(string)が指定文字列を含まない場合、true。指定された値が「purse」である場合、値「shoe12345」は「not_contains」を満たします。

i_contains

大文字/小文字を区別しないcontains(含む)

i_not_contains

大文字/小文字を区別しないnot contains(含まない)

is_any

イベントのパラメーター値が、指定された配列に含まれる文字列のどれかに一致する場合、true。

is_not_any

イベントのパラメーター値が、指定された配列に含まれるどの文字列にも一致しない場合、true。

i_is_any

大文字/小文字を区別しない「is_any」。

i_is_not_any

大文字/小文字を区別しない「is_not_any」

starts_with

イベントのパラメーター値が指定文字列で始まる場合、true

i_starts_with

大文字/小文字を区別しない「starts_with」

regex_match

「\"example\.com.*purchase$\"」のような正規表現とのマッチング検索。PCREの文法を完全にサポート

ウェブサイトのカスタムオーディエンス

過去30日間について、文字列shoesを含むすべての参照元URLとのマッチング検索を実行します。

{
    "inclusions": {
        "operator": "or",
        "rules": [
            {
                "event_sources": [
                    {
                        "type": "pixel",
                        "id": "<PIXEL_ID>",
                    }
                ],
                "retention_seconds": 2592000,
                "filter": {
                    "operator": "and",
                    "filters": [
                        {
                            "field": "url",
                            "operator": "i_contains",
                            "value": "shoes"
                        }
                    ]
                },
            }
        ]
    }
}

過去30日間について、商品価格が100米ドル以上のViewContentイベントとのマッチング検索を実行します。次のようなイベントの場合、このルールを使うことを検討してください。

_fbq.push([ 'track', 'ViewContent', { productId: 1234, category: 'Men > Shoes', price: 199 } ]);
{
    "inclusions": {
        "operator": "or",
        "rules": [
            {
                "event_sources": [
                    {
                        "type": "pixel",
                        "id": "<PIXEL_ID>"
                    }
                ],
                "retention_seconds": 2592000,
                "filter": {
                    "operator": "and",
                    "filters": [
                        {
                            "field": "event",
                            "operator": "eq",
                            "value": "ViewContent"
                        },
                        {
                            "operator": "or",
                            "filters": [
                                {
                                    "field": "price",
                                    "operator": ">=",
                                    "value": "100"
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    }
}

モバイルアプリのカスタムオーディエンス

モバイルアプリカスタムオーディエンス、カスタムオーディエンスルールの例をご覧ください。

演算子とデータまたはイベント

ルールで使われる演算子とデータまたはイベントは、次のとおりです。

演算子 フィルターのタイプ

i_contains

部分文字列を含む(大文字/小文字の区別なし)

i_not_contains

部分文字列を含まない(大文字/小文字の区別なし)

contains

部分文字列を含む(大文字/小文字の区別あり)

not_contains

部分文字列を含まない(大文字/小文字の区別あり)

eq

等しい(大文字/小文字の区別あり)

neq

等しくない(大文字/小文字の区別あり)

lt

より小さい(数値フィールドのみ)

lte

以下(数値フィールドのみ)

gt

より大きい(数値フィールドのみ)

gte

以上(数値フィールドのみ)

regex_match

\"example\\.com.*purchase$\"のような正規表現とのマッチング検索を実行します。PCREの文法を完全にサポート

データ フィルター処理するデータ

url

訪問したサイトのURL (完全にエスケープしたもの)

domain

訪問したサイトのドメイン

path

訪問したサイトのパス(ドメインは含まない)

event

ピクセルeventの名前('ViewContent'など)

device_type

サイトにアクセスしたデバイス:

desktop

mobile_android_phone

mobile_android_tablet

mobile_ipad

mobile_ipod

mobile_iphone

mobile_tablet

mobile_windows_phone

任意のcustomDataフィールド

productIdcategorypriceなど、ピクセル起動のためにcustomDataに追加される任意のフィールド

各ルールは、JSONエンコード文字列として指定します。