React Native SDK - ユーザーIDの設定

フォローする
Avatar
Jared Ornstead
Updated
ドキュメント

ユーザーIDの設定

社内ユーザーIDをSingularに送信して、クロスデバイス追跡とユーザーレベルデータレポートを有効にします。

注： Singularのクロスデバイスソリューションをご利用の場合は、すべてのプラットフォームでユーザーIDを収集する必要があります。

ユーザーIDの要件

プライバシーとベストプラクティス

プライバシーコンプライアンスと適切なクロスデバイス測定を保証するため、ユーザーIDトラッキングを実施する際は以下のガイドラインに従ってください。

  • PIIを使用しない：ユーザIDは、メールアドレス、ユーザ名、電話番号などの個人を特定できる情報（PII）を公開するべきではありません。ファーストパーティデータに固有のハッシュ化された値を使用してください。
  • プラットフォーム間の一貫性：ユーザーIDの値は、正確なクロスデバイス測定のために、すべてのプラットフォーム（ウェブ／モバイル／PC／コンソール／オフライン）で同じ内部識別子でなければなりません。
  • ファーストパーティデータ：Singularはユーザーレベルのエクスポート、ETL、内部BIポストバック（設定されている場合）にユーザーIDを含みます。 ユーザーIDはファーストパーティデータであり、第三者と共有されることはありません。
  • 永続性：ユーザー ID は、unsetCustomUserId() を使用して明示的に設定が解除されるか、アプリがアンインストールされるまで保持されます。アプリを終了または再起動しても、ユーザIDはクリアされません。

実装の概要

ユーザIDを設定するタイミング

ユーザーIDを設定するにはSingular.setCustomUserId() 、ログアウト時にクリアするにはSingular.unsetCustomUserId() 。

ベストプラクティス複数のユーザーが1つのデバイスを共有する場合は、ログイン時にsetCustomUserId() を呼び出し、ログアウト時にunsetCustomUserId() を呼び出すログアウトフローを実装します。

アプリを開いたときにすでにユーザーIDがわかっている場合は、Singular SDKを初期化する前にwithCustomUserId() 。 これによりSingularは最初のセッションからユーザーIDを受け取ります。ただし、ユーザーIDは通常、ユーザーが登録またはログインするまで使用できません。その場合は、登録または認証フローが完了した後にsetCustomUserId() 。

SDKメソッド

カスタムユーザーIDの設定

クロスデバイスのトラッキングとユーザーレベルのレポートのために、内部ユーザーIDをSingularに送信します。

New ArchitectureOld Architecture 
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/js/NativeSingular';

// Set the user ID after login or registration
NativeSingular.setCustomUserId('user_123456');

メソッドの署名： 

static setCustomUserId(customUserId: string): void

例ログイン後にユーザーIDを設定

ユーザーが認証に成功した直後にsetCustomUserId() を呼び出し、その後のすべてのイベントがユーザーIDに関連付けられるようにします。

New ArchitectureOld Architecture 
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/js/NativeSingular';

async function handleUserLogin(email, password) {
  try {
    // Your authentication logic
    const response = await authenticateUser(email, password);

    if (response.success) {
      // Set the user ID in Singular after successful login
      NativeSingular.setCustomUserId(response.userId);

      console.log('User ID set:', response.userId);

      // Navigate to home screen
      navigateToHome();
    }
  } catch (error) {
    console.error('Login failed:', error);
  }
}

カスタム・ユーザIDの設定解除

ユーザーがログアウトしたときにユーザーIDをクリアして、マルチユーザーデバイスの正確なセッション追跡を保証します。

New ArchitectureOld Architecture 
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/js/NativeSingular';

// Unset the user ID on logout
NativeSingular.unsetCustomUserId();

メソッドの署名： 

static unsetCustomUserId(): void

例ログアウト時のユーザーIDのアンセット

ログアウトフロー中にunsetCustomUserId() を呼び出し、ユーザーID をクリアし、その後のイベントの不正な帰属を防ぎます。

New ArchitectureOld Architecture 
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/js/NativeSingular';

async function handleUserLogout() {
  try {
    // Clear app data and user session
    await clearUserSession();

    // Unset the user ID in Singular
    NativeSingular.unsetCustomUserId();

    console.log('User ID cleared');

    // Navigate to login screen
    navigateToLogin();
  } catch (error) {
    console.error('Logout failed:', error);
  }
}

初期化時にユーザーIDを設定する

アプリの起動時にユーザーIDが利用可能な場合（ユーザーがすでにログインしているなど）、withCustomUserId() を使用してSDKの初期化中にユーザーIDを設定します。これにより、最初のセッションにユーザー ID が含まれるようになります。

New ArchitectureOld Architecture 
// TurboModule direct API (React Native 0.76+ New Architecture)
import React, { useEffect } from 'react';
import NativeSingular from 'singular-react-native/js/NativeSingular';
import AsyncStorage from '@react-native-async-storage/async-storage';

export default function App() {
  useEffect(() = {
    initializeSingular();
  }, []);

  async function initializeSingular() {
    // Check if user is already logged in
    const userId = await AsyncStorage.getItem('user_id');

    // Create configuration object
    const config: SingularConfig = {
      apikey: 'YOUR_SDK_KEY',
      secret: 'YOUR_SDK_SECRET',
      ...(userId ? { customUserId: userId } : {}),
    };

    // Initialize SDK
    NativeSingular.init(config);
  }

  return (
    // Your app components
    null
  );
}

設定方法の署名： 

withCustomUserId(customUserId: string): SingularConfig

推奨：永続的なログインセッションを持つアプリには、初期化時にwithCustomUserId()を使用する。ユーザーが毎回ログインする必要があるアプリでは、認証後にsetCustomUserId() を呼び出します。