実験 React Native SDK（レガシー）

Amplitude ExperimentのクライアントサイドReact Native SDKに関する公式ドキュメントです。

インストール

実験 JavaScript Client SDK をインストールします。

npm install --save @amplitude/experiment-react-native-client

// (1) Initialize the experiment client
await Experiment.initialize('<DEPLOYMENT_KEY>');
// (2) Fetch variants for a user
const user = {
    user_id: 'user@company.com',
    device_id: 'abcdefg',
    user_properties: {
        'premium': true,
    },
};
await Experiment.fetch(user);
// (3) Lookup a flag's variant
const variant = await Experiment.variant('<FLAG_KEY>');
if (variant.value === 'on') {
    // Flag is on
} else {
    // Flag is off
}

コア機能

以下の関数が実験クライアント側SDKの中核を成しています。

初期化する

スタートアップ時にアプリケーション内のSDKクライアントを初期化します。apiKeyパラメーターに渡すデプロイメントキー引数は、アナリティクスイベントの送信先となるプロジェクトと同じプロジェクト内に存在する必要があります。

initialize(apiKey: string, config?: ExperimentConfig): Promise<boolean>

初期化子はシングルトンインスタンスを返すため、同じインスタンス名に対する後続の初期化は常に最初のインスタンスを返します。複数のインスタンスを作成するには、instanceNameの設定を使用します。

const experiment = await Experiment.initialize('<DEPLOYMENT_KEY>');

統合

AmplitudeまたはSegment アナリティクス SDKのいずれかを使用してAmplitudeへのイベントをトラッキングしている場合は、初期化時に連携を設定する必要があります。連携はプロバイダーインターフェイスを自動的に実装し、ユーザーIDの管理やエクスポージャーイベントの追跡を容易にすることで、より合理化された開発者体験を実現します。

await Amplitude.getInstance().init('<API_KEY>');
await Experiment.initializeWithAmplitudeAnalytics('<DEPLOYMENT_KEY>');

設定

初期化時にSDKクライアントを設定します。

取得

ユーザーのバリアントを取得し、高速アクセスのために結果をクライアントに保存します。 この関数は、SDKクライアントの初期化に使用されたデプロイメントに関連付けられているフラグについて、ユーザーを リモートで評価します。

fetch(user?: ExperimentUser): Promise<boolean>

Amplitudeでは、ユーザーがアプリケーションセッションの最新のバリアントを取得できるように、アプリケーション起動時にfetch()を呼び出すことを推奨しています。さらに、インターフェイスの"ちらつき"を防ぐために、ユーザーエクスペリエンスをレンダリングする前にフェッチリクエストが結果を返すのを待つ必要があります。

const user = {
    user_id: 'user@company.com',
    device_id: 'abcdefg',
    user_properties: {
        'premium': true,
    },
};
await Experiment.fetch(user);

連携またはカスタムユーザープロバイダーを使用している場合は、ユーザーを入力せずに取得できます。

await Experiment.fetch();

バリアント

SDKクライアントのローカルストアからフラグまたは実験のバリアントにアクセスします。

variant(key: string): Promise<Variant>

variantWithFallback(key: string, fallback: Variant): Promise<Variant>

ユーザーがどのバリアントに振り分けられたかを判断する際は、バリアント value を既知の文字列と比較することになります。

const variant = await Experiment.variant('<FLAG_KEY>');
if (variant.value === 'on') {
    // Flag is on
} else {
    // Flag is off
}

const variant = await Experiment.variant('<FLAG_KEY>');
if (variant.value === 'on') {
    const payload = variant.payload;
}

nullバリアントvalueとは、ユーザーがバリアントに割り当てられていないことを意味します。 組み込みのフォールバックパラメータを使用して、ストアに指定されたフラグキーのバリアントがない場合に返すバリアントを指定できます。

const variant = await Experiment.variantWithFallback('<FLAG_KEY>', { value: 'control' });
if (variant === 'control') {
    // Control
} else if (variant === 'treatment') {
    // Treatment
}

すべて

SDKクライアントによって保存されているすべてのバリアントにアクセスできます。

all(): Promise<Variants>

エクスポージャー

設定済みの連携またはカスタムエクスポージャー追跡プロバイダーを通じて、指定されたフラグキーの現在のバリアントに対するエクスポージャーイベントを手動で追跡します。一般的に、automaticExposureTracking 構成のオプションを false に設定することと併せて使用されます。

exposure(key: string): Promise<boolean>

const variant = await Experiment.variant('<FLAG_KEY>');
// Do other things...
await Experiment.exposure('<FLAG_KEY>');
if (variant === 'control') {
    // Control
} else if (variant === 'treatment') {
    // Treatment
}