Skip to content

受信者オブジェクト

受信者オブジェクトは、エンドポイントに情報を要求したり書き込んだりすることができる。

このオブジェクトにはemail、必ずuser_alias、external_user_idまたはのいずれかbraze_idを含めなければならない。リクエストでは 1 つだけ指定する必要があります。

受信者オブジェクトは、ユーザーエイリアスオブジェクト、トリガープロパティオブジェクト、キャンバスエントリプロパティオブジェクト、およびユーザー属性オブジェクトを組み合わせることができる。

オブジェクト本体

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一つのメッセージしか受け取らない。この動作を回避する必要がある場合は、複数のAPIコールを行うことを検討してください。

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"}}
]}
Github   GitHub でこのページを編集
New Stuff!