ユーザーをマージする

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

マージはリクエストごとに50個まで指定できます。このエンドポイントは非同期である。

前提条件

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

レート制限

このエンドポイントには、分あたり20,000リクエストという共有レート制限を適用している。このレート制限は、API レート制限に記載されているように、/users/alias/new、/users/identify、/users/alias/update、および /users/alias/update エンドポイントと共有されます。

要求本文:

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

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

リクエストパラメーター

マージ動作

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

このエンドポイントは、対象ユーザーに以下のフィールドが存在しない場合、それらをマージする。

• 名
• 姓
• メール（暗号化されていない場合）
• 性別
• 生年月日
• 電話番号
• タイムゾーン
• 市区町村
• 国
• 言語
• デバイス情報
• セッション数 （両方のプロファイルのセッションの合計）
• 初回セッションの日付（Brazeは二つの日付のうち早い方を選ぶ）
• 最終セッションの日付（Brazeは2つの日付のうち遅い方を選択する）
• カスタム属性（Brazeはターゲットプロファイル上の既存のカスタム属性を保持し、ターゲットプロファイルに存在しなかったカスタム属性も追加する）
• カスタム・イベントと購入イベントのデータ
• 「X回をY日間で」セグメンテーション用のカスタムイベントおよび購入イベントのプロパティ（ここでX<=50 および Y<=30)
• セグメント可能なカスタム・イベントのサマリー
  • イベント数（両プロファイルの合計）
  • イベントが最初に発生した日時（Brazeは二つの日付のうち早い方を選択する）
  • イベントが最後に発生した日時（Brazeは二つの日付のうち遅い方を選択する）
• アプリ内購入の合計（セント単位）（両方のプロファイルの合計)
• 購入総数 (両方のプロファイルの合計)
• 初回購入日（Brazeは二つの日付のうち早い方を選択する）
• 最終購入日（Brazeは二つの日付のうち遅い方を選択する）
• アプリの概要
• Last_X_at フィールド（孤立したプロファイルのフィールドがより新しい場合、Brazeはフィールドを更新する）
• キャンペーンのインタラクションデータ（Brazeは最も新しい日付フィールドを選択する）
• ワークフローの概要（Brazeは最新の日付フィールドを選択する）
• メッセージとメッセージのエンゲージメント履歴
• Brazeは、アプリが両方のユーザープロファイルに存在する場合にのみセッションデータを統合する。

カスタムイベント日と購入イベント日の動作

これらの結合フィールドは「X件のイベントがY日間で発生」というフィルターを更新する。購入イベントの場合、これらのフィルターには、「Y日間の購入回数」と「過去Y日間の使用金額」が含まれる。

電子メールまたは電話番号でユーザーをマージする

識別子として またはphone emailが指定された場合、識別子に追加の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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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": "user1@braze.com",
        "prioritization": ["unidentified", "most_recently_updated"]
      },
      "identifier_to_keep":  {
        "email": "user2@braze.com",
        "prioritization": ["identified", "most_recently_updated"]
      }
    },
    {
      "identifier_to_merge": {
        "user_alias": {
          "alias_name": "old-user2@example.com",
          "alias_label": "email"
        }
      },
      "identifier_to_keep": {
        "user_alias": {
          "alias_name": "current-user2@example.com",
          "alias_label": "email"
        }
      }
    }
  ]
}'

未確認ユーザーをマージする

以下のリクエストは、メールアドレスを持つ最新の更新された未識別ユーザーを、john.smith@braze.comexternal IDを持つjohnユーザーに統合する。この例では、フィルターmost_recently_updatedを使用することでクエリを未識別ユーザー1件に絞り込む。つまり、このメールアドレスを持つ未識別ユーザーが二人いた場合、external IDを持つユーザーにマージjohnされるのは一人だけだ。

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": "john.smith@braze.com",
        "prioritization": ["unidentified", "most_recently_updated"]
      },
      "identifier_to_keep": {
        "external_id": "john"
      }
    }
  ]
}'

未確認ユーザーを識別されたユーザーにマージする

次の例では、メールアドレスを持つ最新の未識別ユーザーを、メールアドレスjohn.smith@braze.comを持つ最新の識別済みjohn.smith@braze.comユーザーに統合する。

フィルターmost_recently_updatedを使用して、クエリを1人のユーザーに絞り込む（1人は未特定ユーザー、identifier_to_mergeもう1人は識別子を持つユーザーであるidentifier_to_keep）。

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": "john.smith@braze.com",
        "prioritization": ["unidentified", "most_recently_updated"]
      },
      "identifier_to_keep": {
        "email": "john.smith@braze.com",
        "prioritization": ["identified", "most_recently_updated"]
      }
    }
  ]
}'

優先most_recently_updated順位付けを含めずに、未識別ユーザーをマージする

メールアドレスが同じ未識別ユーザーがjohn.smith@braze.com2人いる場合、このリクエスト例ではユーザーをマージしない。なぜなら、そのメールアドレスを持つ未識別ユーザーが2人存在するからだ。このリクエストは、メールアドレスが未識別ユーザーが1人だけjohn.smith@braze.comの場合にのみ機能する。

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": "john.smith@braze.com",
        "prioritization": ["unidentified"]
      },
      "identifier_to_keep": {
        "external_id": "john"
      }
    }
  ]
}'

応答

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

成功応答の例

ステータスコード 202 は、次の応答本文を返す可能性があります。

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

エラー応答例

ステータスコード 400 は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。

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

トラブルシューティング

以下の表は、起こりうるエラーメッセージの一覧である。