カスタム属性の設定
Braze では、ユーザーに属性を割り当てるメソッドが提供されています。ダッシュボードでこれらの属性に基づき、ユーザーをフィルターおよびセグメント化できます。
実装前に、ベストプラクティスのカスタムイベント、カスタム属性、および購入イベントによって提供されるセグメンテーションオプションの例と、イベント命名規則のメモを必ず確認しておいてください。
デフォルトユーザー属性の割り当て
ユーザー属性を割り当てるには、共有 ABKUser
オブジェクトで適切なフィールドを設定する必要があります。
以下は名属性の設定例です。
1
| AppDelegate.braze?.user.set(firstName: "first_name")
|
1
| [AppDelegate.braze.user setFirstName:@"first_name"];
|
Braze.User
オブジェクトでは、以下の属性を設定する必要があります。
firstName
lastName
email
dateOfBirth
country
language
homeCity
phone
gender
カスタムユーザー属性の割り当て
Braze では、デフォルトユーザー属性以外にも、複数の異なるデータタイプを使用してカスタム属性を定義できます。これらの各属性で提供されるセグメンテーションオプションの詳細については、ユーザーデータ収集を参照してください。
文字列値のカスタム属性
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: "your_attribute_value")
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" stringValue:"your_attribute_value"];
|
整数値のカスタム属性
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourIntegerValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andIntegerValue:yourIntegerValue];
|
double 値のカスタム属性
Braze では、データベース内での float
値と double
値の扱いが同じです。
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourDoubleValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDoubleValue:yourDoubleValue];
|
ブール値のカスタム属性
1
| AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", value: yourBoolValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andBOOLValue:yourBOOLValue];
|
日付値のカスタム属性
1
| AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", dateValue:yourDateValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDateValue:yourDateValue];
|
配列値のカスタム属性
カスタム属性配列内の要素の最大数は、デフォルトで 25 に設定されています。要素の最大数を超える配列は、含まれる要素が最大数になるよう切り捨てられます。個々の配列の最大数は、100 まで増やすことができます。この最大数を増やす必要がある場合は、カスタマーサービスマネージャーに連絡してください。
1
2
3
4
5
6
| // Setting a custom attribute with an array value
AppDelegate.braze?.user.setCustomAttributeArray(key: "array_name", array: ["value1", "value2"])
// Adding to a custom attribute with an array value
AppDelegate.braze?.user.addToCustomAttributeArray(key: "array_name", value: "value3")
// Removing a value from an array type custom attribute
AppDelegate.braze?.user.removeFromCustomAttributeArray(key: "array_name", value: "value2")
|
1
2
3
4
5
6
7
8
| // Setting a custom attribute with an array value
[AppDelegate.braze.user setCustomAttributeArrayWithKey:@"array_name" array:@[@"value1", @"value2"]];
// Adding to a custom attribute with an array value
[AppDelegate.braze.user addToCustomAttributeArrayWithKey:@"array_name" value:@"value3"];
// Removing a value from an array type custom attribute
[AppDelegate.braze.user removeFromCustomAttributeArrayWithKey:@"array_name" value:@"value2"];
// Removing an entire array and key
[AppDelegate.braze.user setCustomAttributeArrayWithKey:@"array_name" array:nil];
|
カスタム属性の設定解除
カスタム属性は、次のメソッドを使用して設定を解除することもできます。
1
| AppDelegate.braze?.user.unsetCustomAttribute(key: "your_attribute_key")
|
1
| [AppDelegate.braze.user unsetCustomAttributeWithKey:@"your_attribute_key"];
|
カスタム属性のインクリメント / デクリメント
このコードは、インクリメントカスタム属性の例です。カスタム属性の値は、正または負の整数か、long 値でインクリメントできます。
1
| AppDelegate.braze?.user.incrementCustomUserAttribute(key: "your_attribute_key", by: incrementIntegerValue)
|
1
| [AppDelegate.braze.user incrementCustomUserAttribute:@"your_attribute_key" by:incrementIntegerValue];
|
REST API によるカスタム属性の設定
REST API を使用してユーザー属性を設定することもできます。詳細については、ユーザー API のドキュメントを参照してください。
カスタム属性値の制限
カスタム属性値の最大長は 255 文字です。これより長い値は切り捨てられます。
追加情報
ユーザーサブスクリプションの設定
ユーザーのサブスクリプション (メールまたはプッシュ) を設定するには、それぞれ関数 set(emailSubscriptionState:)
または set(pushNotificationSubscriptionState:)
を呼び出します。これらの関数では、いずれも引数として列挙型 Braze.User.SubscriptionState
が使用されます。この型には、次の 3 つの状態があります。
サブスクリプションのステータス |
定義 |
optedIn |
配信登録済み、かつ明示的にオプトイン済み |
subscribed |
購読済み、ただし明示的に選択されていない |
unsubscribed |
配信停止済みまたは明示的にオプトアウト済み、あるいはその両方 |
アプリにプッシュ通知の送信を許可するユーザーは、iOS で明示的なオプトインが必要であるため、ステータス optedIn
にデフォルト設定されます。
ユーザーは、有効なメールアドレスを取得すると自動的に subscribed
に設定されます。ただし、明示的なオプトインのプロセスを確立し、ユーザーから明示的な同意を得た時点でこの値を optedIn
に設定することをお勧めします。詳細については、「ユーザーサブスクリプションの管理」を参照してください。
メールサブスクリプションの設定
1
| AppDelegate.braze?.user.set(emailSubscriptionState: Braze.User.SubscriptionState)
|
1
| [AppDelegate.braze.user setEmailSubscriptionState: BRZUserSubscriptionState]
|
プッシュ通知サブスクリプションの設定
1
| AppDelegate.braze?.user.set(pushNotificationSubscriptionState: Braze.User.SubscriptionState)
|
1
| [AppDelegate.braze.user setPushNotificationSubscriptionState: BRZUserSubscriptionState]
|
詳細については、「ユーザーサブスクリプションの管理」を参照してください。