Skip to content

標準属性項目

標準属性項目は、Brazeがすべてのユーザープロファイルで認識する定義済みのフィールドです。このページでは、各標準属性項目のフィールド名、データタイプ、想定されるフォーマットをクイックリファレンスとして確認できます。

標準属性項目(デフォルト属性予約キーとも呼ばれます)は、ビジネス固有のカスタム属性とは異なります。このページに記載されているフィールド名でBrazeにデータを送信すると、Brazeは新しいカスタム属性を作成する代わりに、定義済みのプロファイルフィールドにデータを保存します。

標準属性項目は、以下のいずれかの方法で設定できます。

識別子

識別子は、どのユーザープロファイルを更新または作成するかをBrazeに伝えます。すべてのAPIリクエストとCSV行には、少なくとも1つの識別子を含める必要があります。適切な識別子の選び方について詳しくは、識別子の解決を参照してください。

プロファイルフィールド

これらのフィールドは、ユーザーのデモグラフィック、連絡先、ロケールデータをキャプチャします。

これらのフィールドは、ユーザーが各チャネルでメッセージを受信する方法を管理します。これらを更新しても、データポイント使用量にはカウントされません。

購読グループの設定の詳細については、購読グループを参照してください。

セッションとエンゲージメント

これらのフィールドは、ユーザーが最初または最後にアプリを使用した日時を記録します。SDKはこれらを自動的に記録します。通常、別のプラットフォームから移行する場合にのみ、APIまたはCSVで設定します。

プッシュトークン

これらのフィールドは、別のプラットフォームからプッシュトークンを移行する際に使用します。Braze SDKを統合すると、プッシュトークンは自動的に取得されます。移行のガイダンスについては、プッシュトークンの移行を参照してください。

ソーシャルプロファイル

これらのフィールドには、ソーシャルネットワーク連携からのデータが格納されます。

APIの例

以下のリクエストは、/users/track エンドポイントを通じて2人のユーザーに標準属性を設定します。

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
31
32
33
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",
      "last_name": "Doe",
      "email": "[email protected]",
      "country": "US",
      "language": "en",
      "time_zone": "America/New_York",
      "dob": "1988-02-14",
      "email_subscribe": "opted_in"
    },
    {
      "external_id": "user2",
      "first_name": "Alex",
      "phone": "+14155552671",
      "current_location": {
        "longitude": -73.991443,
        "latitude": 40.753824
      },
      "subscription_groups": [
        {
          "subscription_group_id": "abc-123",
          "subscription_state": "subscribed"
        }
      ]
    }
  ]
}

完全なAPIコントラクトについては、ユーザー属性オブジェクトを参照してください。

CSVの例

以下のCSVは、2人のユーザーの標準属性項目を更新します。列ヘッダーは、この記事のフィールド名と正確に一致する必要があります。一致しないヘッダー(例えば、first_name の代わりに First_name)はカスタム属性としてインポートされます。

1
2
3
external_id,first_name,last_name,email,country,language,dob,email_subscribe
user1,Jane,Doe,[email protected],US,en,1988-02-14,opted_in
user2,Alex,Smith,[email protected],GB,en,1992-09-30,subscribed

一部の標準属性項目はCSVインポートでは設定できません。配列、プッシュトークン、ネストされたオブジェクトは、APIまたはCloud Data Ingestionを通じて送信する必要があります。CSVでサポートされるフィールドの完全なリストとインポート手順については、デフォルト属性を参照してください。

考慮事項

標準属性を使用する際は、以下の点を考慮してください。

  • フィールド名は大文字と小文字が区別されます。常に小文字を使用してください。標準属性名と完全に一致しないヘッダーやキーは、カスタム属性として扱われます。
  • APIまたはCSVで値を設定すると、SDKの自動キャプチャが抑制されます。APIまたはCSVを通じてcountrylanguageを設定すると、BrazeはそのユーザーについてSDKからのこれらのフィールドの自動キャプチャを停止します。
  • nullは値を削除します。標準属性をnullに設定すると、プロファイルから削除されます。external_iduser_aliasなど、一部のフィールドは設定後に削除できません。
  • CSVの空白値は上書きしません。CSVインポートの空白セルは、プロファイルの既存の値を保持します。値をクリアするには、APIを使用してください。
  • タイムゾーンのデフォルトはUTCです。オフセットのない日付文字列はUTCの午前0時として解釈され、ワークスペースのタイムゾーンで表示されます。タイムゾーンを指定するには、UTCオフセットを追加してください(例:2024-11-10T18:00:00-05:00)。
New Stuff!