Adapty Flutter SDK v3.0 への移行

Adapty SDK v3.0 では、ペイウォールを作成するための新しいノーコードツール Adapty ペイウォールビルダー がサポートされました。最大限の柔軟性と豊富なデザイン機能により、ペイウォールをより効果的かつ収益性の高いものにできます。

AdaptyUI ライブラリは非推奨となり、AdaptySDK の一部として組み込まれました。

AdaptyUI SDK の削除

  1. AdaptyUI は Adapty SDK のモジュールになったため、pubspec.yaml ファイルから adapty_ui_flutter を削除してください。

    dependencies:
    + adapty_flutter: ^3.2.1
    - adapty_flutter: ^2.10.3
    - adapty_ui_flutter: ^2.1.3
  2. 以下を実行します。

    flutter pub get

Adapty SDK の設定

これまでは、Adapty SDK の設定に Adapty-Info.plist および AndroidManifest.xml ファイルを使用する必要がありました。

現在は、追加ファイルは不要です。代わりに、アクティベーション時に必要なパラメータをすべて指定できます。

Adapty SDK の設定は、通常アプリのライフサイクル開始時に一度だけ行います。

Adapty SDK の Adapty モジュールをアクティベートする

  1. アプリケーションから AdaptyUI SDK のインポートを次のように削除します。

    import 'package:adapty_flutter/adapty_flutter.dart';
    - import 'package:adapty_ui_flutter/adapty_ui_flutter.dart';
  2. Adapty SDK のアクティベーションを次のように更新します。

    try {
    -	Adapty().activate();  
    +    await Adapty().activate(
    +        configuration: AdaptyConfiguration(apiKey: 'YOUR_API_KEY')
    +         ..withLogLevel(AdaptyLogLevel.debug)
    +         ..withObserverMode(false)
    +         ..withCustomerUserId(null)
    +         ..withIdfaCollectionDisabled(false)
    +         ..withIpAddressCollectionDisabled(false),
    +   );
    } catch (e) {
        // handle the error
    }

パラメータ:

パラメータ必須/任意説明
PUBLIC_SDK_KEY必須Adapty のアプリ設定にある Public SDK key フィールドで確認できるキーです: App settings -> General タブ -> API keys セクション
withLogLevel任意Adapty はエラーやその他の重要な情報をログに記録し、アプリの動作状況を把握できるようにします。利用可能なレベルは以下のとおりです。
  • error: エラーのみがログに記録されます。
  • warn: エラーと、重大なエラーではないが注意が必要な SDK からのメッセージがログに記録されます。
  • info: エラー、警告、および各モジュールのライフサイクルなどの重要な情報メッセージがログに記録されます。
  • verbose: 関数呼び出し、API クエリなど、デバッグ時に役立つ追加情報がすべてログに記録されます。
withObserverMode任意

オブザーバーモードを制御する真偽値です。購入とサブスクリプションの状態を自分で管理し、サブスクリプションイベントの送信と分析に Adapty を使用する場合は有効にしてください。

デフォルト値は false です。

🚧 オブザーバーモードで動作している場合、Adapty SDK はトランザクションをクローズしないため、自前で処理する必要があります。

withCustomerUserId任意自社システムにおけるユーザーの識別子です。サブスクリプションおよび分析イベントに含めて送信し、イベントを正しいプロファイルに紐付けます。Profiles and Segments メニューで customerUserId によるユーザー検索も可能です。
withIdfaCollectionDisabled任意

IDFA の収集と共有を無効にするには true を設定します。

ユーザーの IP アドレス共有も無効になります。

デフォルト値は false です。

IDFA 収集の詳細については、Analytics integration セクションをご参照ください。

withIpAddressCollectionDisabled任意

ユーザーの IP アドレスの収集と共有を無効にするには true を設定します。

デフォルト値は false です。

Adapty SDK の AdaptyUI モジュールをアクティベートする

AdaptyUI モジュールの設定が必要なのは、ペイウォールビルダーを使用する予定がある場合のみです。

try {
    final mediaCache = AdaptyUIMediaCacheConfiguration(
        memoryStorageTotalCostLimit: 100 * 1024 * 1024, // 100MB
        memoryStorageCountLimit: 2147483647, // 2^31 - 1, max int value in Dart
        diskStorageSizeLimit: 100 * 1024 * 1024, // 100MB
    );

    await AdaptyUI().activate(
        configuration: AdaptyUIConfiguration(mediaCache: mediaCache),
        observer: <AdaptyUIObserver Implementation>,
    );
} catch (e) {
    // handle the error
}

AdaptyUI の設定はオプションであり、設定なしで AdaptyUI モジュールをアクティベートすることも可能です。ただし、設定を使用する場合はすべてのパラメータが必須となります。

パラメータ:

パラメータ必須/任意説明
memoryStorageTotalCostLimit必須ストレージの合計コスト上限(バイト単位)。
memoryStorageCountLimit必須メモリストレージのアイテム数上限。
diskStorageSizeLimit必須ディスク上のストレージファイルサイズ上限(バイト単位)。0 は上限なしを意味します。