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

属性オブジェクトにフィールドを含む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" : "Jon",
  "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 (REST API syntax)
  "my_array_of_objects_attribute": { "add": [{"key": "value"}] },
  // Removing from an array of objects (REST API syntax)
  "my_array_of_objects_attribute": { "remove": [{"$identifier_key": "key", "$identifier_value": "value"}] },
}

• 外部ユーザーID
• ユーザーのエイリアス

注

/users/trackへのREST APIリクエストでは、配列操作にadd、remove、updateキーを使用します。$プレフィックス付きのキー（$addなど）はSDKメソッドのペイロード用です。

REST APIリクエストで$add、$remove、$updateを使用した場合、Brazeは配列の更新を適用せずにsuccessを返すことがあります。

詳細については、オブジェクトの配列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を使用します。つまり、電話番号が別のプロファイルに属している場合でも、属性はそのメールアドレスに関連付けられたユーザープロファイルに適用されます。

重要

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

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

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の例については、オブジェクトの配列APIの例を参照してください。$add、$remove、$updateを使用したSDKの例については、オブジェクトの配列SDKの例を参照してください。

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

重要

次のユーザープロファイルフィールドは大文字と小文字を区別するため、これらのフィールドを小文字で参照するようにしてください。

ヒント

カテゴリ別に整理された標準属性のリファレンス（SDK、API、CSV、クラウドデータ取り込みのガイダンスを含む）については、標準属性を参照してください。

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

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

この例には、API呼び出しあたり合計75個の許可された属性オブジェクトのうち、4個のユーザー属性オブジェクトが含まれています。

POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "attributes" : [
    {
      "external_id" : "user1",
      "first_name" : "Jon",
      "has_profile_picture" : true,
      "dob": "1988-02-14",
      "music_videos_favorited" : { "add" : [ "calvinharris-summer" ], "remove" : ["nickiminaj-anaconda"] }
    },
    {
      "external_id" : "user2",
      "first_name" : "Jill",
      "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" : "Alice",
      "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キーページのIdentificationセクションで確認できます。必ず正しいプラットフォームの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がない場合

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"}
      ]
    }
  ]
}'

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"}
      ]
    }
  ]
}'

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

重要

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

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

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

注

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