前提条件
この機能を使用する前に、Android Braze SDKを統合する必要があります。
デフォルトのユーザー属性
ユーザーにデフォルト属性を設定するには、BrazeインスタンスでgetCurrentUser()
メソッドを呼び出し、アプリの現在のユーザーへの参照を取得する。そして、ユーザー属性を設定するメソッドを呼び出すことができる。
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setFirstName("first_name");
}
}
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setFirstName("first_name")
}
|
Brazeは、BrazeUser クラス内で以下のユーザー属性を設定するための定義済みメソッドを提供しています。メソッドの仕様については、KDocを参照のこと。
- 名
- 姓
- 国
- 言語
- 生年月日
- メールアドレス
- 性別
- 市区町村
- 電話番号
note:
姓、名、国、市区町村などの文字列値はすべて255文字に制限されています。
カスタムユーザー属性
デフォルトのユーザー属性に加え、Brazeではいくつかのデータタイプを使用してカスタム属性を定義することができる。各属性のセグメンテーションオプションの詳細については、ユーザーデータ収集を参照のこと。
カスタム属性の設定
string
、カスタム属性を設定する:
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value");
}
}
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value")
}
|
int
、カスタム属性を設定する:
1
2
3
4
5
6
7
8
9
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_INT_VALUE);
// Integer attributes may also be incremented using code like the following:
brazeUser.incrementCustomUserAttribute("your_attribute_key", YOUR_INCREMENT_VALUE);
}
}
|
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_INT_VALUE)
// Integer attributes may also be incremented using code like the following:
brazeUser.incrementCustomUserAttribute("your_attribute_key", YOUR_INCREMENT_VALUE)
}
|
long
、整数値でカスタム属性を設定する:
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE)
}
|
float
、カスタム属性を設定する:
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE)
}
|
double
、カスタム属性を設定する:
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE)
}
|
boolean
、カスタム属性を設定する:
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE)
}
|
1
2
3
4
5
6
7
8
9
10
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DATE_VALUE);
// This method will assign the current time to a custom attribute at the time the method is called:
brazeUser.setCustomUserAttributeToNow("your_attribute_key");
// This method will assign the date specified by SECONDS_FROM_EPOCH to a custom attribute:
brazeUser.setCustomUserAttributeToSecondsFromEpoch("your_attribute_key", SECONDS_FROM_EPOCH);
}
});
|
1
2
3
4
5
6
7
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DATE_VALUE)
// This method will assign the current time to a custom attribute at the time the method is called:
brazeUser.setCustomUserAttributeToNow("your_attribute_key")
// This method will assign the date specified by SECONDS_FROM_EPOCH to a custom attribute:
brazeUser.setCustomUserAttributeToSecondsFromEpoch("your_attribute_key", SECONDS_FROM_EPOCH)
}
|
warning:
この方法でBrazeに渡される日付は、ISO 8601形式(e.g 2013-07-16T19:20:30+01:00
)またはyyyy-MM-dd'T'HH:mm:ss:SSSZ
形式(e.g 2016-12-14T13:32:31.601-0800
)のいずれかでなければなりません。
カスタム属性配列内の要素の最大数は、25にデフォルト設定されています。個々の配列の最大値は、Braze ダッシュボードの [データ設定] > [カスタム属性] で100まで増やすことができます。要素の最大数を超える配列は、含まれる要素が最大数になるよう切り捨てられます。カスタム属性配列とその動作の詳細については、配列に関するドキュメントを参照してください。
1
2
3
4
5
6
7
8
9
10
11
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
// Setting a custom attribute with an array value
brazeUser.setCustomAttributeArray("your_attribute_key", testSetArray);
// Adding to a custom attribute with an array value
brazeUser.addToCustomAttributeArray("your_attribute_key", "value_to_add");
// Removing a value from an array type custom attribute
brazeUser.removeFromCustomAttributeArray("your_attribute_key", "value_to_remove");
}
});
|
1
2
3
4
5
6
7
8
| Braze.getInstance(context).getCurrentUser { brazeUser ->
// Setting a custom attribute with an array value
brazeUser.setCustomAttributeArray("your_attribute_key", testSetArray)
// Adding to a custom attribute with an array value
brazeUser.addToCustomAttributeArray("your_attribute_key", "value_to_add")
// Removing a value from an array type custom attribute
brazeUser.removeFromCustomAttributeArray("your_attribute_key", "value_to_remove")
}
|
カスタム属性の設定解除
カスタム属性は、次のメソッドを使用して設定を解除することもできます。
REST APIを使う
また、REST APIを使用して、ユーザー属性を設定または解除することもできる。詳しくはユーザーデータエンドポイントを参照のこと。
ユーザーサブスクリプションの設定
ユーザーのサブスクリプション (メールまたはプッシュ) を設定するには、それぞれ関数 setEmailNotificationSubscriptionType()
または setPushNotificationSubscriptionType()
を呼び出します。これらの関数では、いずれも引数として列挙型 NotificationSubscriptionType
が使用されます。この型には、次の 3 つの状態があります。
サブスクリプションステータス |
定義 |
OPTED_IN |
配信登録済み、かつ明示的にオプトイン済み |
SUBSCRIBED |
購読済み、ただし明示的に選択されていない |
UNSUBSCRIBED |
配信停止済みまたは明示的にオプトアウト済み、あるいはその両方 |
important:
Android では、ユーザーにプッシュ通知を送る際に明示的なオプトインは必要ありません。ユーザーがプッシュ登録されると、デフォルトでOPTED_IN
ではなくSUBSCRIBED
に設定されます。サブスクリプションと明示的オプトインの実装の詳細については、ユーザーサブスクリプションの管理を参照してください。
メールサブスクリプションの設定
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType)
}
|
プッシュ通知サブスクリプションの設定
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType)
}
|
前提条件
この機能を使用する前に、Swift Braze SDKを統合する必要があります。
Default user attributes
To set user attributes, you need to set the appropriate field on the shared ABKUser
object. The following is an example of setting the first name attribute:
1
| AppDelegate.braze?.user.set(firstName: "Alex")
|
1
| [AppDelegate.braze.user setFirstName:@"Alex"];
|
The following attributes should be set on the Braze.User
object:
firstName
lastName
email
dateOfBirth
country
language
homeCity
phone
gender
Custom user attributes
In addition to the default user attributes, Braze also allows you to define custom attributes using several different data types. For more information on each attribute’s segmentation option, see User data collection.
important:
Custom attribute values have a maximum length of 255 characters; longer values will be truncated. For more information, refer to Braze.User
.
Setting custom attributes
To set a custom attribute with a string
value:
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"];
|
To set a custom attribute with an integer
value:
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourIntegerValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andIntegerValue:yourIntegerValue];
|
Braze treats float
and double
values the same within our database. To set a custom attribute with a double value:
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourDoubleValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDoubleValue:yourDoubleValue];
|
To set a custom attribute with a boolean
value:
1
| AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", value: yourBoolValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andBOOLValue:yourBOOLValue];
|
To set a custom attribute with a date
value:
1
| AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", dateValue:yourDateValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDateValue:yourDateValue];
|
The maximum number of elements in custom attribute arrays defaults to 25. Arrays exceeding the maximum number of elements will be truncated to contain the maximum number of elements. The maximum for individual arrays can be increased to up to 100. If you would like this maximum increased, reach out to your customer service manager.
To set a custom attribute with an array
value:
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];
|
Incrementing or decrementing custom attributes
This code is an example of an incrementing custom attribute. You may increment the value of a custom attribute by any integer
or long
value:
1
| AppDelegate.braze?.user.incrementCustomUserAttribute(key: "your_attribute_key", by: incrementIntegerValue)
|
1
| [AppDelegate.braze.user incrementCustomUserAttribute:@"your_attribute_key" by:incrementIntegerValue];
|
Unsetting a custom attribute
Custom attributes can also be unset using the following method:
1
| AppDelegate.braze?.user.unsetCustomAttribute(key: "your_attribute_key")
|
1
| [AppDelegate.braze.user unsetCustomAttributeWithKey:@"your_attribute_key"];
|
Using the REST API
You can also use our REST API to set or unset user attributes. For more information, refer to User Data Endpoints.
Setting user subscriptions
To set up a subscription for your users (either email or push), call the functions set(emailSubscriptionState:)
or set(pushNotificationSubscriptionState:)
, respectively. Both of these functions take the enum type Braze.User.SubscriptionState
as arguments. This type has three different states:
Subscription Status |
Definition |
optedIn |
Subscribed, and explicitly opted in |
subscribed |
Subscribed, but not explicitly opted in |
unsubscribed |
Unsubscribed and/or explicitly opted out |
Users who grant permission for an app to send them push notifications default to the status of optedIn
as iOS requires an explicit opt-in.
Users will be set to subscribed
automatically upon receipt of a valid email address; however, we suggest that you establish an explicit opt-in process and set this value to optedIn
upon receipt of explicit consent from your user. Refer to Managing user subscriptions for more details.
Setting email subscriptions
1
| AppDelegate.braze?.user.set(emailSubscriptionState: Braze.User.SubscriptionState)
|
1
| [AppDelegate.braze.user setEmailSubscriptionState: BRZUserSubscriptionState]
|
Setting push notification subscriptions
1
| AppDelegate.braze?.user.set(pushNotificationSubscriptionState: Braze.User.SubscriptionState)
|
1
| [AppDelegate.braze.user setPushNotificationSubscriptionState: BRZUserSubscriptionState]
|
Refer to Managing user subscriptions for more details.
Prerequisites
Before you can use this feature, you’ll need to integrate the Web Braze SDK.
デフォルトのユーザー属性
ユーザーのデフォルト属性を設定するには、Braze インスタンスでgetCurrentUser()
メソッドを呼び出して、アプリの現在のユーザーへの参照を取得します。次に、メソッドを呼び出してユーザー属性を設定できます。
1
| braze.getUser().setFirstName("SomeFirstName");
|
1
| braze.getUser().setGender(braze.User.Genders.FEMALE);
|
1
| braze.getUser().setDateOfBirth(2000, 12, 25);
|
Google Tag Manager を使用して、標準ユーザー属性(ユーザーのファーストネームなど) をカスタムユーザー属性と同じ方法でログに記録する必要があります。標準属性項目に渡す値が、[ユーザークラス] のドキュメントで指定されている予期される形式と一致していることを確認します。
たとえば、性別属性は、値として次のいずれかを使用できます。"m" | "f" | "o" | "u" | "n" | "p"
したがって、ユーザーの性別を女性に設定するには、次の内容のカスタムHTML タグを作成します。
1
2
3
| <script>
window.braze.getUser().setGender("f")
</script>
|
Brazeは、User
クラス内で次のユーザー属性を設定するための定義済みメソッドを提供します:
- 名
- 姓
- 言語
- 国
- 生年月日
- メールアドレス
- 性別
- 市区町村
- 電話番号
カスタムユーザー属性
デフォルトのユーザー属性メソッドに加えて、ユーザーにカスタム属性を設定することもできます。完全なメソッド指定については、JSDocsを参照してください。
string
値を使用してカスタム属性を設定するには:
1
2
3
4
| braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
YOUR_STRING_VALUE
);
|
integer
値を使用してカスタム属性を設定するには:
1
2
3
4
5
6
7
8
9
10
| braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
YOUR_INT_VALUE
);
// Integer attributes may also be incremented using code like the following
braze.getUser().incrementCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
THE_INTEGER_VALUE_BY_WHICH_YOU_WANT_TO_INCREMENT_THE_ATTRIBUTE
);
|
date
値を使用してカスタム属性を設定するには:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
YOUR_DATE_VALUE
);
// This method will assign the current time to a custom attribute at the time the method is called
braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
new Date()
);
// This method will assign the date specified by secondsFromEpoch to a custom attribute
braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
new Date(secondsFromEpoch * 1000)
);
|
カスタム属性配列には最大25 個の要素を含めることができます。データ型に対して手動で設定された(自動的に検出されない)個々のアレイは、データ設定> カスタム属性の下のBrazeダッシュボードで100まで増加できます。この最大値を増やす場合は、Braze アカウントマネージャにお問い合わせください。
配列 が要素数の最大値を超える場合、要素数の最大値に切り詰められます。
array
値を使用してカスタム属性を設定するには:
1
2
3
4
5
6
7
| braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, YOUR_ARRAY_OF_STRINGS);
// Adding a new element to a custom attribute with an array value
braze.getUser().addToCustomAttributeArray(YOUR_ATTRIBUTE_KEY_STRING, "new string");
// Removing an element from a custom attribute with an array value
braze.getUser().removeFromCustomAttributeArray(YOUR_ATTRIBUTE_KEY_STRING, "value to be removed");
|
important:
このメソッドでBrazeに渡される日付は、JavaScriptのDateオブジェクトでなければなりません。
important:
カスタム属性のキーと値には、最大 255 文字しか使用できません。有効なカスタム属性値の詳細については、リファレンスドキュメントを参照してください。
Googleタグマネージャのスクリプト言語が制限されているため、カスタムユーザー 属性は使用できません。カスタム属性s を記録するには、次の内容でカスタムHTML タグを作成します。
1
2
3
4
5
| <script>
// Note: If using SDK version 3.x or below, use `window.appboy` instead of `window.braze`
// Version 4 or greater should use `window.braze`
window.braze.getUser().setCustomUserAttribute("attribute name", "attribute value");
</script>
|
important:
GTM テンプレートでは、イベントまたは購買のネストされたプロパティは使用できません。前述のHTMLを使用して、ネストされたプロパティーを必要とするすべての行動または購入を記録できます。
カスタム属性の設定解除
カスタム属性は、その値を null
に設定することで設定解除できます。
1
| braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, null);
|
REST API の使用
REST API を使用して、ユーザー属性を設定または設定解除することもできます。詳細については、User Data Endpointsを参照してください。
ユーザーサブスクリプションの設定
ユーザーのサブスクリプション (メールまたはプッシュ) を設定するには、それぞれ関数 setEmailNotificationSubscriptionType()
または setPushNotificationSubscriptionType()
を呼び出します。どちらの関数もenum
型braze.User.NotificationSubscriptionTypes
を引数として取ります。この型には、次の 3 つの状態があります。
サブスクリプションのステータス |
定義 |
braze.User.NotificationSubscriptionTypes.OPTED_IN |
配信登録済み、かつ明示的にオプトイン済み |
braze.User.NotificationSubscriptionTypes.SUBSCRIBED |
購読済み、ただし明示的に選択されていない |
braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED |
配信停止済みまたは明示的にオプトアウト済み、あるいはその両方 |
ユーザーがプッシュに登録されると、ブラウザは通知を許可するかブロックするかを選択させ、プッシュを許可することを選択した場合、デフォルトでOPTED_IN
に設定されます。
ユーザーのサブスクリプションの管理を訪れて、サブスクリプションと明示的なオプトインの実装に関する詳細情報をご覧ください。
メールからのユーザの登録解除
1
| braze.getUser().setEmailNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);
|
プッシュからのユーザーのサブスクライブ解除
1
| braze.getUser().setPushNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);
|
前提条件
この機能を使用する前に、Unity Braze SDKを統合する必要があります。
デフォルトのユーザー属性
ユーザ属性を設定するには、BrazeBinding
オブジェクトで適切なメソッドを呼び出す必要があります。以下は、このメソッドを使用して呼び出すことができる組み込み属性s の一覧です。
属性 |
コードサンプル |
名 |
AppboyBinding.SetUserFirstName("first name"); |
姓 |
AppboyBinding.SetUserLastName("last name"); |
ユーザーのメールアドレス |
AppboyBinding.SetUserEmail("[email protected]"); |
性別 |
AppboyBinding.SetUserGender(Appboy.Models.Gender); |
生年月日 |
AppboyBinding.SetUserDateOfBirth("year(int)", "month(int)", "day(int)"); |
ユーザー国 |
AppboyBinding.SetUserCountry("country name"); |
ユーザーの市区町村 |
AppboyBinding.SetUserHomeCity("city name"); |
ユーザーのメールサブスクリプション |
AppboyBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType); |
ユーザプッシュサブスクリプション |
AppboyBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType); |
ユーザーの電話番号 |
AppboyBinding.SetUserPhoneNumber("phone number"); |
カスタムユーザー属性
デフォルトのユーザー属性に加えて、Braze では複数の異なるデータ型を使用してカスタム属性を定義することもできます。各属性のセグメンテーションオプションの詳細については、ユーザーデータ収集を参照してください。
カスタム属性の設定
1
| AppboyBinding.SetCustomUserAttribute("custom string attribute key", "string custom attribute");
|
1
2
3
4
| // Set Integer Attribute
AppboyBinding.SetCustomUserAttribute("custom int attribute key", 'integer value');
// Increment Integer Attribute
AppboyBinding.IncrementCustomUserAttribute("key", increment(int))
|
1
| AppboyBinding.SetCustomUserAttribute("custom double attribute key", 'double value');
|
1
| AppboyBinding.SetCustomUserAttribute("custom boolean attribute key", 'boolean value');
|
1
| AppboyBinding.SetCustomUserAttributeToNow("custom date attribute key");
|
1
| AppboyBinding.SetCustomUserAttributeToSecondsFromEpoch("custom date attribute key", 'integer value');
|
note:
Braze に渡される日付は、ISO 8601 形式(2013-07-16T19:20:30+01:00
など) またはyyyy-MM-dd'T'HH:mm:ss:SSSZ
形式(2016-12-14T13:32:31.601-0800
など) のいずれかである必要があります。
1
2
3
4
5
6
| // Setting An Array
AppboyBinding.SetCustomUserAttributeArray("key", array(List), sizeOfTheArray(int))
// Adding to an Array
AppboyBinding.AddToCustomUserAttributeArray("key", "Attribute")
// Removing an item from an Array
AppboyBinding.RemoveFromCustomUserAttributeArray("key", "Attribute")
|
important:
カスタム属性値の最大長は 255 文字です。これより長い値は切り捨てられます。
カスタム属性の設定解除
カスタムユーザー属性を設定解除するには、次の方法を使用します。
1
| AppboyBinding.UnsetCustomUserAttribute("custom attribute key");
|
REST API の使用
REST API を使用して、ユーザー属性を設定または設定解除することもできます。詳細については、User Data Endpointsを参照してください。
ユーザーサブスクリプションの設定
ユーザのメールサブスクリプションまたはプッシュサブスクリプションを設定するには、次のいずれかの関数を呼び出します。
1
2
3
4
5
| // Email notifications
AppboyBinding.SetUserEmailNotificationSubscriptionType()
// Push notifications
AppboyBinding.SetPushNotificationSubscriptionType()`
|
どちらの関数も引数としてAppboy.Models.AppboyNotificationSubscriptionType
を取ります。これは3 つの異なる状態を持ちます。
サブスクリプション ステータス |
定義 |
OPTED_IN |
配信登録済み、かつ明示的にオプトイン済み |
SUBSCRIBED |
購読済み、ただし明示的に選択されていない |
UNSUBSCRIBED |
配信停止済みまたは明示的にオプトアウト済み、あるいはその両方 |
note:
Windows では、ユーザーにプッシュ通知を送る際に明示的なオプトインは必要ありません。ユーザーがプッシュ登録されると、デフォルトで OPTED_IN
ではなく SUBSCRIBED
に設定されます。詳細については、 サブスクリプションs と明示的なopt-ins の実装に関するドキュメントを参照してください。
サブスクリプションタイプ |
説明 |
EmailNotificationSubscriptionType |
有効なメールアドレスを受信すると、ユーザは自動的にSUBSCRIBED に設定されます。ただし、明示的なオプトインプロセスを確立し、ユーザーから明示的な同意を受け取ったときにこの値をOPTED_IN に設定することをお勧めします。詳細については、ユーザーサブスクリプションの変更のドキュメントを参照してください。 |
PushNotificationSubscriptionType |
ユーザは、有効なプッシュ登録時に自動的にSUBSCRIBED に設定されます。ただし、明示的なオプトインプロセスを確立し、ユーザーから明示的な同意を受け取ったときにこの値をOPTED_IN に設定することをお勧めします。詳細については、ユーザーサブスクリプションの変更のドキュメントを参照してください。 |
note:
これらのタイプは Appboy.Models.AppboyNotificationSubscriptionType
に属します。
メールサブスクリプションの設定
1
| AppboyBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);
|
プッシュ通知サブスクリプションの設定
1
| AppboyBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);
|
Default User Attributes
To set a default attribute for a user, call the GetCurrentUser()
method on the shared UBrazeUser
object to get a reference to the current user of your app. Then you can call methods to set a user attribute.
1
2
3
4
5
| UBraze->GetCurrentUser([](UBrazeUser* BrazeUser) {
if (BrazeUser) {
BrazeUser->SetFirstName(TEXT("Alex"));
}
});
|
The following attributes should be set on the UBrazeUser
object:
SetFirstName
SetLastName
SetEmail
SetDateOfBirth
SetCountry
SetLanguage
SetHomeCity
SetPhoneNumber
SetGender
Custom User Attributes
In addition to the default user attributes, Braze also allows you to define custom attributes using several different data types. For more information on each attribute’s segmentation option, see User data collection.
To set a custom attribute with a string
value:
1
| UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), TEXT("your_attribute_value"));
|
To set a custom attribute with an integer
value:
1
| UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), 42);
|
Braze treats float
and double
values the same within our database. To set a custom attribute with a double value:
1
| UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), 3.14);
|
To set a custom attribute with a boolean
value:
1
| UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), true);
|
To set a custom attribute with a date
value:
1
2
| FDateTime YourDateTime = FDateTime(2023, 5, 10);
UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), YourDateTime);
|
To set a custom attribute with an array
value:
1
2
3
4
5
6
7
8
9
| // Setting a custom attribute with an array value
TArray<FString> Values = {TEXT("value1"), TEXT("value2")};
UBrazeUser->SetCustomAttributeArray(TEXT("array_name"), Values);
// Adding to a custom attribute with an array value
UBrazeUser->AddToCustomAttributeArray(TEXT("array_name"), TEXT("value3"));
// Removing a value from an array type custom attribute
UBrazeUser->RemoveFromCustomAttributeArray(TEXT("array_name"), TEXT("value2"));
|
important:
Custom attribute values have a maximum length of 255 characters; longer values will be truncated.
Setting user subscriptions
To set up an email or push subscription for your users, you can use the following methods.
Setting email subscription
1
2
3
4
5
| UBraze->GetCurrentUser([](UBrazeUser* BrazeUser) {
if (BrazeUser) {
BrazeUser->SetEmailSubscriptionType(EBrazeSubscriptionType::Subscribed);
}
});
|
Setting attribution data
1
2
3
4
5
| UBraze->GetCurrentUser([](UBrazeUser* BrazeUser) {
if (BrazeUser) {
BrazeUser->SetPushSubscriptionType(EBrazeSubscriptionType::OptedIn);
}
});
|