Skip to content

受信者オブジェクト

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

このオブジェクトには、external_user_id 、user_alias 、braze_id 、email のいずれかを含めなければならない。リクエストでは 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,
  "canvas_entry_properties": (optional, object) personalization key-value pairs for this user when triggering a Canvas; see Canvas Entry Properties,
  "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コールを行うことを検討してください。

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!