ユーザーを識別する

このエンドポイントを使用して、指定された外部 ID を使用して識別されていない (エイリアスのみまたはメールのみ) ユーザーを識別します。

CDI の仕組み

/users/identify を呼び出すと、エイリアス (エイリアスのみのプロファイル) またはメールアドレス (メールのみのプロファイル) によって識別されるユーザープロファイルと、external_id (識別されたプロファイル) を持つユーザープロファイルが結合され、エイリアスのみのプロファイルが削除されます。

ユーザーを識別するには、 external_id を aliases_to_identify または emails_to_identify オブジェクトに含める必要があります。そのexternal_id を持つユーザーが存在しない場合、external_id がエイリアスされたユーザーの記録に追加され、そのユーザーは識別されたとみなされる。

次のことに注意してください。

• これらの後続の関連付けがmerge_behaviorフィールドをnoneに設定して行われると、ユーザーエイリアスに関連付けられたプッシュトークンとメッセージ履歴のみが保持されます。属性、イベント、または購入は「孤立」し、識別されたユーザーには利用できません。1つの回避策は、識別前にエイリアスされたユーザーのデータを/users/export/idsエンドポイントを使用してエクスポートし、識別されたユーザーに属性、イベント、および購入を再関連付けることです。
• merge_behavior フィールドを merge に設定して関連付けを行うと、このエンドポイントは匿名ユーザーで見つかった特定のフィールドを識別されたユーザーにマージします。

前提条件

このエンドポイントを使用するには、API キーとusers.identifyの権限が必要です。

レート制限

要求本文:

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
{
   "aliases_to_identify" : (required, array of alias to identify objects),
   "email_addresses": (optional, array of string) User emails for the users to identify,
   "merge_behavior": (optional, string) one of 'none' or 'merge' is expected
}

リクエストパラメーター

リクエストごとに最大50個のユーザーエイリアスを追加できます。複数の追加ユーザーエイリアスを単一のexternal_idに関連付けることができます。

Merge_behavior フィールド

merge_behaviorフィールドをmergeに設定すると、匿名ユーザーにのみ存在する以下のフィールドが識別されたユーザーに統合されます。フィールドをnoneに設定しても、ユーザーデータは識別されたユーザープロファイルにマージされません。

メールによるユーザーの識別

識別子としてemail が指定された場合、識別子にはさらにprioritization の値が必要となる。prioritization は、複数のユーザーが見つかった場合に、どのユーザーをマージするかを指定する配列でなければならない。prioritization は順序付き配列である。つまり、優先順位付けから複数のユーザーがマッチした場合、マージは行われない。

配列に使用できる値は、identified、unidentified、most_recently_updated です。most_recently_updated は、最も最近更新されたユーザーを優先することを意味します。

優先配列には、一度に以下のオプションのうち1つしか存在できません。

• identified を持つユーザーを優先することである。 external_id
• unidentified のないユーザーを優先することである。 external_id

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --location --request POST 'https://rest.iad-01.braze.com/users/identify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "aliases_to_identify": [
    {
      "external_id": "external_identifier",
      "user_alias": {
          "alias_name": "example_alias",
          "alias_label": "example_label"
      }
    }
  ],
  "emails_to_identify": [
    {
      "external_id": "external_identifier_2",
      "email": "john.smith@braze.com",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
  "merge_behavior": "merge"
}'

応答

1
2
3
4
5
6
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
    "aliases_processed": 1,
    "message": "success"
}