Skip to content

ユーザーを識別する

post

/users/identify

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

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

ユーザーを識別するには、external_idaliases_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の制限を参照してください。

Request body

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
}

リクエストパラメーター

パラメータ required データ型 説明
aliases_to_identify required オブジェクトを識別するためのエイリアスの配列 エイリアスを参照してオブジェクトを識別するおよびユーザーエイリアスオブジェクトを参照してください。
merge_behavior オプション string none または merge のいずれかが必要です。

Merge_behavior フィールド

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

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

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

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

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

フィールドをnoneに設定しても、ユーザーデータは識別されたユーザープロファイルにマージされません。

メールによるユーザーの識別

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

配列に使用できる値は、identifiedunidentifiedmost_recently_updated です。most_recently_updated は、最も最近更新されたユーザーを優先することを意味します。

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

  • identifiedexternal_id を持つユーザーを優先することを指します
  • unidentifiedexternal_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"
}
「このページはどの程度役に立ちましたか?」
New Stuff!