Skip to content

Recipientsオブジェクト

受信者オブジェクトを使用すると、エンドポイントで情報をリクエストまたは書き込みできます。

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

recipients オブジェクトを使用すると、user alias object、trigger properties object、およびCanvas entry properties object を組み合わせることができ。

オブジェクト本体

1
2
3
4
5
6

[{
  "user_alias": (optional, User Alias Object) User alias of user to receive message,
  "external_user_id": (optional, string) see External user ID,
  "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
}]

受信者オブジェクトのデデューピング

受信者オブジェクトを使用してAPI コールを行う場合、同じアドレス(つまり、email、push) をターゲットとする重複した受信者が存在する場合、ユーザはデデュープ されます。つまり、同一のユーザが削除され、残りのユーザが削除されます。

たとえば、同じ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 でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!