ユーザーを識別する

このエンドポイントを使用して、指定された external ID を使用して未識別（エイリアスのみ、メールのみ、または電話番号のみ）のユーザーを識別します。

仕組み

/users/identify を呼び出すと、エイリアス（エイリアスのみのプロファイル）、メールアドレス（メールのみのプロファイル）、または電話番号（電話番号のみのプロファイル）で識別されるユーザープロファイルと、external_id を持つユーザープロファイル（識別済みプロファイル）が結合され、エイリアスのみのプロファイルが削除されます。

ユーザーを識別するには、以下のオブジェクトに external_id を含める必要があります。

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

その external_id を持つユーザーが存在しない場合、external_id はエイリアスユーザーのレコードに追加され、ユーザーは識別済みとみなされます。ユーザーは特定のラベルに対して1つのエイリアスしか持つことができません。external_id を持つユーザーが既に存在し、かつエイリアスのみのプロファイルと同じラベルを持つ既存のエイリアスがある場合、ユーザープロファイルは結合されません。

マージ動作

デフォルトでは、このエンドポイントは匿名ユーザーにのみ存在する以下のフィールドリストを、識別済みユーザーにマージします。

前提条件

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

レート制限

このエンドポイントには、1分あたり20,000リクエストの共有レート制限が適用されます。このレート制限は、API レート制限に記載されているように、/users/delete、/users/alias/new、/users/merge、および /users/alias/update エンドポイントと共有されます。

リクエスト本文

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),
   "emails_to_identify": (optional, array of alias to identify objects) User emails to identify,
   "phone_numbers_to_identify": (optional, array of alias to identify objects) User phone numbers to identify,
},

リクエストパラメーター

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

メールアドレスと電話番号によるユーザーの識別

メールアドレスや電話番号を識別子として指定する場合は、識別子に prioritization も含める必要があります。

prioritization は、複数のユーザーが見つかった場合にマージするユーザーを指定する配列でなければなりません。prioritization は順序付き配列であり、優先順位付けから複数のユーザーが一致した場合、マージは行われません。

配列に指定できる値は次のとおりです。

• identified
• unidentified
• most_recently_updated（最近更新されたユーザーを優先することを意味します）
• least_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
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": "[email protected]",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

大文字と小文字の区別

alias_name フィールドは大文字と小文字を区別します。201 ステータスコードを返すリクエストは、リクエストの構文が有効であることのみを確認するものであり、エイリアスが一致したことを確認するものではありません。リクエスト内の alias_name の大文字と小文字がユーザープロファイルに保存されているエイリアスと正確に一致しない場合、操作はサイレントに失敗し、external_id は割り当てられません。例えば、保存されているエイリアスが [email protected] の場合、[email protected] でリクエストすると成功を返しますが、結果は生成されません。

応答

1
2
3
4
{
    "aliases_processed": 1,
    "message": "success"
}