Skip to content

ユーザーをマージする

post

/users/merge

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

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

前提条件

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

レート制限

2021年9月16日以降に Braze にオンボーディングした顧客の場合、このエンドポイントには、1分あたり20,000リクエストの共有レート制限が適用されます。このレート制限は、API レート制限に記載されているように、/users/delete/users/alias/new/users/identify、および /users/alias/update エンドポイントと共有されます。

要求本文:

リクエストパラメーター

パラメーター required データ型 説明
merge_updates required 配列 オブジェクトの配列。各オブジェクトには identifier_to_merge オブジェクトと identifier_to_keep オブジェクトが含まれている必要があり、それぞれが external_iduser_aliasphone、または email のいずれかでユーザーを参照する必要があります。

マージ動作

以下に説明する動作は、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日間の使用金額」が含まれる。

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

識別子として email または phone が指定された場合、識別子にはさらに prioritization の値が必要になります。prioritization は、複数のユーザーが見つかった場合に、どのユーザーをマージするかを指定する配列でなければならない。prioritization は順序付き配列である。つまり、優先順位付けから複数のユーザーがマッチした場合、マージは行われない。

配列に指定できる値は次のとおりです。

  • identified
  • unidentified
  • most_recently_updated (最新の更新されたユーザの優先順位付けを参照)
  • least_recently_updated (最新のユーザーの優先順位付けを参照)

優先配列には、一度に以下のオプションのうち1つしか存在できません。

  • identified を持つユーザーを優先することである。 external_id
  • unidentified のないユーザーを優先することである。 external_id

例のリクエスト

基本リクエスト

これはリクエストのパターンを示す基本的なリクエストボディである。

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

以下のリクエストは、電子メールアドレス “john.smith@braze.com” を持つ、直近に更新された未確認ユーザーを、external_id “john “を持つユーザーにマージします。most_recently_updated またはleast_recently_updated を使用すると、クエリは1 人の識別されていないユーザーにのみフィルタリングされます。そのため、このメールアドレスを持つ未確認のユーザーが2人いた場合、external_id “john “のユーザーにマージされるのは1人だけである。

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

この次の例は、電子メールアドレス “john.smith@braze.com” を持つ、最も最近更新された未確認ユーザーを、電子メールアドレス “john.smith@braze.com” を持つ、最も最近更新された識別されたユーザーにマージします。most_recently_updated またはleast_recently_updated を使用すると、クエリは1 人のユーザー(identifier_to_merge では1 人のユーザー、identifier_to_keep では1 人のユーザー) にのみフィルタリングされます。

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

メールアドレス”john.smith@braze.com”を持つ正体不明のユーザーが2人いる場合、このリクエスト例では、そのメールアドレスを持つ正体不明のユーザーが2人いるため、どのユーザーもマージしない。このリクエストは、メールアドレス”john.smith@braze.com”を持つ未確認ユーザーが1人しかいない場合にのみ機能する。

応答

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

成功応答の例

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

エラー応答例

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

トラブルシューティング

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

エラー トラブルシューティング
'merge_updates' must be an array of objects merge_updates がオブジェクトの配列であることを確認する。
a single request may not contain more than 50 merge updates 1回のリクエストで指定できるマージ更新は50件までです。
identifiers must be objects with an 'external_id' property that is a string, 'user_alias' property that is an object, 'email' property that is a string, or 'phone' property that is a string リクエストの識別子をチェックする。
'merge_updates' must only have 'identifier_to_merge' and 'identifier_to_keep' merge_updatesidentifier_to_mergeidentifier_to_keep という2つのオブジェクトしか含まれていないことを確認します。
「このページはどの程度役に立ちましたか?」
New Stuff!