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

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

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

オブジェクト本体

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  // One of "external_id" or "user_alias" or "braze_id" or "email" 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,
  // Setting this flag to true will put 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" : "bob@example.com",
  // 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" ]},
}

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

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

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

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

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

プッシュトークンをBrazeにインポートする前に、必要があるかどうかをダブルチェックします。Braze SDK を配置すると、API 経由でアップロードする必要がなく、プッシュトークンを自動的に処理します。

API 経由でアップロードする必要がある場合は、特定のユーザーまたは匿名ユーザーにアップロードできます。これは、external_id を指定する必要があるか、匿名ユーザがpush_token_import フラグをtrue に設定する必要があることを意味します。

push_token_import をtrue と指定した場合:

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

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

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

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

カスタム属性データ型

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

カスタムイベントとカスタム属性を使用する場合の詳細については、カスタムイベントおよびカスタム属性のそれぞれのドキュメントを参照してください。

ユーザープロファイルフィールドをろう付けする

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

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

この例には、API 呼び出しごとに許可された75 リクエストの2 つのユーザー属性オブジェクトが含まれています。

```json POST https://YOUR_REST_API_URL/users/track Content-Type: application/json 許可:貴社-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”}]

1
2
3
4
5
6
7
8
9
10
},
{
  "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"}]
}

} ```