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

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

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

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

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

モバイルアプリのペイウォール画面で発生するプロセスを制御・監視するには、AdaptyUIPaywallsEventsObserver のメソッドを実装し、画面を表示する前にオブザーバーを設定してください。

AdaptyUI().setPaywallsEventsObserver(this);

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

ユーザー生成イベント

ペイウォールの表示

このメソッドは、ペイウォールビューが画面に表示されたときに呼び出されます。

iOS では、ユーザーがペイウォール内のウェブペイウォールボタンをタップし、アプリ内ブラウザでウェブペイウォールが開いたときにも呼び出されます。

void paywallViewDidAppear(AdaptyUIPaywallView view) {
}

ペイウォールの非表示

このメソッドは、ペイウォールビューが画面から閉じられたときに呼び出されます。

iOS では、ペイウォールからアプリ内ブラウザで開いたウェブペイウォールが画面から消えたときにも呼び出されます。

void paywallViewDidDisappear(AdaptyUIPaywallView view) {
}

プロダクト選択

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

void paywallViewDidSelectProduct(AdaptyUIPaywallView view, String productId) {
}
イベントの例（クリックして展開）
{
  "productId": "premium_monthly"
}

購入の開始

ユーザーが購入プロセスを開始した場合、このメソッドが呼び出されます。

void paywallViewDidStartPurchase(AdaptyUIPaywallView view, AdaptyPaywallProduct product) {
}
イベントの例（クリックして展開）
{
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  }
}

購入の完了

このメソッドは、購入が成功した場合、ユーザーが購入をキャンセルした場合、または購入が保留中になった場合に呼び出されます。

void paywallViewDidFinishPurchase(AdaptyUIPaywallView view, 
                                  AdaptyPaywallProduct product, 
                                  AdaptyPurchaseResult purchaseResult) {
    switch (purchaseResult) {
      case AdaptyPurchaseResultSuccess(profile: final profile):
        // successful purchase
        break;
      case AdaptyPurchaseResultPending():
        // purchase is pending
        break;
      case AdaptyPurchaseResultUserCancelled():
        // user cancelled the purchase
        break;
      default:
        break;
    }
}
イベントの例（クリックして展開）
// Successful purchase
{
  "product": {
    "vendorProductId": "premium_monthly",
    "localizedTitle": "Premium Monthly",
    "localizedDescription": "Premium subscription for 1 month",
    "localizedPrice": "$9.99",
    "price": 9.99,
    "currencyCode": "USD"
  },
  "purchaseResult": {
    "type": "AdaptyPurchaseResultSuccess",
    "profile": {
      "accessLevels": {
        "premium": {
          "id": "premium",
          "isActive": true,
          "expiresAt": "2024-02-15T10:30:00Z"
        }
      }
    }
  }
}

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

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

この場合は画面を閉じることを推奨します。ペイウォール画面を閉じる方法については、ボタン操作への対応を参照してください。

ウェブ決済ナビゲーションの完了

このメソッドは、特定のプロダクトに対してウェブペイウォールを開こうとした後に呼び出されます。ナビゲーションの成功・失敗にかかわらず呼び出されます。

void paywallViewDidFinishWebPaymentNavigation(AdaptyUIPaywallView view, 
                                               AdaptyPaywallProduct? product, 
                                               AdaptyError? error) {
}

パラメーター:

パラメーター説明
productウェブペイウォールが開かれた AdaptyPaywallProduct。null の場合があります。
errorウェブペイウォールのナビゲーションが失敗した場合は 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"
    }
  }
}

購入の失敗

このメソッドは、購入が失敗した場合（決済エラーやネットワークエラーなど）に呼び出されます。ユーザーによるキャンセルや保留中のトランザクションには呼び出されません。それらは paywallViewDidFinishPurchase で処理されます。

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

復元の開始

ユーザーが復元プロセスを開始した場合、このメソッドが呼び出されます。

void paywallViewDidStartRestore(AdaptyUIPaywallView view) {
}

復元の成功

購入の復元が成功した場合、このメソッドが呼び出されます。

void paywallViewDidFinishRestore(AdaptyUIPaywallView view, AdaptyProfile profile) {
}
イベントの例（クリックして展開）
{
  "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 を持っている場合は、画面を閉じることを推奨します。確認方法についてはサブスクリプションのステータスを、ペイウォール画面の閉じ方についてはボタン操作への対応を参照してください。

復元の失敗

購入の復元が失敗した場合、このメソッドが呼び出されます。

void paywallViewDidFailRestore(AdaptyUIPaywallView view, AdaptyError error) {
}
イベントの例（クリックして展開）
{
  "error": {
    "code": "restore_failed",
    "message": "Purchase restoration failed",
    "details": {
      "underlyingError": "No previous purchases found"
    }
  }
}

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

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

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

void paywallViewDidFailLoadingProducts(AdaptyUIPaywallView view, AdaptyError error) {
}
イベントの例（クリックして展開）
{
  "error": {
    "code": "products_loading_failed",
    "message": "Failed to load products from the server",
    "details": {
      "underlyingError": "Network timeout"
    }
  }
}

レンダリングエラー

インターフェースのレンダリング中にエラーが発生した場合、このメソッドが呼び出されます。デフォルト（v3.15.2 以降）では、レンダリングエラーが発生するとペイウォールは自動的に閉じられますが、必要に応じてこの動作をオーバーライドできます。

void paywallViewDidFailRendering(AdaptyUIPaywallView view, AdaptyError error) {
  // Default behavior: view.dismiss()
  // Override with custom logic if needed, for example:
  // - Log the error
  // - Show an error message to the user
}
イベントの例（クリックして展開）
{
  "error": {
    "code": "rendering_failed",
    "message": "Failed to render paywall interface",
    "details": {
      "underlyingError": "Invalid paywall configuration"
    }
  }
}

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