ユーザーを結合

このエンドポイントを使用して、あるユーザーを別のユーザーに統合します。

1 つのリクエストで最大 50 のマージを指定できます。このエンドポイントは非同期です。

前提条件

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

レート制限

For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the /users/delete, /users/alias/new, /users/identify, and /users/alias/update endpoints, as documented in API rate limits.

リクエスト本文

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

1
2
3
{
  "merge_updates" : (required, array of objects)
}

リクエストパラメーター

マージ動作

以下に記載されている動作は、Snowflakeを搭載していないすべてのBraze機能に当てはまります。ユーザーマージは、[メッセージング履歴] タブ、[セグメント拡張]、[クエリビルダー]、および [カレント] には反映されません。

このエンドポイントは、ターゲットユーザーで次のフィールドが見つからない場合、それらのいずれかをマージします。

• 名
• 姓
• メール
• 性別
• 生年月日
• 電話番号
• タイムゾーン
• 自宅の都市
• 国
• 言語
• セッション数 (両方のプロファイルからのセッションの合計)
• 最初のセッションの日付（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 日間の購入金額」が含まれます。

メールによるユーザーの結合

識別子として an を指定する場合、emailprioritization識別子には追加の値が必要です。は、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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
curl --location --request POST 'https://rest.iad-01.braze.com/users/merge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
{
  "merge_updates": [
    {
      "identifier_to_merge": {
        "external_id": "old-user1"
      },
      "identifier_to_keep": {
        "external_id": "current-user1"
      }
    },
    {
      "identifier_to_merge": {
        "email": "[email protected]"
      },
      "identifier_to_keep": {
        "email": "[email protected]"
      }
    },
    {
      "identifier_to_merge": {
        "user_alias": {
          "alias_name": "[email protected]",
          "alias_label": "email"
        }
      },
      "identifier_to_keep": {
        "user_alias": {
          "alias_name": "[email protected]",
          "alias_label": "email"
        }
      }
    }
  ]
}'

身元不明ユーザーの結合

次のリクエストは、メールアドレスが「[email protected]」で最後に更新された正体不明のユーザーを external_id「john」のユーザーに統合します。を使用すると、クエリーが 1 most_recently_updated 人の身元不明ユーザーのみにフィルタリングされます。したがって、このメールアドレスを持つ正体不明のユーザーが2人いる場合、external_id「john」のユーザーに統合されるのは1人だけです。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --location --request POST 'https://rest.iad-01.braze.com/users/merge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
{
  "merge_updates": [
    {
      "identifier_to_merge": {
        "email": "[email protected]",
        "prioritization": ["unidentified", "most_recently_updated"]
      },
      "identifier_to_keep": {
        "external_id": "john"
      }
    }
  ]
}'

未確認ユーザーを識別済みユーザーへの統合

次の例では、電子メールアドレスが「[email protected]」で最後に更新された正体不明ユーザーを、電子メールアドレス「[email protected]」を持つ最後に更新された識別済みユーザーに統合します。を使用すると、クエリーが 1 人のユーザ（1 人の身元不明のユーザとの identifier_to_merge 1 人の識別されたユーザidentifier_to_keep）most_recently_updatedだけにフィルタされます。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --location --request POST 'https://rest.iad-01.braze.com/users/merge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
{
  "merge_updates": [
    {
      "identifier_to_merge": {
        "email": "[email protected]",
        "prioritization": ["unidentified", "most_recently_updated"]
      },
      "identifier_to_keep": {
        "email": "[email protected]",
        "prioritization": ["identified", "most_recently_updated"]
      }
    }
  ]
}'

「最新」の優先順位付けを含めずに身元不明のユーザーを統合する

メールアドレスが「[email protected]」の正体不明のユーザーが2人いる場合、この例のリクエストでは、そのメールアドレスを持つ身元不明のユーザーが2人いるため、ユーザーは統合されません。このリクエストは、メールアドレスが「[email protected]」の身元不明のユーザーが1人しかいない場合にのみ機能します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --location --request POST 'https://rest.iad-01.braze.com/users/merge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
{
  "merge_updates": [
    {
      "identifier_to_merge": {
        "email": "[email protected]",
        "prioritization": ["unidentified"]
      },
      "identifier_to_keep": {
        "external_id": "john"
      }
    }
  ]
}'

応答

このエンドポイントには、202との 2 つのステータスコード応答があります400。

成功レスポンスの例

202ステータスコードは次のレスポンスボディを返す可能性があります。

1
2
3
{
  "message": "success"
}

エラーレスポンスの例

400ステータスコードは次のレスポンスボディを返す可能性があります。発生する可能性のあるエラーの詳細については、「トラブルシューティング」を参照してください。

1
2
3
{
  "message": "'merge_updates' must be an array of objects"
}

トラブルシューティング

次の表は、発生する可能性のあるエラーメッセージの一覧です。