ユーザーを特定する

このエンドポイントを使用して、身元不明の (エイリアスのみ) ユーザーを識別します。

コールすると、/users/identifyエイリアスのみのプロファイルが識別されたプロファイルに組み合わされ、エイリアスのみのプロファイルが削除されます。

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

その後、external_id複数の追加ユーザーエイリアスを単一のユーザーエイリアスに関連付けることができます。 -merge_behavior フィールドをに設定して以降の関連付けを行うとnone、ユーザーエイリアスに関連付けられているプッシュトークンとメッセージ履歴のみが保持されます。属性、イベント、購入はすべて「孤立」し、特定されたユーザーには使用できなくなります。回避策の 1 つは、/users/export/idsエンドポイントを使用して識別する前に、エイリアスされたユーザーのデータをエクスポートし、属性、イベント、購入を特定されたユーザーに再度関連付けることです。 -merge_behavior フィールドをに設定して関連付けを行うとmerge、このエンドポイントは匿名ユーザーで見つかった特定のフィールドを識別されたユーザーにマージします。

前提条件

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

レート制限

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匿名ユーザーのみにある以下のフィールドのいずれかを、識別されたユーザーにマージするようにエンドポイントが設定されます。 名 姓 メール 性別 生年月日 電話番号 タイムゾーン: 自宅の都市 国 言語 -セッション数 (両方のプロファイルからのセッションの合計) -最初のセッションの日付（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、ユーザーデータは指定されたユーザープロファイルに統合されません。

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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"
      }
    }
  ],
  "merge_behavior": "merge"
}'

応答

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