Adapty ダッシュボードの新しいペイウォールビルダーでペイウォールのビジュアル部分をデザインした後、モバイルアプリにそれを表示できます。このプロセスの最初のステップは、プレースメントに関連付けられたペイウォールとそのビュー設定を取得することです。

このトピックはペイウォールビルダーでカスタマイズされたペイウォールに関するものです。ペイウォールを手動で実装する場合は、モバイルアプリのリモートコンフィグペイウォール用にペイウォールとプロダクトを取得するトピックを参照してください。

モバイルアプリでペイウォールの表示を始める前に（クリックして展開）

1. Adapty ダッシュボードでプロダクトを作成する。
2. Adapty ダッシュボードでペイウォールを作成してプロダクトを追加する。
3. Adapty ダッシュボードでプレースメントを作成してペイウォールを追加する。
4. モバイルアプリにAdapty SDKをインストールする。

ペイウォールビルダーで作成されたペイウォールを取得する

ペイウォールビルダーを使用してペイウォールをデザインした場合、ユーザーに表示するためにモバイルアプリのコードでレンダリングする必要はありません。このようなペイウォールには、ペイウォール内に表示する内容と表示方法の両方が含まれています。ただし、プレースメントを通じてそのIDを取得し、ビュー設定を取得してからモバイルアプリに表示する必要があります。

最適なパフォーマンスを確保するために、ペイウォールとそのビュー設定をできるだけ早く取得し、ユーザーに提示する前に画像をダウンロードするのに十分な時間を確保することが重要です。

ペイウォールを取得するには、getPaywall メソッドを使用します。

try {
  final paywall = await Adapty().getPaywall(placementId: "YOUR_PLACEMENT_ID", locale: "en");
  // the requested paywall
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
}

パラメーター：

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

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

パラメーター	説明
Paywall	プロダクトIDのリスト、ペイウォール識別子、リモートコンフィグ、その他いくつかのプロパティを持つ AdaptyPaywall オブジェクト。

ペイウォールビルダーで作成されたペイウォールのビュー設定を取得する

ペイウォールを取得した後、ViewConfiguration が含まれているか確認してください。これはペイウォールビルダーで作成されたことを示します。この確認によってペイウォールの表示方法が決まります。ViewConfiguration が存在する場合はペイウォールビルダーのペイウォールとして扱い、存在しない場合はリモートコンフィグのペイウォールとして処理します。

try {
  final view = await AdaptyUI().createPaywallView(
        paywall: paywall,
      );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

ビューを取得したら、ペイウォールを表示します。

デフォルトオーディエンス向けのペイウォールをより速く取得する

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

これに対処するため、getPaywallForDefaultAudience メソッドを使用できます。このメソッドは、All Users オーディエンス向けの指定されたプレースメントのペイウォールを取得します。ただし、上記のペイウォール情報を取得するセクションで詳述しているように、getPaywall メソッドでペイウォールを取得することが推奨されるアプローチであることを理解することが重要です。

try {
    final paywall = await Adapty().getPaywallForDefaultAudience(placementId: 'YOUR_PLACEMENT_ID');
} on AdaptyError catch (adaptyError) {
    // handle error
} catch (e) {
    // handle unknown error
}

パラメーター	必須/任意	説明
placementId	必須	プレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。
locale	任意 デフォルト：en	ペイウォールのローカライズの識別子。マイナス（-）で区切られた1つ以上のサブタグで構成される言語コードを指定します。最初のサブタグは言語、2番目は地域を表します。 例：en は英語、pt-br はブラジルポルトガル語を表します。 ロケールコードと推奨される使用方法については、ローカライズとロケールコードを参照してください。
fetchPolicy	デフォルト：.reloadRevalidatingCacheData	デフォルトでは、SDKはサーバーからデータを読み込もうとし、失敗した場合はキャッシュデータを返します。ユーザーが常に最新のデータを取得できるため、このオプションを推奨します。 ただし、ユーザーが不安定なインターネット環境にある場合は、.returnCacheDataElseLoad を使用してキャッシュデータが存在する場合に返すことを検討してください。この場合、ユーザーは最新のデータを取得できないこともありますが、インターネット接続が不安定でも読み込み時間が短縮されます。キャッシュは定期的に更新されるため、ネットワークリクエストを避けるためにセッション中に使用しても安全です。 キャッシュはアプリの再起動後も保持され、アプリの再インストールまたは手動クリーンアップ時にのみクリアされます。

アセットをカスタマイズする

ペイウォール内の画像や動画をカスタマイズするには、カスタムアセットを実装します。

ヒーロー画像と動画には事前定義されたID（hero_image および hero_video）があります。カスタムアセットバンドルでは、これらのIDを使用して要素をターゲットにし、その動作をカスタマイズします。

その他の画像や動画については、Adapty ダッシュボードでカスタムIDを設定する必要があります。

例えば、次のことができます：

• 一部のユーザーに異なる画像や動画を表示する。
• リモートのメイン画像が読み込まれている間にローカルのプレビュー画像を表示する。
• 動画を再生する前にプレビュー画像を表示する。

シンプルなディクショナリを使用してカスタムアセットを提供する例を示します：

final customAssets = {
    // Show a local image using a custom ID
    'custom_image': AdaptyCustomAsset.localImageAsset(
        assetId: 'assets/images/image_name.png',
    ),

    // Show a local video with a preview image
    'hero_video': AdaptyCustomAsset.localVideoAsset(
        assetId: 'assets/videos/custom_video.mp4',
    ),
};

try {
    final view = await AdaptyUI().createPaywallView(
        paywall: paywall,
        customAssets: <CUSTOM_ASSETS>,
        preloadProducts: preloadProducts,
        );
    } on AdaptyError catch (e) {
        // handle the error
    } catch (e) {
// handle the error
}

開発者定義タイマーを設定する

モバイルアプリでカスタムタイマーを使用するには、AdaptyTimerResolver プロトコルに準拠したオブジェクトを作成してください。このオブジェクトは各カスタムタイマーのレンダリング方法を定義します。必要であれば、このプロトコルにすでに準拠している [String: Date] ディクショナリを直接使用することもできます。以下に例を示します：

try {
  final view = await AdaptyUI().createPaywallView(
        paywall: paywall,
        customTimers: {
          'CUSTOM_TIMER_6H': DateTime.now().add(const Duration(seconds: 3600 * 6)),
          'CUSTOM_TIMER_NY': DateTime(2025, 1, 1), // New Year 2025
        },
      );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

この例では、CUSTOM_TIMER_NY と CUSTOM_TIMER_6H はAdapity ダッシュボードで設定した開発者定義タイマーの Timer ID です。timerResolver は、アプリが各タイマーを正しい値で動的に更新することを保証します。例えば：

• CUSTOM_TIMER_NY：元日など、タイマー終了までの残り時間。
• CUSTOM_TIMER_6H：ユーザーがペイウォールを開いた時点から始まる6時間の残り時間。