React Native SDKでオンボーディングを取得する

Adapty ダッシュボードのビルダーでオンボーディングのビジュアルをデザインしたら、React Nativeアプリに表示できます。まず、以下の手順でプレースメントに関連付けられたオンボーディングとそのビュー設定を取得します。

開始する前に、以下を確認してください：

Adapty React Native SDK バージョン3.8.0以上をインストール済みであること。
オンボーディングを作成済みであること。
プレースメントにオンボーディングを追加済みであること。

オンボーディングの取得

ノーコードビルダーでオンボーディングを作成すると、アプリが取得・表示する必要のある設定コンテナとして保存されます。このコンテナはエクスペリエンス全体（表示するコンテンツ、提示方法、クイズの回答やフォーム入力などのユーザー操作の処理）を管理します。また、コンテナは自動的に分析イベントを追跡するため、ビュートラッキングを別途実装する必要はありません。

パフォーマンスを最大化するために、ユーザーに表示する前に画像のダウンロード時間を確保できるよう、オンボーディング設定を早めに取得してください。

オンボーディングを取得するには、getOnboardingメソッドを使用します：

try {
    const placementId = 'YOUR_PLACEMENT_ID';
    const locale = 'en';

    const onboarding = await adapty.getOnboarding(placementId, locale);
    // the requested onboarding
} catch (error) {
    // handle the error
}

次に、createOnboardingViewメソッドを呼び出してビューインスタンスを作成します。

createOnboardingViewメソッドの結果は一度しか使用できません。再度使用する必要がある場合は、createOnboardingViewメソッドを新たに呼び出してください。再作成せずに2回呼び出すと、AdaptyUIError.viewAlreadyPresentedエラーが発生することがあります。

// for the Adapty SDK < 3.14 – import {createOnboardingView} from 'react-native-adapty/dist/ui';

if (onboarding.hasViewConfiguration) {
    try {
        const view = await createOnboardingView(onboarding);
    } catch (error) {
        // handle the error
    }
} else {
    //use your custom logic
}

パラメーター：

パラメーター	必須/任意	説明
placementId	必須	対象のプレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。
locale	任意デフォルト：`en`	オンボーディングのローカライズ識別子。このパラメーターは、マイナス（-）文字で区切られた1つまたは2つのサブタグで構成される言語コードを指定します。最初のサブタグは言語、2番目は地域を表します。例：`en`は英語、`pt-br`はブラジルポルトガル語を表します。ロケールコードと推奨される使用方法については、ローカライズとロケールコードを参照してください。
fetchPolicy	デフォルト：`.reloadRevalidatingCacheData`	デフォルトでは、SDKはサーバーからデータを読み込もうとし、失敗した場合はキャッシュデータを返します。ユーザーが常に最新データを取得できるため、このオプションを推奨します。ただし、ユーザーのインターネット接続が不安定だと思われる場合は、`.returnCacheDataElseLoad`を使用してキャッシュデータが存在すれば返すことを検討してください。この場合、ユーザーが最新データを取得できないことがありますが、接続状況に関わらず読み込み時間が短縮されます。キャッシュは定期的に更新されるため、セッション中のネットワークリクエストを避けるために安全に使用できます。キャッシュはアプリの再起動後も保持され、アプリの再インストールまたは手動クリーンアップ時にのみ消去されます。 Adapty SDKはオンボーディングをローカルに2層で保存します：上記の定期更新キャッシュとフォールバックオンボーディングです。また、CDNを使用してオンボーディングをより速く取得し、CDNが到達不能な場合に備えてスタンドアロンのフォールバックサーバーも使用します。このシステムは、インターネット接続が乏しい場合でも、常に最新バージョンのオンボーディングを取得できるよう設計されています。
loadTimeoutMs	デフォルト：5秒	このメソッドのタイムアウトを制限する値です。タイムアウトに達した場合、キャッシュデータまたはローカルフォールバックが返されます。なお、このメソッドは内部で複数のリクエストで構成される場合があるため、まれに`loadTimeout`で指定した時間よりも若干遅くタイムアウトすることがあります。

レスポンスパラメーター：

パラメーター	説明
Onboarding	オンボーディング識別子と設定、リモートコンフィグ、その他いくつかのプロパティを含む`AdaptyOnboarding`オブジェクト。

デフォルトオーディエンスのオンボーディングで取得を高速化する

通常、オンボーディングはほぼ即時に取得されるため、この処理を高速化することを心配する必要はありません。ただし、オーディエンスとオンボーディングが多数あり、ユーザーのインターネット接続が遅い場合、オンボーディングの取得に予想以上の時間がかかることがあります。そのような状況では、オンボーディングをまったく表示しないよりも、スムーズなユーザー体験を確保するためにデフォルトのオンボーディングを表示したい場合があります。

これに対応するために、getOnboardingForDefaultAudienceメソッドを使用できます。このメソッドは、指定されたプレースメントのAll Usersオーディエンス向けオンボーディングを取得します。ただし、上記のオンボーディングの取得セクションで説明したgetOnboardingメソッドを使用することが推奨アプローチであることを理解することが重要です。

getOnboardingForDefaultAudienceの代わりにgetOnboardingの使用を検討してください。後者には重要な制限があります：

互換性の問題：複数のアプリバージョンをサポートする際に問題が生じる可能性があり、後方互換性のあるデザインが必要になるか、古いバージョンで正しく表示されないことを受け入れる必要があります。
パーソナライゼーションなし：「All Users」オーディエンス向けのコンテンツのみを表示し、国、アトリビューション、カスタム属性に基づくターゲティングができません。

取得速度の向上がこれらのデメリットを上回る場合は、以下に示すgetOnboardingForDefaultAudienceを使用してください。それ以外の場合は、上記のgetOnboardingを使用してください。

try {
    const placementId = 'YOUR_PLACEMENT_ID';
    const locale = 'en';

    const onboarding = await adapty.getOnboardingForDefaultAudience(placementId, locale);
    // the requested onboarding
} catch (error) {
    // handle the error
}

パラメーター：

パラメーター必須/任意説明

placementId 必須対象のプレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。

locale

任意

デフォルト：en

オンボーディングのローカライズ識別子。このパラメーターは、マイナス（-）文字で区切られた1つまたは2つのサブタグで構成される言語コードを指定します。最初のサブタグは言語、2番目は地域を表します。

例：enは英語、pt-brはブラジルポルトガル語を表します。

ロケールコードと推奨される使用方法については、ローカライズとロケールコードを参照してください。

fetchPolicy

デフォルト：.reloadRevalidatingCacheData

デフォルトでは、SDKはサーバーからデータを読み込もうとし、失敗した場合はキャッシュデータを返します。ユーザーが常に最新データを取得できるため、このオプションを推奨します。

ただし、ユーザーのインターネット接続が不安定だと思われる場合は、.returnCacheDataElseLoadを使用してキャッシュデータが存在すれば返すことを検討してください。この場合、ユーザーが最新データを取得できないことがありますが、接続状況に関わらず読み込み時間が短縮されます。キャッシュは定期的に更新されるため、セッション中のネットワークリクエストを避けるために安全に使用できます。

キャッシュはアプリの再起動後も保持され、アプリの再インストールまたは手動クリーンアップ時にのみ消去されます。

Adapty SDKはオンボーディングをローカルに2層で保存します：上記の定期更新キャッシュとフォールバックオンボーディングです。また、CDNを使用してオンボーディングをより速く取得し、CDNが到達不能な場合に備えてスタンドアロンのフォールバックサーバーも使用します。このシステムは、インターネット接続が乏しい場合でも、常に最新バージョンのオンボーディングを取得できるよう設計されています。