接続オーディエンスオブジェクト
接続オーディエンスは、APIリクエスト内でインラインに定義するダイナミックなオーディエンスフィルターです。Brazeダッシュボードでセグメントを作成・管理することなく、送信時に適切なユーザーをターゲットにできます。
あらゆるオーディエンスの組み合わせに対してセグメントを事前に構築する代わりに、APIコールのaudienceパラメーターにフィルター条件を直接渡します。Brazeはリアルタイムで各ユーザーをその条件に照らして評価し、条件に一致するユーザーにのみメッセージを配信します。つまり、1つのキャンペーン、キャンバス、またはAPIのみのメッセージ定義で、ビジネスロジックに完全に基づいた無制限のオーディエンスバリエーションに対応できます。
仕組み
- BrazeダッシュボードでAPIトリガーのキャンペーンまたはキャンバスを作成してメッセージを定義するか、APIリクエストのメッセージングオブジェクトを使用してメッセージコンテンツを完全にインラインで定義します。ダイナミックなパーソナライゼーションにはトリガープロパティまたはCanvas コンテキストを使用します。
- 対応するエンドポイントを呼び出し、フィルター条件を含む
audienceパラメーターを指定します。カスタム属性、プッシュ通知のサブスクリプションステータス、メールのサブスクリプションステータス、最後にアプリを使用した時間でフィルターできます。 - Brazeは送信時にフィルターを評価し、条件に一致するユーザーにのみメッセージを配信します。
audienceパラメーターを使用する場合、campaign_idは必須ではありません。/messages/sendおよび/messages/schedule/createエンドポイントでは、事前に作成したキャンペーンなしでメッセージコンテンツをインラインで定義できます。ただし、ダッシュボードでキャンペーンレベルの指標（送信数、クリック数、バウンスなど）を追跡したい場合は、campaign_idを含めてください。
オーディエンスはリクエストごとに定義されるため、バックエンドシステムは任意のビジネスイベント（価格変更、気象警報、ライブスコア更新など）に応じて、ダッシュボードの操作なしに状況に即した関連メッセージをトリガーできます。
対応エンドポイント
接続オーディエンスオブジェクトは、以下のエンドポイントのaudienceパラメーターで使用できます。
/messages/send/campaigns/trigger/send/canvas/trigger/send/messages/schedule/create/campaigns/trigger/schedule/create/canvas/trigger/schedule/create
ユースケース
バックエンドシステムがイベントを検出し、動的に決定されたユーザーセットに通知する必要があるシナリオで接続オーディエンスを使用します。
| カテゴリ | 例 |
|---|---|
| 気象警報 | 気象データプロバイダーが深刻な気象イベントを検出し、preferred_city属性が影響を受ける地域に一致するユーザーにプッシュ通知を送信します。 |
| スポーツ・ライブイベント | スポーツアプリが、favorite_team属性が試合中のチームに一致するユーザーにリアルタイムのスコア更新や試合アラートを送信します。 |
| コンテンツ・エンターテイメント | ストリーミングサービスが、新しいエピソードがリリースされるたびに、favorite_shows配列にそのシリーズタイトルを含むユーザーに通知します。 |
| Eコマース | オンライン小売業者が、wishlisted_products配列に該当する商品IDを含むユーザーに値下げや再入荷のアラートを送信します。 |
| 旅行 | 旅行アプリが、booked_flight属性が影響を受けるフライト番号に一致するユーザーにフライト遅延通知を送信します。 |
| 金融サービス | 取引プラットフォームが、watchlist配列に価格閾値を超えた銘柄コードを含むユーザーにアラートを送信します。 |
いずれの場合も、1つのキャンペーンまたはAPIのみのメッセージ定義ですべてのバリエーションに対応します。バックエンドがフィルター値を決定してAPIリクエストに渡すため、商品、番組、チーム、ロケーションごとに個別のセグメントやキャンペーンを作成する必要はありません。
リクエスト例
以下の例では、/campaigns/trigger/sendエンドポイントを使用して、特定の番組をお気に入りに登録し、プッシュ通知をオプトインしているユーザーをターゲットにしています。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
"campaign_id": "YOUR_CAMPAIGN_ID",
"audience": {
"AND": [
{
"custom_attribute": {
"custom_attribute_name": "favorite_shows",
"comparison": "includes_value",
"value": "Example Show"
}
},
{
"push_subscription_status": {
"comparison": "is",
"value": "opted_in"
}
}
]
},
"trigger_properties": {
"show_title": "Example Show",
"episode_title": "Season 3, Episode 1",
"deep_link": "https://example.com/shows/example-show/s3e1"
},
"broadcast": false
}
オブジェクト本文
接続オーディエンスオブジェクトは、1つの接続オーディエンスフィルター、またはANDとOR演算子で組み合わせた複数の接続オーディエンスフィルターで構成されます。
複数フィルターの例：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"AND":
[
Connected Audience Filter,
{
"OR" :
[
Connected Audience Filter,
Connected Audience Filter
]
},
Connected Audience Filter
]
}
接続オーディエンスフィルター
複数のフィルターをANDおよびOR演算子と組み合わせて、接続オーディエンスフィルターを作成します。
カスタム属性フィルター
このフィルターでは、ユーザーのカスタム属性に基づいてセグメント化できます。これらのフィルターには最大3つのフィールドが含まれます。
1
2
3
4
5
6
7
8
{
"custom_attribute":
{
"custom_attribute_name": (String) the name of the custom attribute to filter on,
"comparison": (String) one of the allowed comparisons to make against the provided value,
"value": (String, Numeric, Boolean) the value to be compared using the provided comparison
}
}
データタイプ別の許容される比較
カスタム属性のデータタイプによって、指定されたフィルターで有効な比較が決まります。
| カスタム属性タイプ | 許容される比較 |
|---|---|
| 文字列 | equals、not_equal、matches_regex、does_not_match_regex、exists、does_not_exist |
| 配列 | includes_value、does_not_include_value、exists、does_not_exist |
| 数値 | equals、not_equal、greater_than、greater_than_or_equal_to、less_than、less_than_or_equal_to、exists、does_not_exist |
| ブール値 | equals、not_equal、exists、does_not_exist |
| 時刻 | less_than_x_days_ago、greater_than_x_days_ago、less_than_x_days_in_the_future、greater_than_x_days_in_the_future、after、before、exists、does_not_exist |
属性比較の注意点
| 比較 | その他の考慮事項 |
|---|---|
value |
existsまたはdoes_not_existの比較を使用する場合、valueは必要ありません。beforeおよびafterの比較を使用する場合、valueはISO 8601日時文字列である必要があります。 |
matches_regex |
matches_regex比較を使用する場合、渡される値は文字列である必要があります。Brazeでの正規表現の使用については、正規表現とカスタム属性のデータタイプを参照してください。 |
カスタム属性の例
1
2
3
4
5
6
7
8
{
"custom_attribute":
{
"custom_attribute_name": "eye_color",
"comparison": "equals",
"value": "blue"
}
}
1
2
3
4
5
6
7
8
{
"custom_attribute":
{
"custom_attribute_name": "favorite_foods",
"comparison": "includes_value",
"value": "pizza"
}
}
1
2
3
4
5
6
7
8
{
"custom_attribute":
{
"custom_attribute_name": "last_purchase_time",
"comparison": "less_than_x_days_ago",
"value": 2
}
}
プッシュ通知のサブスクリプションフィルター
このフィルターでは、ユーザーのプッシュ通知のサブスクリプションステータスに基づいてセグメント化できます。
フィルター本文
1
2
3
4
5
6
7
{
"push_subscription_status":
{
"comparison": (String) one of the following allowed comparisons,
"value": (String) one of the following allowed values
}
}
- 許容される比較：
is、is_not - 許容される値：
opted_in、subscribed、unsubscribed
メールのサブスクリプションフィルター
このフィルターでは、ユーザーのメールのサブスクリプションステータスに基づいてセグメント化できます。
フィルター本文
1
2
3
4
5
6
7
{
"email_subscription_status":
{
"comparison": (String) one of the following allowed comparisons,
"value": (String) one of the following allowed values
}
}
- 許容される比較：
is、is_not - 許容される値：
opted_in、subscribed、unsubscribed
最後に使用したアプリフィルター
このフィルターでは、ユーザーが最後にアプリを使用した時間に基づいてセグメント化できます。これらのフィルターには2つのフィールドが含まれます。
フィルター本文
1
2
3
4
5
6
7
{
"last_used_app":
{
"comparison": (String) one of the allowed comparisons listed,
"value": (String) the value to be compared using the provided comparison
}
}
- 許容される比較：
after、before - 許容される値： datetime（ISO 8601文字列）
考慮事項
接続オーディエンスでは、デフォルト属性、カスタムイベント、セグメント、またはメッセージエンゲージメントイベントによるユーザーのフィルタリングはできません。これらのフィルターを使用するには、オーディエンスセグメントに組み込んだうえで、/messages/sendエンドポイントのsegment_idパラメーターでそのセグメントを指定することをお勧めします。他のエンドポイントを使用する場合は、まずBrazeダッシュボードでAPIトリガーキャンペーンまたはキャンバスにセグメントを追加する必要があります。
GitHub でこのページを編集