English 中文TürkçeРусскийEspañol日本語Tiếng Việt

Android - ペイウォールイベントの処理

このガイドでは、購入・復元・プロダクト選択・ペイウォールレンダリングに関するイベント処理について説明します。ボタン操作（ペイウォールのクローズ、リンクを開くなど）も別途実装が必要です。詳しくはボタンアクションの処理ガイドを参照してください。

ペイウォールビルダーで設定したペイウォールは、購入や復元のために追加のコードは不要です。ただし、アプリが対応できるいくつかのイベントが発生します。これらのイベントには、ボタン操作（閉じるボタン、URL、プロダクト選択など）や、ペイウォール上の購入関連アクションの通知が含まれます。以下でこれらのイベントへの対応方法を確認してください。

このガイドは、Adapty SDK v3.0以降が必要な新しいペイウォールビルダーのペイウォール専用です。

Adapty SDK がモバイルアプリにどのように統合されているか、実際の例を見てみませんか？ペイウォールの表示、購入処理、その他の基本機能を含む完全なセットアップを実演しているサンプルアプリをご覧ください。

購入画面で発生する処理を制御・監視したい場合は、AdaptyUiEventListener のメソッドを実装してください。

一部のケースでデフォルトの動作を維持したい場合は、AdaptyUiDefaultEventListener を継承して、変更したいメソッドだけをオーバーライドできます。

以下は AdaptyUiDefaultEventListener のデフォルト実装です。

ユーザー起因のイベント

プロダクト選択

プロダクトが購入のために選択された場合（ユーザーまたはシステムによる）、このメソッドが呼び出されます：

public override fun onProductSelected(
    product: AdaptyPaywallProduct,
    context: Context,
) {}
イベント例（クリックして展開）
{
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

購入開始

ユーザーが購入プロセスを開始すると、このメソッドが呼び出されます：

public override fun onPurchaseStarted(
    product: AdaptyPaywallProduct,
    context: Context,
) {}
イベント例（クリックして展開）
{
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

このメソッドはObserverモードでは呼び出されません。詳しくはAndroid - ObserverモードでのペイウォールビルダーペイウォールのPresentを参照してください。

購入成功・キャンセル・保留

購入が成功すると、このメソッドが呼び出されます：

public override fun onPurchaseFinished(
    purchaseResult: AdaptyPurchaseResult,
    product: AdaptyPaywallProduct,
    context: Context,
) {
    if (purchaseResult !is AdaptyPurchaseResult.UserCanceled)
        context.getActivityOrNull()?.onBackPressed()
}
イベント例（クリックして展開）
// Successful purchase
{
  "purchaseResult": {
    "type": "Success",
    "profile": {
      "accessLevels": {
        "premium": {
          "id": "premium",
          "isActive": true,
          "expiresAt": "2024-02-15T10:30:00Z"
        }
      }
    }
  },
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

// Cancelled purchase
{
  "purchaseResult": {
    "type": "UserCanceled"
  },
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

// Pending purchase
{
  "purchaseResult": {
    "type": "Pending"
  },
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

この場合は画面を閉じることをお勧めします。

このメソッドはObserverモードでは呼び出されません。詳しくはAndroid - ObserverモードでのペイウォールビルダーペイウォールのPresentを参照してください。

購入失敗

エラーにより購入が失敗した場合、このメソッドが呼び出されます。対象はGoogle Play Billing のエラー（支払い制限、無効なプロダクト、ネットワーク障害）、トランザクション検証失敗、システムエラーです。なお、ユーザーによるキャンセルはこのメソッドではなく onPurchaseFinished がキャンセル結果付きで呼び出され、保留中の支払いもこのメソッドは呼び出されません。

public override fun onPurchaseFailure(
    error: AdaptyError,
    product: AdaptyPaywallProduct,
    context: Context,
) {}
イベント例（クリックして展開）
{
  "error": {
    "code": "purchase_failed",
    "message": "Purchase failed due to insufficient funds",
    "details": {
      "underlyingError": "Insufficient funds in account"
    }
  },
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

このメソッドはObserverモードでは呼び出されません。詳しくはAndroid - ObserverモードでのペイウォールビルダーペイウォールのPresentを参照してください。

Webペイメントナビゲーション完了

特定のプロダクトに対してWebペイウォールを開こうとした後にこのメソッドが呼び出されます。ナビゲーションの成功・失敗どちらの場合も対象です：

public override fun onFinishWebPaymentNavigation(
    product: AdaptyPaywallProduct?,
    error: AdaptyError?,
    context: Context,
) {}

パラメーター：

パラメーター説明
productWebペイウォールが開かれた AdaptyPaywallProduct。null の場合があります。
errorWebペイウォールのナビゲーションが失敗した場合の AdaptyError オブジェクト。成功した場合は null。
イベント例（クリックして展開）
// Successful navigation
{
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  },
  "error": null
}

// Failed navigation
{
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  },
  "error": {
    "code": "web_navigation_failed",
    "message": "Failed to open web paywall",
    "details": {
      "underlyingError": "Browser unavailable"
    }
  }
}

購入復元成功

購入の復元が成功すると、このメソッドが呼び出されます：

public override fun onRestoreSuccess(
    profile: AdaptyProfile,
    context: Context,
) {}
イベント例（クリックして展開）
{
  "profile": {
    "accessLevels": {
      "premium": {
        "id": "premium",
        "isActive": true,
        "expiresAt": "2024-02-15T10:30:00Z"
      }
    },
    "subscriptions": [
      {
        "vendorProductId": "premium_monthly",
        "isActive": true,
        "expiresAt": "2024-02-15T10:30:00Z"
      }
    ]
  }
}

ユーザーが必要な accessLevel を持っている場合は、画面を閉じることをお勧めします。確認方法についてはサブスクリプションのステータスを参照してください。

購入復元失敗

Adapty.restorePurchases() が失敗した場合、このメソッドが呼び出されます：

public override fun onRestoreFailure(
    error: AdaptyError,
    context: Context,
) {}
イベント例（クリックして展開）
{
  "error": {
    "code": "restore_failed",
    "message": "Purchase restoration failed",
    "details": {
      "underlyingError": "No previous purchases found"
    }
  }
}

サブスクリプションのアップグレード

イベント例（クリックして展開）
{
  "product": {
    "vendorProductId": "premium_yearly",
    "localizedTitle": "Premium Yearly",
    "localizedDescription": "Premium subscription for 1 year",
    "localizedPrice": "$99.99",
    "price": 99.99,
    "currencyCode": "USD"
  },
  "subscriptionUpdateParams": {
    "replacementMode": "with_time_proration"
  }
}

データ取得とレンダリング

プロダクト読み込みエラー

初期化時にプロダクトを渡さない場合、AdaptyUI はサーバーから必要なオブジェクトを自動的に取得します。この操作が失敗した場合、AdaptyUI はこのメソッドを呼び出してエラーを通知します：

public override fun onLoadingProductsFailure(
    error: AdaptyError,
    context: Context,
): Boolean = false
イベント例（クリックして展開）
{
  "error": {
    "code": "products_loading_failed",
    "message": "Failed to load products from the server",
    "details": {
      "underlyingError": "Network timeout"
    }
  }
}

true を返すと、AdaptyUI は2秒後にリクエストを再試行します。

レンダリングエラー

インターフェースのレンダリング中にエラーが発生した場合、このメソッドを呼び出して報告されます：

public override fun onRenderingError(
    error: AdaptyError,
    context: Context,
) {}
イベント例（クリックして展開）
{
  "error": {
    "code": "rendering_failed",
    "message": "Failed to render paywall interface",
    "details": {
      "underlyingError": "Invalid paywall configuration"
    }
  }
}

通常の状況ではこのようなエラーは発生しないため、遭遇した場合はお知らせください。