ユーザーを識別する

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

CDI の仕組み

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

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

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

そのexternal_id のユーザーがない場合、external_id が別名のユーザーのレコードに追加され、ユーザーが識別されたと見なされます。ユーザーは、特定のラベルのエイリアスを1 つだけ持つことができます。external_id を持つユーザーがすでに存在し、alias-only プロファイルと同じラベルのエイリアスが存在する場合、ユーザープロファイルs は結合されません。

マージ動作

デフォルトでは、このエンドポイントは、特定されたユーザーへの匿名ユーザーで排他的にで見つかったフィールドの以下の一覧をマージします。

前提条件

このエンドポイントを使用するには、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

配列にidentified を指定した場合、ユーザーはキャンバスに入力するために external_id を持っている必要があることを意味します。メールアドレスを持つユーザーに、識別子の有無にかかわらずメッセージを入力させたい場合は、代わりにmost_recently_updated またはleast_recently_updated パラメータのみを使用する。

リクエスト例

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"]
    }
  ]
}'

応答

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