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

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

重要

予期しない動作を避けるため、ユーザー属性オブジェクトごとに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 の例およびオブジェクト配列の 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キーページの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なし

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アプリはプッシュを表示するフレームワークが1つしかなく、Brazeが必要なプッシュトークンと証明書を持っている限りプッシュ通知はすぐにレンダリングされるため、これらのステップは必要ありません。

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

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

注

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

よくある質問

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

Brazeはダッシュボードに専用のスパムリストを提供していません。Brazeは500万回を超えるセッションを持つ個々のユーザー（「ダミーユーザー」）をブロックし、それらのSDKイベントの取り込みを停止します。識別子がブロックされている場合、/users/trackはエラー"provided external_id is blacklisted and disallowed"を返すことがあります。この文言はAPIレスポンスからそのまま引用されたものです。影響を受けるプロファイルを見つけるには、セッション数フィルターを5,000,000より多いに設定したセグメントを作成し、セグメントをCSVとしてエクスポートして、エンゲージメント > ユーザー検索または/users/export/idsエンドポイントでプロファイルフィールドを照合します。