ユーザー属性オブジェクト

属性オブジェクトにフィールドを含むAPIリクエストは、指定されたユーザープロファイルに指定された値で、その名前の属性を作成または更新します。

Brazeユーザープロファイルフィールド名（以下にリストされているもの、またはBrazeユーザープロファイルフィールドのセクションにリストされているもの）を使用して、ダッシュボードのユーザープロファイル上の特別な値を更新するか、独自のカスタム属性データをユーザーに追加します。

オブジェクト本体

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
{
  // One of "external_id" or "user_alias" or "braze_id" or "email" or "phone" is required
  "external_id" : (optional, string) see external user ID,
  "user_alias" : (optional, User alias object),
  "braze_id" : (optional, string) Braze user identifier,
  "email": (optional, string) User email address,
  "phone": (optional, string) User phone number,
  // Setting this flag to true puts the API in "Update Only" mode.
  // When using a "user_alias", "Update Only" defaults to true.
  "_update_existing_only" : (optional, boolean),
  // See note regarding anonymous push token imports
  "push_token_import" : (optional, boolean),
  // Braze User Profile Fields
  "first_name" : "Alex",
  "email" : "[email protected]",
  // Custom Attributes
  "my_custom_attribute" : value,
  "my_custom_attribute_2" : {"inc" : int_value},
  "my_array_custom_attribute":[ "Value1", "Value2" ],
  // Adding a new value to an array custom attribute
  "my_array_custom_attribute" : { "add" : ["Value3"] },
  // Removing a value from an array custom attribute
  "my_array_custom_attribute" : { "remove" : [ "Value1" ]},
  // Array of objects custom attribute
  "my_array_of_objects_attribute": [{"key": "value"}, {"key": "value"}],
  // Adding to an array of objects (nested custom attribute syntax)
  "my_array_of_objects_attribute": { "$add": [{"key": "value"}] },
  // Removing from an array of objects (nested custom attribute syntax)
  "my_array_of_objects_attribute": { "$remove": [{"$identifier_key": "key", "$identifier_value": "value"}] },
}

• External user ID
• ユーザーエイリアス

注

通常の配列カスタム属性には、add と remove（$ なし）を使用します。

オブジェクト配列（階層化カスタム属性）には、/users/track リクエストペイロードで $add、$remove、$update を使用します。これらの演算子は、識別子（$identifier_key と $identifier_value）によるマッチングでオブジェクトレベルの変更を適用し、$new_object を使用したインプレース更新もサポートします。

このフォーマットは、配列の残りの状態を保持しながら、既存の配列内のオブジェクトを追加、削除、または更新する必要がある場合に使用します。リクエストの完全な例については、オブジェクト配列の API の例とオブジェクト配列のSDKの例を参照してください。

プロファイル属性を削除するには、null に設定します。external_id や user_alias などの一部のフィールドは、ユーザープロファイルに追加された後は削除できません。

識別子の解決

匿名プッシュトークンのインポートを行う場合を除き、各ユーザー属性オブジェクトには少なくとも1つの識別子（external_id、user_alias、braze_id、email、phone）を含める必要があります。可能な場合は、どのユーザープロファイルが更新または作成されるかの曖昧さを避けるため、オブジェクトごとに識別子を1つだけ含めてください。

識別子を使用する際は、以下の点に注意してください。

• external_id と user_alias は相互排他的です。 同一のユーザー属性オブジェクトに両方を含めるとエラーが返されます。すでに external_id を持つユーザーにエイリアスを追加するには、/users/alias/new エンドポイントを使用してください。
• email は phone よりも優先されます。 同一オブジェクトに email と phone の両方が含まれている場合、Brazeは email を識別子として使用します。つまり、電話番号が別のプロファイルに属している場合でも、属性はそのメールアドレスに関連付けられたユーザープロファイルに適用されます。

重要

予期しない動作を避けるため、ユーザー属性オブジェクトごとに単一の識別子を使用してください。異なるユーザープロファイルを参照する複数の識別子を提供すると、属性が間違ったプロファイルに適用される可能性があります。

既存プロファイルのみ更新する

Brazeで既存のユーザープロファイルのみを更新したい場合は、リクエストの本文で _update_existing_only キーに true の値を渡す必要があります。この値が省略されると、external_id がまだ存在しない場合、Brazeは新しいユーザープロファイルを作成します。

注

/users/track エンドポイントを介してエイリアスのみのユーザープロファイルを作成する場合は、_update_existing_only を false に設定する必要があります。この値を省略すると、Brazeはエイリアスのみのプロファイルを作成しません。

プッシュトークンのインポート

プッシュトークンをBrazeにインポートする前に、それが必要かどうかを再確認してください。Braze SDKを導入すると、APIを通じてアップロードする必要なく、プッシュトークンを自動的に処理します。

APIを通じてアップロードする必要がある場合、識別済みのユーザーまたは匿名ユーザーのいずれかに対してアップロードできます。これは、external_id が存在するか、匿名ユーザーの push_token_import フラグが true に設定されている必要があることを意味します。

注

他のシステムからプッシュトークンをインポートする場合、external_id が常に利用可能とは限りません。Brazeへの移行期間中にこれらのユーザーとの通信を維持するには、push_token_import を true に指定することで、external_id を提供せずに匿名ユーザー用のレガシートークンをインポートできます。

push_token_import を true に指定する場合：

• external_id と braze_id は指定しないでください
• 属性オブジェクトにはプッシュトークンを含める必要があります
• トークンがすでにBrazeに存在する場合、リクエストは無視されます。存在しない場合、Brazeはトークンごとに一時的な匿名ユーザープロファイルを作成し、これらの個人に引き続きメッセージを送信できるようにします

インポート後、各ユーザーがBraze対応バージョンのアプリを起動すると、BrazeはインポートされたプッシュトークンをユーザーのBrazeユーザープロファイルに自動的に移動し、一時プロファイルをクリーンアップします。

Brazeは月に1回チェックを行い、push_token_import フラグが設定されているがプッシュトークンを持たない匿名プロファイルを検索します。匿名プロファイルにプッシュトークンがなくなった場合、Brazeはそのプロファイルを削除します。ただし、匿名プロファイルにまだプッシュトークンがある場合（実際のユーザーがそのプッシュトークンを持つデバイスでまだログインしていないことを示しています）、Brazeは何も行いません。

詳細については、プッシュトークンの移行を参照してください。

カスタム属性のデータ型

以下のデータ型をカスタム属性として保存できます。

ヒント

カスタムイベントとカスタム属性のどちらを使用すべきかについてのガイダンスは、カスタムイベントとカスタム属性を参照してください。

オブジェクト配列の例

このオブジェクト配列を使用すると、宿泊内の特定の条件に基づいてセグメントを作成し、Liquid テンプレートを使用して各宿泊のデータでメッセージをパーソナライズできます。

1
2
3
4
{"hotel_stays": [
  { "hotel_name": "Ocean View Resort", "check_in_date": "2023-06-15", "nights_stayed": 5 },
  { "hotel_name": "Mountain Lodge", "check_in_date": "2023-09-10", "nights_stayed": 3 }
]}

$add、$remove、$update を使用したオブジェクト配列の例については、オブジェクト配列の API の例とオブジェクト配列のSDKの例を参照してください。

Brazeユーザープロファイルフィールド

重要

以下のユーザープロファイルフィールドは大文字と小文字を区別するため、必ず小文字で参照してください。

ヒント

カテゴリ別に整理され、SDK、API、CSV、Cloud Data Ingestion のガイダンスを含む顧客向けの標準属性リファレンスについては、標準属性を参照してください。

このAPIを通じて明示的に設定された言語値は、Brazeがデバイスから自動的に受信するロケール情報よりも優先されます。

ユーザー属性のリクエスト例

この例には、API 呼び出しごとに許可される最大75個の属性オブジェクトのうち、4つのユーザー属性オブジェクトが含まれています。

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
POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "attributes" : [
    {
      "external_id" : "user1",
      "first_name" : "Alex",
      "has_profile_picture" : true,
      "dob": "1988-02-14",
      "music_videos_favorited" : { "add" : [ "calvinharris-summer" ], "remove" : ["nickiminaj-anaconda"] }
    },
    {
      "external_id" : "user2",
      "first_name" : "Lee",
      "has_profile_picture" : false,
      "push_tokens": [{"app_id": "Your App Identifier", "token": "abcd", "device_id": "optional_field_value"}]

    },
    {
      "user_alias" : { "alias_name" : "device123", "alias_label" : "my_device_identifier"},
      "first_name" : "Yuri",
      "has_profile_picture" : false
    },
    {
      "external_id": "user3",
      "subscription_groups" : [{"subscription_group_id" : "subscription_group_identifier", "subscription_state" : "subscribed"}]
    }
  ]
}

プッシュトークンの移行

Braze統合前にプッシュ通知を送信していた場合（自社で送信していた場合や他のプロバイダーを利用していた場合）、プッシュトークンの移行を行うことで、登録済みのプッシュトークンを持つユーザーに引き続きプッシュ通知を送信できます。

SDKによる自動移行

Braze SDKを統合すると、オプトイン済みユーザーのプッシュトークンは次回アプリを開いた際に自動的に移行されます。それまでは、Brazeを通じてこれらのユーザーにプッシュ通知を送信することはできません。

あるいは、プッシュトークンを手動で移行することで、ユーザーにより迅速にリエンゲージメントできます。

Webトークンに関する考慮事項

Webプッシュトークンの特性上、Webプッシュを実装する際は以下の点を考慮してください。

APIによる手動移行

プッシュトークンの手動移行とは、過去に作成されたキーをAPIを通じてBrazeプラットフォームにインポートするプロセスです。

users/trackエンドポイントを使用して、iOS（APNs）およびAndroid（FCM）トークンをプログラムでプラットフォームに移行できます。識別済みユーザー（external IDが関連付けられているユーザー）と匿名ユーザー（external IDのないユーザー）の両方を移行できます。

プッシュトークン移行時にアプリのapp_idを指定して、適切なプッシュトークンを適切なアプリに関連付けます。各アプリ（iOS、Androidなど）には固有のapp_idがあり、APIキーページの識別セクションで確認できます。正しいプラットフォームのapp_idを使用してください。

重要

APIを通じてWebプッシュトークンを移行することはできません。Webプッシュトークンは他のプラットフォームと同じスキーマに準拠していないためです。

Webプッシュトークンをプログラムで移行しようとすると、次のようなエラーが表示される場合があります：Received '400: Invalid subscription auth' sending to 'https://fcm.googleapis.com/fcm/send

APIの移行の代替として、SDKを統合してトークンベースを自然に再構築することをお勧めします。

• external idあり
• external idなし

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/track' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "attributes" : [
    {
      "push_token_import" : false,
      "external_id": "example_external_id",
      "country": "US",
      "language": "en",
      "YOUR_CUSTOM_ATTRIBUTE": "YOUR_VALUE",
      "push_tokens": [
        {"app_id": "APP_ID_OF_OS", "token": "PUSH_TOKEN_STRING"}
      ]
    }
  ]
}'

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
curl --location --request POST 'https://rest.iad-01.braze.com/users/track' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "attributes": [
    {
      "push_token_import" : true,
      "email": "[email protected]",
      "country": "US",
      "language": "en",
      "YOUR_CUSTOM_ATTRIBUTE": "YOUR_VALUE",
      "push_tokens": [
        {"app_id": "APP_ID_OF_OS", "token": "PUSH_TOKEN_STRING", "device_id": "DEVICE_ID"}
      ]
    },

    {
      "push_token_import" : true,
      "email": "[email protected]",
      "country": "US",
      "language": "en",
      "YOUR_CUSTOM_ATTRIBUTE_1": "YOUR_VALUE",
      "YOUR_CUSTOM_ATTRIBUTE_2": "YOUR_VALUE",
      "push_tokens": [
        {"app_id": "APP_ID_OF_OS", "token": "PUSH_TOKEN_STRING", "device_id": "DEVICE_ID"}
      ]
    }
  ]
}'

iOSプッシュトークンのインポート

/users/trackでiOSプッシュトークンを移行する場合、プッシュトークンにgatewayフィールドは設定されません。Brazeは、APIを通じてインポートされたトークンを有効なフォアグラウンドプッシュトークンとみなしますが、そのトークンがどのAPNs環境に属するかは判断できません。

gatewayフィールドがない場合、Brazeはプッシュ通知を送信する際にアプリの設定済みフォールバック環境設定を使用します。トークンの実際の環境が設定済みフォールバックと異なる場合、BadDeviceTokenエラーが発生する可能性があります。例えば、開発用トークンが本番用ゲートウェイを通じて送信された場合、失敗します。

配信の問題を避けるために：

• Brazeダッシュボードのアプリ環境設定が、インポートするトークンと一致していることを確認してください。
• 本番アプリの場合、本番用トークンのみをインポートしてください。
• テスト環境の場合、アプリの構成とインポートするトークンの両方が開発環境を使用していることを確認してください。

注

Braze SDKを通じて登録されたトークンには、SDKがアプリのエンタイトルメントから環境を検出するため、gatewayフィールドが自動的に含まれます。

Androidプッシュトークンのインポート

重要

以下の考慮事項はAndroidアプリにのみ適用されます。iOSアプリではこれらのステップは不要です。iOSにはプッシュを表示するフレームワークが1つしかなく、Brazeが必要なプッシュトークンと証明書を持っている限り、プッシュ通知はすぐにレンダリングされるためです。

Braze SDKの統合が完了する前にユーザーにAndroidプッシュ通知を送信する必要がある場合は、キーと値のペアを使用してプッシュ通知を検証します。

プッシュペイロードを処理および表示するレシーバーが必要です。プッシュペイロードをレシーバーに通知するには、プッシュキャンペーンに必要なキーと値のペアを追加します。これらのペアの値は、Braze以前に使用していた特定のプッシュパートナーによって異なります。

注

一部のプッシュ通知プロバイダーでは、Brazeがキーと値のペアを適切に解釈できるようにフラット化する必要があります。特定のAndroidアプリのキーと値のペアをフラット化するには、カスタマーサクセスマネージャーにお問い合わせください。

よくある質問

スパムとして扱われているユーザーやメッセージングからブロックされているユーザーを見つけるにはどうすればよいですか？

Brazeはダッシュボードに専用のスパムリストを提供していません。Brazeは、500万を超えるセッション、20,000を超える個別のカスタムイベント名、または購入における20,000を超える個別の製品名を持つ個々のユーザープロファイル（「ダミーユーザー」）をブロックし、SDKとREST APIの両方からそのプロファイルのすべての受信データの取り込みを停止します。識別子がブロックされている場合、/users/trackはエラー"provided external_id is blacklisted and disallowed"を返すことがあります。この文言はAPIレスポンスからそのまま引用されたものです。過剰なセッションによりブロックされたプロファイルを見つけるには、セッション数フィルターを5,000,000より多いに設定したセグメントを作成し、セグメントをCSVとしてエクスポートして、エンゲージメント > ユーザー検索またはは/users/export/idsエンドポイントでプロファイルフィールドを照合します。個別のカスタムイベント名や製品名に対する同等のフィルターはないため、それらの理由でブロックされたプロファイルを特定するには、Brazeアカウントマネージャーにお問い合わせください。詳細については、スパムブロックを参照してください。