ユーザー属性を設定する

前提条件

この機能を使用する前に、Web Braze SDKを統合する必要がある。

デフォルトのユーザー属性

定義済みメソッド

Brazeは、Userクラス内で以下のユーザー属性を設定するための定義済みメソッドを提供しています:

• 名
• 姓
• 言語
• 国
• 生年月日
• メール
• 性別
• 市区町村
• 電話番号

デフォルト属性の設定

• using methods
• google tag manager

1
braze.getUser().setFirstName("SomeFirstName");

braze.getUser().setGender(braze.User.Genders.FEMALE);

braze.getUser().setDateOfBirth(2000, 12, 25);

<script>
window.braze.getUser().setGender("f")
</script>

デフォルト属性の解除

ユーザー属性の削除や解除は、アプリコード、REST APIリクエスト、またはユーザーの更新キャンバスステップを通じて行うことができます。配列およびブール値の属性にはnullを使用します。その他のデータタイプには空の文字列（""）を使用します。

Web SDKでデフォルトのユーザー属性を解除するには、関連するメソッドにnullを渡します。以下に例を示します:

• first name
• gender
• date of birth

braze.getUser().setFirstName(null);

braze.getUser().setGender(null);

braze.getUser().setDateOfBirth(null, null, null);

カスタムユーザー属性

カスタム属性の設定

• using methods
• google tag manager

デフォルトのユーザー属性メソッドに加えて、ユーザーに対してカスタム属性を設定することもできます。完全なメソッド仕様については、JSDocsを参照してください。

• string
• integer
• date
• array

string値でカスタム属性を設定するには:

braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  YOUR_STRING_VALUE
);

integer値でカスタム属性を設定するには:

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値でカスタム属性を設定するには:

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)
);

配列のデフォルトおよび最大要素数は500です。最大要素数は、Brazeダッシュボードのデータ設定 > カスタム属性で更新できます。最大要素数を超える配列は、最大要素数に切り詰められます。

array値でカスタム属性を設定するには:

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");

重要

このメソッドでBrazeに渡される日付は、JavaScriptのDateオブジェクトでなければなりません。

重要

カスタム属性のキーと値は、最大255文字までです。有効なカスタム属性の値に関する詳細については、リファレンスドキュメントを参照してください。

Google Tag Managerのスクリプト言語の制限により、カスタムユーザー属性は使用できません。カスタム属性を記録するには、次の内容でカスタムHTMLタグを作成します:

<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>

重要

GTMテンプレートでは、イベントまたは購入のネストされたプロパティはサポートされていません。前述のHTMLを使用して、ネストされたプロパティを必要とするイベントや購入を記録できます。

カスタム属性の設定解除

カスタム属性を解除するには、関連するメソッドにnullを渡します。

braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, null);

階層化カスタム属性

カスタム属性内にプロパティをネストすることもできます。次の例では、ネストされたプロパティを持つfavorite_bookオブジェクトが、ユーザープロファイルのカスタム属性として設定されています。詳細については、階層化カスタム属性を参照してください。

import * as braze from "@braze/web-sdk";

const favoriteBook = {
  title: "The Hobbit",
  author: "J.R.R. Tolkien",
  publishing_date: "1937"
};

braze.getUser().setCustomUserAttribute("favorite_book", favoriteBook);

REST APIの使用

ユーザー属性の設定や解除には、REST APIも使用できます。詳細については、ユーザーデータエンドポイントを参照してください。

ユーザーサブスクリプションの設定

ユーザーのサブスクリプション（メールまたはプッシュ）を設定するには、それぞれ関数setEmailNotificationSubscriptionType()またはsetPushNotificationSubscriptionType()を呼び出します。両方の関数はenum型braze.User.NotificationSubscriptionTypesを引数として取ります。この型には、次の3つの状態があります:

ユーザーがプッシュに登録されると、ブラウザは通知を許可するかブロックするかの選択を求めます。プッシュを許可することを選択した場合、デフォルトでOPTED_INに設定されます。

サブスクリプションと明示的なオプトインの実装に関する詳細については、ユーザーのサブスクリプションの管理を参照してください。

ユーザーのメール配信停止

braze.getUser().setEmailNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);

ユーザーのプッシュ通知の配信停止

braze.getUser().setPushNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);