ユーザーを識別する

このエンドポイントを使用して、未確認の（エイリアスのみの）ユーザーを識別します。

/users/identify を呼び出すと、エイリアスのみのプロファイルと識別されたプロファイルが結合され、エイリアスのみのプロファイルが削除されます。

ユーザーを識別するには、external_idをaliases_to_identifyオブジェクトに含める必要があります。そのexternal_idを持つユーザーがいない場合、external_idはエイリアスされたユーザーの記録に追加され、ユーザーは識別されたと見なされます。リクエストごとに最大50個のユーザーエイリアスを追加できます。

その後、複数の追加ユーザーエイリアスを単一のexternal_idに関連付けることができます。

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

前提条件

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

レート制限

2021年9月16日以降に Braze にオンボーディングしたお客様については、このエンドポイントに対して行う要求にレート制限が適用されます。詳細については、APIの制限を参照してください。

要求本文:

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

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

リクエストパラメーター

Merge_behavior フィールド

merge_behaviorフィールドをmergeに設定すると、エンドポイントは匿名ユーザーに見つかった以下のフィールドのいずれかを特定のユーザーに排他的にマージするように設定されます。

• 名
• 姓
• メール
• 性別
• 生年月日
• 電話番号
• タイムゾーン
• 市区町村
• 国
• 言語
• セッション数 （両方のプロファイルのセッションの合計）
• 初回セッションの日付 (Braze は2つの日付のうち早い方を選択します)
• 最終セッションの日付 (Braze は2つの日付のうち遅い方の日付を選択します)
• カスタム属性
• カスタム・イベントと購入イベントのデータ
• Y日間にX回」のセグメンテーション（X<=50、Y<=30）のためのカスタムイベントと購入イベントのプロパティ。
• セグメント可能なカスタム・イベントのサマリー
  • イベント数（両プロファイルの合計）
  • イベントが最初に発生した日（Brazeは2つの日付のうち早い方を選ぶ）
  • イベントが最後に発生した日（Brazeは2つの日付のうち遅い方を選ぶ）
• アプリ内購入の合計（セント単位）（両方のプロファイルの合計)
• 購入総数 (両方のプロファイルの合計)
• 初回購入日 (Braze は2つの日付のうち早い方を選択します)
• 最終購入日 (Braze は2つの日付のうち遅い方を選択します)
• アプリの概要
• Last_X_atフィールド（Brazeは、孤児となったプロファイルフィールドがより新しいものであれば、フィールドを更新する）
• キャンペーンの概要（Brazeは最新の日付フィールドを選択します）
• ワークフローのサマリー（Brazeは最新の日付フィールドを選ぶ）
• メッセージとメッセージのエンゲージメント履歴

匿名ユーザーから識別されたユーザーに対して検出された次のいずれかのフィールド。

• カスタムイベントと購入イベントのカウントと最初の日付と最後の日付のタイムスタンプ
  • これらの統合されたフィールドは、「Y日以内にXイベント」フィルターを更新する。購入イベントの場合、これらのフィルターには、「Y日間の購入回数」と「過去Y日間の使用金額」が含まれる。

セッションデータは、両方のユーザープロファイルにアプリが存在する場合にのみマージされる。たとえば、ターゲットユーザーには「ABCApp」のアプリ概要がなく、元のユーザーにはある場合、ターゲットユーザーのプロファイルにはマージ後に「ABCApp」のアプリ概要が表示されます。

フィールドを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": "[email protected]",
      "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"
}