新しいユーザーエイリアスを作成する
/users/alias/new
このエンドポイントを使用して、既存の識別済みユーザーに新しいユーザーエイリアスを追加するか、新しい未識別ユーザーを作成します。
1回のリクエストで最大50個のユーザーエイリアスを指定できます。
既存のユーザーにユーザーエイリアスを追加するには、新しいユーザーエイリアスオブジェクトにexternal_idを含める必要があります。オブジェクトにexternal_idが含まれていても、そのexternal_idを持つユーザーが存在しない場合、エイリアスはどのユーザーにも追加されません。external_idが含まれていない場合でもユーザーは作成されますが、後で識別する必要があります。識別は「ユーザーの識別」とusers/identifyエンドポイントを使用して行えます。
エイリアスのみの新規ユーザーを作成するには、新しいユーザーエイリアスオブジェクトからexternal_idを省略する必要があります。ユーザーが作成されたら、/users/trackエンドポイントを使用してエイリアスのみのユーザーに属性、イベント、購入を関連付け、/users/identifyエンドポイントを使用してexternal_idでユーザーを識別します。
/campaigns/trigger/sendエンドポイントを使用すると、user_aliasを指定してAPIトリガーキャンペーンをユーザーに送信できます。
alias_labelとalias_nameが既に存在する場合
alias_labelとalias_nameの組み合わせは、ユーザー群全体で一意である必要があります。詳細については、ユーザーエイリアスを参照してください。
alias_labelとalias_nameのペアが既にいずれかのユーザー(リクエスト対象と同じユーザーか別のユーザーかを問わず)に存在する状態でリクエストを送信した場合でも、エンドポイントは成功レスポンスを返します(例:"aliases_processed": 1、"message": "success")。この場合、リクエスト内のユーザーに新しいエイリアスは追加されません。alias_labelとalias_nameのペアが既に使用されているため、リクエストによる変更は一切行われず、該当ユーザーにエイリアスが追加されなかったように見えることがあります。
トラブルシューティング
このエンドポイントでユーザーエイリアスを作成した後、属性が更新されないのはなぜですか?
この問題は通常、/users/alias/newの後に、エイリアスで属性を更新しようとする別の/users/trackリクエストを送信した場合に発生します。Brazeが新しいalias_labelとalias_nameのペアをプロファイルに一貫して解決できるようになる前にtrackリクエストが処理されることがあるため、属性が想定したユーザーに反映されません。
推奨される方法: エイリアスのみのプロファイルを作成する場合、または既存のエイリアスでプロファイルを更新する場合は、/users/trackの呼び出し1回だけで行ってください。attributes配列で、user_aliasとプロファイルフィールドを同じユーザー属性オブジェクトに含めると、Brazeはユーザーを解決し、1つのステップで更新を適用します。
そのオブジェクトからエイリアスのみのプロファイルを作成する可能性がある場合は、_update_existing_onlyをfalseに設定してください。user_aliasを使用する際にこれを省略すると、Brazeはデフォルトで更新のみの動作となり、エイリアスのみのプロファイルは作成されません。エイリアスがワークスペース内のユーザーに既に存在する場合は、同じリクエストでそのプロファイルが新しい属性で更新されます。
/users/trackを使用して、external_idで識別された既存ユーザーに新しいエイリアスを追加することはできません。ユーザー属性オブジェクトでは、external_idとuser_aliasは相互に排他的です。識別済みユーザーにエイリアスを追加するには、まず/users/alias/newを呼び出します。エイリアスが関連付けられた後は、external_idまたは既存のエイリアスを使用して、/users/trackでそのプロファイルを更新できます。
たとえば、次の/users/track本文は、エイリアスがまだ存在しない場合はエイリアスのみのプロファイルを作成し、既にそのエイリアスを持つプロファイルが存在する場合はそのプロファイルを更新します。
{
"attributes": [
{
"user_alias": {
"alias_name": "[email protected]",
"alias_label": "email"
},
"_update_existing_only": false,
"string_attribute": "test_alias_only_update"
}
]
}
OpenAPIドキュメントをダウンロードして、スキーマの検証に使用できます。方法については、OpenAPIスキーマを使用したリクエストの検証を参照してください。