ユーザーを識別する

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

仕組み

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

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

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

そのユーザーexternal_idが存在しない場合、エイリアスユーザーに追加external_idされ、ユーザーは識別子として使用される。ユーザーは特定のラベルに対して一つのエイリアスしか持つことができない。ユーザーが既に存在し、external_idかつエイリアス専用プロファイルと同じラベルを持つ既存のエイリアスを持っている場合、ユーザープロファイルは統合されない。

マージ動作

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

前提条件

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

レート制限

このエンドポイントには、分あたり20,000リクエストという共有レート制限を適用している。このレート制限は、API レート制限に記載されているように、/users/alias/new、/users/merge、/users/alias/update、および /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": "john.smith@braze.com",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

応答

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