フローとペイウォールの取得 - Android

フローのデザインが完了したら、モバイルアプリ上に表示できます。最初のステップは、プレースメントに紐づいたフローまたはペイウォールと、そのビュー設定を以下のように取得することです。

Tip

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

始める前に

以下が必要です：

Adapty ダッシュボードのプロダクト: プロダクトを作成する。
プロダクトが設定されたフロー: フロー & ペイウォールビルダーでビルドし、プロダクトを割り当てる。
プレースメント: プレースメントを作成し、フローを割り当てる。
Adapty SDK のインストール: Android SDK インストールガイドを参照。

フローまたはペイウォールの取得

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

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

フローまたはペイウォールを取得するには、getFlow メソッドを使用します：


...

Adapty.getFlow("YOUR_PLACEMENT_ID", loadTimeout = 10.seconds) { result ->
    when (result) {
        is AdaptyResult.Success -> {
            val flow = result.value
            // the requested flow/paywall
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}


...

Adapty.getFlow("YOUR_PLACEMENT_ID", TimeInterval.seconds(10), result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyFlow flow = ((AdaptyResult.Success<AdaptyFlow>) result).getValue();
        // the requested flow/paywall

    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error

    }
});

パラメーター:

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

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

パラメーター	必須/任意	説明
placementId	必須	対象のプレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。
fetchPolicy	デフォルト: `.reloadRevalidatingCacheData`	デフォルトでは、SDK はサーバーからデータを読み込もうとし、失敗した場合はキャッシュされたデータを返します。この方法は常に最新のデータをユーザーに届けられるため、推奨しています。ただし、ユーザーのインターネット接続が不安定な場合は、`.returnCacheDataElseLoad` を使用してキャッシュが存在すればそれを返すことも検討してください。この場合、最新データが届かないこともありますが、接続状況に関わらず読み込み時間が短縮されます。キャッシュは定期的に更新されるため、セッション中にネットワークリクエストを避けるために使用しても安全です。キャッシュはアプリを再起動しても保持され、アプリの再インストールまたは手動でのクリア時のみ削除されます。 Adapty SDK はフローとペイウォールをローカルに2つの層で保存しています。1つは上述の定期更新キャッシュ、もう1つはフォールバックペイウォールです。また、取得を高速化するために CDN を使用し、CDN にアクセスできない場合に備えてスタンドアロンのフォールバックサーバーも用意しています。このシステムにより、インターネット接続が不安定な状況でも、常に最新バージョンを取得しつつ高い信頼性を確保しています。
loadTimeout	デフォルト: 5秒	このメソッドのタイムアウト上限を設定します。タイムアウトに達した場合、キャッシュされたデータまたはローカルフォールバックが返されます。なお、内部的に複数のリクエストで構成される場合があるため、`loadTimeout` で指定した時間よりわずかに遅れてタイムアウトすることがまれにあります。 Android の場合: 拡張関数（例: `5.seconds`、`.seconds` は `import com.adapty.utils.seconds` から）または `TimeInterval.seconds(5)` を使って `TimeInterval` を作成できます。制限なしにするには `TimeInterval.INFINITE` を使用してください。

fetchPolicy

デフォルト: .reloadRevalidatingCacheData

デフォルトでは、SDK はサーバーからデータを読み込もうとし、失敗した場合はキャッシュされたデータを返します。この方法は常に最新のデータをユーザーに届けられるため、推奨しています。

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

キャッシュはアプリを再起動しても保持され、アプリの再インストールまたは手動でのクリア時のみ削除されます。

Adapty SDK はフローとペイウォールをローカルに2つの層で保存しています。1つは上述の定期更新キャッシュ、もう1つはフォールバックペイウォールです。また、取得を高速化するために CDN を使用し、CDN にアクセスできない場合に備えてスタンドアロンのフォールバックサーバーも用意しています。このシステムにより、インターネット接続が不安定な状況でも、常に最新バージョンを取得しつつ高い信頼性を確保しています。

loadTimeout

デフォルト: 5秒

このメソッドのタイムアウト上限を設定します。タイムアウトに達した場合、キャッシュされたデータまたはローカルフォールバックが返されます。

なお、内部的に複数のリクエストで構成される場合があるため、loadTimeout で指定した時間よりわずかに遅れてタイムアウトすることがまれにあります。

Android の場合: 拡張関数（例: 5.seconds、.seconds は import com.adapty.utils.seconds から）または TimeInterval.seconds(5) を使って TimeInterval を作成できます。制限なしにするには TimeInterval.INFINITE を使用してください。

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

パラメーター	説明
Flow	プレースメント、識別子（`id`、`variationId`）、名前、ペイウォールのバリエーション（`paywalls`）、リモートコンフィグ、およびフローにビュー設定が含まれているかどうかを示す `hasViewConfiguration` フラグを含む `AdaptyFlow` オブジェクト。事前読み込み、カスタム UI、またはプログラムによるチェックのために実際のプロダクトを取得するには、`getPaywallProducts(flow)` を呼び出してください。

ビュー設定の取得

フローまたはペイウォールを取得したら、flow.hasViewConfiguration を使ってビュー設定が含まれているかどうかを確認します。このフラグは、Adapty ダッシュボードでプレースメントがどのように設計されているかを示します。

true — プレースメントは Flow & Paywall Builder（フロー）または 旧ペイウォールビルダー（ペイウォール）で作成されています。Adapty が UI をレンダリングします。以下の手順に進み、ビュー設定を取得してフローまたはペイウォールを表示してください。
false — プレースメントはビルダー UI を持たないカスタムペイウォールです。リモートコンフィグペイウォールとして処理してください。

Important

フローを公開してください。編集が未公開のフローは Dirty ステータスとなり、そのプレースメントは最後に公開されたバージョンを引き続き提供します。

getFlowConfiguration メソッドを使用して、ビューの設定を読み込みます。

if (!flow.hasViewConfiguration) {
    // use your custom logic
    return
}

AdaptyUI.getFlowConfiguration(flow, loadTimeout = 10.seconds) { result ->
    when(result) {
        is AdaptyResult.Success -> {
            val flowConfiguration = result.value
            // use loaded configuration
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

パラメーター	必須/任意	説明
flow	必須	`Adapty.getFlow` で取得した `AdaptyFlow` オブジェクト。
locale	任意	レンダリングに使用するフローのローカライゼーションの識別子。`-` で区切られた1つまたは2つのサブタグを持つ言語コード（例：`en`、`pt-br`）で指定します。省略した場合、ビューは `en` でレンダリングされます。フローに `en` が存在しない場合はフローのデフォルトローカライゼーションが使用されます。詳細はローカライゼーションとロケールコードをご覧ください。
customLayoutId	任意デフォルト: `null` SDK 4.1+	フローのレイアウト設定内にあるレイアウトのカスタムID。SDKがデバイスの種類や画面サイズから自動的に選択するレイアウトの代わりに、特定のレイアウトをレンダリングする場合に指定します。IDに一致するレイアウトが存在しない場合、no-view-configuration エラーで呼び出しが失敗します。Flow & Paywall Builder ではカスタムレイアウトIDをまだ割り当てられないため、このパラメーターは未設定のままにしてください。
loadTimeout	デフォルト: 5秒	このメソッドのタイムアウト時間を制限する値です。タイムアウトに達した場合、キャッシュされたデータまたはローカルフォールバックが返されます。このメソッドは内部で複数のリクエストを実行する場合があるため、まれに `loadTimeout` で指定した時間よりも若干遅れてタイムアウトすることがあります。

getFlowConfiguration メソッドを使用して、ビュー設定を読み込みます。

if (!flow.hasViewConfiguration()) {
    // use your custom logic
    return;
}

AdaptyUI.getFlowConfiguration(flow, TimeInterval.seconds(10), result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyUI.FlowConfiguration flowConfiguration =
          ((AdaptyResult.Success<AdaptyUI.FlowConfiguration>) result).getValue();
        // use loaded configuration
    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error
    }
});

パラメータ	必須/任意	説明
flow	必須	`Adapty.getFlow` で取得した `AdaptyFlow` オブジェクト。
locale	任意	レンダリングに使用するフローのローカライゼーションの識別子。`-` で区切られた1つまたは2つのサブタグを持つ言語コード（例：`en`、`pt-br`）で指定します。省略した場合は `en` でレンダリングされます。フローに `en` がない場合はフローのデフォルトのローカライゼーションが使用されます。詳しくはローカライゼーションとロケールコードを参照してください。
customLayoutId	任意デフォルト: `null` SDK 4.1+	フローのレイアウト設定におけるレイアウトのカスタムID。SDKがデバイスの種類と画面サイズに基づいて自動選択するレイアウトではなく、特定のレイアウトをレンダリングする場合に指定します。IDに一致するレイアウトが存在しない場合、呼び出しはno-view-configurationエラーで失敗します。フロー & ペイウォールビルダーではカスタムレイアウトIDはまだ割り当てられないため、このパラメータは未設定のままにしてください。
loadTimeout	デフォルト: 5秒	このメソッドのタイムアウト上限を設定します。タイムアウトに達した場合、キャッシュされたデータまたはローカルのフォールバックが返されます。内部で複数のリクエストが発生する場合があるため、まれに `loadTimeout` で指定した時間よりわずかに遅れてタイムアウトすることがあります。

Note

複数の言語を使用している場合は、ビルダーのローカライゼーションの追加方法と、ロケールコードの正しい使用方法をこちらでご確認ください。

読み込みが完了したら、フローまたはペイウォールを表示します。

デフォルトオーディエンス向けのフローまたはペイウォールを素早く取得する

通常、フローやペイウォールはほぼ瞬時に取得されるため、速度を意識する必要はありません。ただし、オーディエンスやプレースメントの数が多く、ユーザーのインターネット接続が不安定な場合、取得に想定以上の時間がかかることがあります。そのような状況では、何も表示しないよりも、デフォルトのフローまたはペイウォールを表示してスムーズなユーザー体験を提供したい場合があります。

これに対応するには、getFlowForDefaultAudience メソッドを使用できます。このメソッドは、指定されたプレースメントの All Users オーディエンス向けのフローまたはペイウォールを取得します。ただし、推奨されるアプローチは上記のフロー/ペイウォールを取得するセクションで説明した getFlow メソッドでフローまたはペイウォールを取得する方法であることを理解しておくことが重要です。

Warning

getFlow を推奨する理由

getFlowForDefaultAudience メソッドにはいくつかの重大な欠点があります：

後方互換性の問題: 異なるアプリバージョン（現行バージョンと将来のバージョン）で異なるフローを表示する必要がある場合、課題が生じる可能性があります。現行（レガシー）バージョンに対応したフローを設計するか、現行（レガシー）バージョンのユーザーがフローを正しくレンダリングできない問題を受け入れるかのどちらかを選択する必要があります。
ターゲティングの喪失: すべてのユーザーが All Users オーディエンス向けに設計された同一のフローを見ることになるため、パーソナライズされたターゲティング（国、マーケティングアトリビューション、独自のカスタム属性に基づくものを含む）が失われます。

対応するデメリットを許容してでもフローやペイウォールの取得を高速化したい場合は、以下のように getFlowForDefaultAudience メソッドを使用してください。そうでない場合は、上記で説明した getFlow を使用してください。

Adapty.getFlowForDefaultAudience("YOUR_PLACEMENT_ID") { result ->
    when (result) {
        is AdaptyResult.Success -> {
            val flow = result.value
            // the requested flow
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

Adapty.getFlowForDefaultAudience("YOUR_PLACEMENT_ID", result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyFlow flow = ((AdaptyResult.Success<AdaptyFlow>) result).getValue();
        // the requested flow

    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error

    }
});

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

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

パラメータ	必須/任意	説明
placementId	必須	プレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。
fetchPolicy	デフォルト: `.reloadRevalidatingCacheData`	デフォルトでは、SDK はサーバーからデータを読み込もうとし、失敗した場合はキャッシュされたデータを返します。ユーザーが常に最新のデータを取得できるよう、この設定を推奨します。ただし、ユーザーのインターネット接続が不安定な場合は、`.returnCacheDataElseLoad` の使用を検討してください。キャッシュが存在する場合はキャッシュデータを返します。この場合、最新のデータが取得できないこともありますが、接続状況に関わらず読み込みが速くなります。キャッシュは定期的に更新されるため、セッション中にネットワークリクエストを減らす目的で使用しても問題ありません。キャッシュはアプリを再起動しても保持され、アプリの再インストールまたは手動でのクリア操作によってのみ削除されます。

fetchPolicy

デフォルト: .reloadRevalidatingCacheData

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

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

キャッシュはアプリを再起動しても保持され、アプリの再インストールまたは手動でのクリア操作によってのみ削除されます。

アセットのカスタマイズ

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

ヒーロー画像と動画には、定義済みのID（hero_image と hero_video）があります。カスタムアセットバンドルでは、これらのIDを使って要素を指定し、その動作をカスタマイズします。

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

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

特定のユーザーに異なる画像や動画を表示する。
リモートのメイン画像の読み込み中に、ローカルのプレビュー画像を表示する。
動画を再生する前にプレビュー画像を表示する。

Here’s an example of how you can provide custom assets via a simple dictionary:

val customAssets = AdaptyCustomAssets.of(
    "hero_image" to
            AdaptyCustomImageAsset.remote(
                url = "https://example.com/image.jpg",
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromAsset("images/hero_image_preview.png"),
                )
            ),
    "hero_video" to
            AdaptyCustomVideoAsset.file(
                FileLocation.fromResId(requireContext(), R.raw.custom_video),
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromResId(requireContext(), R.drawable.video_preview),
                ),
            ),
)

val flowView = AdaptyUI.getFlowView(
    activity,
    flowConfiguration,
    products,
    eventListener,
    insets,
    customAssets,
)

Note

アセットが見つからない場合、フローはデフォルトの外観にフォールバックします。

動画の場合、オプションで resolution を渡すことで、動画の読み込み前にレイアウトスペースを確保し、アスペクト比（width / height）を設定できます：

AdaptyCustomVideoAsset.file(
    FileLocation.fromResId(requireContext(), R.raw.custom_video),
    preview = AdaptyCustomImageAsset.file(
        FileLocation.fromResId(requireContext(), R.drawable.video_preview),
    ),
    resolution = AdaptyCustomVideoAsset.Resolution(width = 1080, height = 1920),
)

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

Warning

SDK 3.x のペイウォールビルダーで作成されたペイウォールには、Android SDK バージョン 3.0 以上が必要です。

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

Tip

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

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

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

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

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

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


...

Adapty.getPaywall("YOUR_PLACEMENT_ID", locale = "en", loadTimeout = 10.seconds) { result ->
    when (result) {
        is AdaptyResult.Success -> {
            val paywall = result.value
            // the requested paywall
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}


...

Adapty.getPaywall("YOUR_PLACEMENT_ID", "en", TimeInterval.seconds(10), result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyPaywall paywall = ((AdaptyResult.Success<AdaptyPaywall>) result).getValue();
        // the requested paywall
      
    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error
      
    }
});

パラメーター:

パラメーター	必須/任意	説明
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` オブジェクト。

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

Important

ペイウォールビルダーで Show on device トグルを必ず有効にしてください。このオプションがオンになっていない場合、ビュー設定を取得できません。

ペイウォールを取得したら、ViewConfiguration が含まれているかどうかを確認してください。これが含まれている場合、そのペイウォールはペイウォールビルダーで作成されたことを示します。ViewConfiguration が存在する場合はペイウォールビルダーのペイウォールとして処理し、存在しない場合はリモートコンフィグのペイウォールとして処理してください。

getViewConfiguration メソッドを使用して、ビュー設定を読み込みます。

if (!paywall.hasViewConfiguration) {
    // use your custom logic
    return
}

AdaptyUI.getViewConfiguration(paywall, loadTimeout = 10.seconds) { result ->
    when(result) {
        is AdaptyResult.Success -> {
            val viewConfiguration = result.value
            // use loaded configuration
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

パラメーター	必須/任意	説明
paywall	必須	目的のペイウォールのコントローラーを取得するための `AdaptyPaywall` オブジェクト。
loadTimeout	デフォルト: 5秒	このメソッドのタイムアウト上限を設定します。タイムアウトに達した場合、キャッシュされたデータまたはローカルのフォールバックが返されます。なお、このメソッドは内部で複数のリクエストで構成されることがあるため、まれに `loadTimeout` で指定した時間よりわずかに遅れてタイムアウトすることがあります。

ビューの設定を読み込むには、getViewConfiguration メソッドを使用します。

if (!paywall.hasViewConfiguration()) {
    // use your custom logic
    return;
}

AdaptyUI.getViewConfiguration(paywall, TimeInterval.seconds(10), result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyUI.LocalizedViewConfiguration viewConfiguration =
          ((AdaptyResult.Success<AdaptyUI.LocalizedViewConfiguration>) result).getValue();
        // use loaded configuration
    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error
    }
});

パラメータ	必須/任意	説明
paywall	必須	目的のペイウォールのコントローラーを取得するための `AdaptyPaywall` オブジェクト。
loadTimeout	デフォルト: 5秒	このメソッドのタイムアウト上限を設定します。タイムアウトに達した場合、キャッシュされたデータまたはローカルのフォールバックが返されます。なお、このメソッドは内部で複数のリクエストを実行する場合があるため、まれに `loadTimeout` で指定した時間よりもわずかに遅れてタイムアウトすることがあります。

Note

複数言語をサポートする場合は、ペイウォールにローカリゼーションを追加してください。使用するコードについては、ローカリゼーションとロケールコードを参照してください。

読み込みが完了したら、ペイウォールを表示してください。

デフォルトオーディエンス向けペイウォールを素早く取得する

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

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

Warning

getPaywall を推奨する理由

getPaywallForDefaultAudience メソッドにはいくつかの重大な欠点があります：

後方互換性の問題: 現在のバージョンと将来のバージョンで異なるペイウォールを表示する必要がある場合、課題が生じる可能性があります。現在の（レガシー）バージョンに対応したペイウォールを設計するか、現在の（レガシー）バージョンのユーザーがペイウォールを正常に表示できない問題を受け入れるかのどちらかになります。
ターゲティングの喪失: すべてのユーザーが All Users オーディエンス向けに設計された同じペイウォールを見ることになり、国、マーケティングのアトリビューション、独自のカスタム属性に基づくパーソナライズされたターゲティングができなくなります。

ペイウォールの取得速度を優先してこれらのデメリットを許容できる場合は、以下のように getPaywallForDefaultAudience メソッドを使用してください。そうでない場合は、上記で説明した getPaywall を使用してください。

Adapty.getPaywallForDefaultAudience("YOUR_PLACEMENT_ID", locale = "en") { result ->
    when (result) {
        is AdaptyResult.Success -> {
            val paywall = result.value
            // the requested paywall
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

Adapty.getPaywallForDefaultAudience("YOUR_PLACEMENT_ID", "en", result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyPaywall paywall = ((AdaptyResult.Success<AdaptyPaywall>) result).getValue();
        // the requested paywall

    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error
      
    }
});

Note

getPaywallForDefaultAudience メソッドは Android SDK 2.11.3 以降で利用可能です。

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

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

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

locale

任意

デフォルト: en

ペイウォールのローカライゼーションの識別子。マイナス（-）文字で区切られた1つ以上のサブタグで構成される言語コードを指定します。最初のサブタグは言語、2番目のサブタグは地域を表します。

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

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

fetchPolicy

デフォルト: .reloadRevalidatingCacheData

デフォルトでは、SDK はサーバーからデータの読み込みを試み、失敗した場合はキャッシュされたデータを返します。この方法を推奨します。ユーザーが常に最新のデータを受け取れることが保証されるためです。

ただし、ユーザーが不安定なインターネット環境を利用していると考えられる場合は、.returnCacheDataElseLoad を使用することで、キャッシュが存在する場合はキャッシュデータを返すことができます。この場合、最新データが取得できないことはありますが、インターネット接続が不安定であっても読み込み速度が向上します。キャッシュは定期的に更新されるため、セッション中にネットワークリクエストを省くためにキャッシュを使用しても安全です。

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

アセットのカスタマイズ

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

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

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

たとえば、次のようなことができます：

一部のユーザーに別の画像や動画を表示する。
リモートのメイン画像の読み込み中に、ローカルのプレビュー画像を表示する。
動画を再生する前にプレビュー画像を表示する。

Important

この機能を使用するには、Adapty Android SDK をバージョン 3.7.0 以上にアップデートしてください。

カスタムアセットをシンプルな辞書で提供する方法の例を示します。

val customAssets = AdaptyCustomAssets.of(
    "hero_image" to
            AdaptyCustomImageAsset.remote(
                url = "https://example.com/image.jpg",
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromAsset("images/hero_image_preview.png"),
                )
            ),
    "hero_video" to
            AdaptyCustomVideoAsset.file(
                FileLocation.fromResId(requireContext(), R.raw.custom_video),
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromResId(requireContext(), R.drawable.video_preview),
                ),
            ),
)

val paywallView = AdaptyUI.getPaywallView(
    activity,
    viewConfiguration,
    products,
    eventListener,
    insets,
    customAssets,
)

Note

アセットが見つからない場合、ペイウォールはデフォルトの外観にフォールバックします。