受信者オブジェクト
受信者オブジェクトを使用すると、エンドポイントで情報をリクエストしたり書き込んだりできます。
このオブジェクトには、external_user_id、user_alias、braze_id、または email のいずれかを含める必要があります。リクエストでは1つだけ指定してください。
受信者オブジェクトを使用すると、ユーザーエイリアスオブジェクト、トリガープロパティオブジェクト、Canvas エントリプロパティオブジェクト、およびユーザー属性オブジェクトを組み合わせることができます。
オブジェクト本体
1
2
3
4
5
6
7
8
9
10
11
[{
"user_alias": (optional, User Alias Object) User alias of user to receive message,
"external_user_id": (optional, string) see External user ID,
"braze_id": (optional, string) see Braze ID,
"email": (optional, string) email address of user to receive message,
"prioritization": (optional, array) see Prioritization; required when using email,
"trigger_properties": (optional, object) personalization key-value pairs for this user when sending a campaign or message; see Trigger Properties,
"context": (optional, object) personalization key-value pairs for this user when triggering a Canvas; see Canvas context object,
"send_to_existing_only": (optional, boolean) defaults to true; cannot be used with user aliases,
"attributes": (optional, object) fields in the attributes object create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values are overwritten
}]
send_to_existing_only が true の場合、Braze は既存のユーザーにのみメッセージを送信します。ただし、このフラグはユーザーエイリアスでは使用できません。send_to_existing_only が false の場合、属性を含める必要があります。Braze はメッセージを送信する前に、id と属性を持つユーザーを作成します。
受信者オブジェクトの重複排除
受信者オブジェクトを使用して API 呼び出しを行う際、同一の宛先（つまりメールやプッシュ通知）をターゲットとする重複した受信者が存在する場合、Braze はユーザーの重複を排除します。つまり、Braze は同一のユーザーを削除し、1つだけを残します。
例えば、同じ external_user_id を使用した場合、ユーザーはメッセージを1つだけ受信します。この動作を回避する必要がある場合は、複数の API 呼び出しを行うことを検討してください。
同じ external_user_id が受信者配列内に複数回出現する場合、Braze はメッセージを1つだけ送信し、配列内の最後のエントリのトリガープロパティを使用します。この動作は決定論的であり、配列の順序に基づいています。
次の例では、userid1 は "name": "Beth Test 2" を使用したメッセージを1つ受信します。これは、そのエントリが配列内で最後に出現するためです。
1
2
3
4
{"campaign_id":"#####","recipients":[
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 1"}},
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 2"}}
]}