ウェブSDKリファレンス

初期化

.initialize

SDKを初期化します。

パラメータ

options: InitializeOptions
- projectId
- (optional) serviceWorkerPath

FlareLane.initialize({
  projectId: "<PROJECT_ID>",
  serviceWorkerPath: "/sw.js" // optional
});

.setLogLevel

SDKのログレベルを設定します。

パラメータ

logLevel: 'none' | 'error' | 'verbose'
- none: 何も出力しません
- error: エラーのみ
- verbose: すべて出力します（デフォルト）

FlareLane.setLogLevel('verbose');

通知の購読

.getIsSubscribed

現在のデバイスが購読しているかどうかを確認します。

パラメータ

callback: (Boolean) => {}

FlareLane.getIsSubscribed((isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
});

.setIsSubscribed

現在のデバイスの購読ステータスを設定します。

サービス内の設定画面など、購読ステータスを直接管理したい場合に使用します。

trueに設定すると、購読に必要な一連の権限フローが一度に実行されます。

パラメータ

isSubscribed: Boolean
callback: (Boolean) => {}

const callback = (isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
};

// SUBSCRIBE
FlareLane.setIsSubscribed(true, callback);
// UNSUBSCRIBE
FlareLane.setIsSubscribed(false, callback);

顧客データ連携

.setUserId

現在のデバイスにユーザーIDを設定します。通常は、サインアップやログインが成功したタイミングでユーザーIDを更新します。

パラメータ

userId: string | null

// SET
FlareLane.setUserId("USER_ID");
// REMOVE
FlareLane.setUserId(null);

.trackEvent

イベントを発生させます。デバイスにユーザーIDが設定されている場合、イベントはそのユーザーに適用されます。設定されていない場合は、個々のデバイスに適用されます。

パラメータ

type: string
(optional) data: Record<string, string | number>

FlareLane.trackEvent('test_event');
// OR
FlareLane.trackEvent('test_event', { "dataKey": "dataValue" });

.setTags

タグを適用します。デバイスにユーザーIDが設定されている場合、タグはそのユーザーに適用されます。設定されていない場合は、個々のデバイスに適用されます。

パラメータ

tags: Record<string, string | number>

// SET
FlareLane.setTags({ gender: "men", age: 24 });

.setUserAttributes

ユーザープロフィールを適用します。

パラメータ

userAttributes: Record<string, string>

// SET
FlareLane.setUserAttributes({
  "name": "John Smith",
  "phoneNumber": "+12025550123",
  "dob": "1992-03-01",
  "email": "kevin@flarelane.com",
  "country": "US",
  "language": "en",
  "timeZone": "America/New_York"
});

.getDeviceId

現在のデバイスのFlareLaneデバイスIDを取得します。

パラメータ

callback: (string | null) => {}

FlareLane.getDeviceId((deviceId) => {
    // Do something...
    console.log(deviceId);
 });

通知ハンドラー

.setConvertedHandler

ユーザーが通知をクリックしてサービスに遷移したときに実行されるコールバックハンドラーを登録します。

パラメータ

callback: (Notification) => {}

FlareLane.setConvertedHandler((notification) => {
    // Do something...
    console.log(notification);
 });

アプリ内メッセージ

.displayInApp

現在のデバイスが表示対象となっている特定のグループの中から、最も優先度の高いアプリ内メッセージを表示します。

FlareLane.displayInApp("home");

.setInAppMessageActionHandler

アプリ内メッセージによってトリガーされるカスタムアクションを処理するための、独自のハンドラーを定義します。

FlareLane.setInAppMessageActionHandler((iam, actionId) => {
  // Do Something...
});