フローとペイウォールを表示する - Android

Display flows and paywalls
✦
フロー Flow & Paywall Builder で作成——デバイス上でネイティブにレンダリングされ、WebView は不要
✦
旧 Paywall Builder のペイウォール 旧 Paywall Builder で作成された既存のすべてのコンテンツ

フローや旧ペイウォールビルダーで作成したペイウォールがある場合、それをモバイルアプリのコードでレンダリングしてユーザーに表示する方法について心配する必要はありません。そのようなフローやペイウォールには、表示する内容と表示方法の両方が含まれています。

Warning

このガイドは、Adapty がレンダリングするフローとペイウォールを対象としています。カスタムペイウォールや Observer モード の場合は、プロセスが異なります。

以下で使用する flowConfiguration オブジェクトの取得方法は、フロー&ペイウォールの取得を参照してください。

リクエストパラメーター:

パラメーター必須/任意説明
flowConfiguration必須フローの視覚的な詳細を含む AdaptyUI.FlowConfiguration オブジェクトを指定します。AdaptyUI.getFlowConfiguration(flow) メソッドを使って読み込んでください。詳細は ビュー設定の取得 を参照してください。
products任意画面上のプロダクト表示タイミングを最適化するために AdaptyPaywallProduct の配列を指定します。null を渡した場合、AdaptyUI が必要なプロダクトを自動的に取得します。
eventListener任意フローイベントを監視するために AdaptyFlowEventListener を指定します。使いやすさのため AdaptyFlowDefaultEventListener を継承することをおすすめします。詳細は フロー・ペイウォールイベントの処理 を参照してください。
insets任意

インセットはフローの周囲のスペースで、タップ可能な要素がシステムバーの裏に隠れるのを防ぎます。

デフォルトは Unspecified で、Adapty が自動的にインセットを調整します。これはエッジトゥエッジのフローに適しています。

フローがエッジトゥエッジでない場合は、カスタムインセットを設定することをおすすめします。設定方法は以下の フローインセットの変更 セクションを参照してください。

customAssets任意AdaptyCustomAssets オブジェクトを渡すと、フローやペイウォール内の画像・動画を実行時に置き換えられます。詳細は アセットのカスタマイズ を参照してください。
tagResolver任意フローの カスタムタグ に対してアプリの値を返す AdaptyUiTagResolver です。詳細は フローへのデータの受け渡し を参照してください。
timerResolver任意フロー内の Developer defined タイマーの終了日をタイマー ID で返す AdaptyUiTimerResolver です。デフォルトは AdaptyUiTimerResolver.Default で、画面を開いてから1時間のカウントダウンを行います。詳細は 開発者定義タイマーの使用 を参照してください。
customElementsResolver

任意

SDK 4.4+

フローの カスタムエレメント に対してアプリのネイティブビューを返す AdaptyCustomElementsResolver です。このフロービューではアプリ全体のリゾルバーを上書きします。詳細は カスタムエレメントの表示 を参照してください。
Tip

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

フローのインセットを変更する

インセットとは、フローの周囲の余白のことで、タップ可能な要素がシステムバーの後ろに隠れないようにするためのものです。デフォルトでは Adapty がインセットを自動的に調整するため、エッジツーエッジのフローでも問題なく機能します。

フローがエッジツーエッジでない場合は、カスタムインセットを設定することをお勧めします。

  • ステータスバーとナビゲーションバーのどちらも AdaptyFlowView と重ならない場合は、AdaptyFlowInsets.None を使用してください。
  • フローが上部のステータスバーとは重なるが下部とは重ならないといった複雑な設定の場合は、以下の例のように bottomInset のみを 0 に設定できます。

デベロッパー定義タイマーを使用する

このセクションは、フロー&ペイウォールビルダーで Developer defined の動作を設定したタイマーに使用します。ビルダーでは、各タイマーに Timer ID があり(アプリに終了日を設定させるを参照)、アプリがその終了日を設定します。ビルダーと同じ Timer ID をコードで使用してください。大文字・小文字やスペースを含め、一字一句同じである必要があります。ID が異なると、タイマーはアプリから終了日を受け取れません。

エンドデートを設定するには、AdaptyUiTimerResolver を作成します。これはタイマー ID ごとにエンドデート(Date)を返します。以下に例を示します:

timerResolver を AdaptyUI.getFlowView、AdaptyFlowView.showFlow、または AdaptyFlowScreen に渡してください。このページの冒頭にある例を参考にしてください。

この例では、CUSTOM_TIMER_NY はビルダーで設定された 開発者定義 タイマーのタイマー ID です。このタイマーは、次の元日までの残り時間(例:13d 09h 03m 34s)を表示します。

SDK は、タイマーが表示されている画面が開くたびにリゾルバーを呼び出します。リゾルバーが過去の日時を返した場合、タイマーはすぐにゼロを表示し、On timer end トリガーが実行されます。リゾルバーを渡さない場合に SDK が使用する AdaptyUiTimerResolver.Default は、画面が開いてから1時間のカウントダウンを行います。

カスタムタグを使用する

フロー内の各カスタムタグに対してアプリの値を返す AdaptyUiTagResolver を作成します:

この例では、username はフロー内のカスタムタグの名前です。ユーザーにはタグの代わりに「DragonSlayer42」が表示されます。

リゾルバーは AdaptyUI.getFlowView、AdaptyFlowView.showFlow、または AdaptyFlowScreen の tagResolver パラメーターに渡してください。

フローの読み込みインジケーターの色を変更する

次の方法で、読み込みインジケーターのデフォルトカラーをオーバーライドできます。


<style name="AppTheme" parent="android:Theme.Material.Light.NoActionBar">

    <item name="adapty_progressIndicatorColor">@color/yourColor</item>
</style>

ペイウォールビルダーを使ってペイウォールをカスタマイズした場合、モバイルアプリのコード内でそのペイウォールをレンダリングしてユーザーに表示する処理は不要です。このようなペイウォールには、表示するコンテンツと表示方法の両方が含まれています。

Warning

このガイドは、Adapty SDK 3.x 向けの旧ペイウォールビルダーで作成されたペイウォールのみを対象としています。SDK v3.0 が必要です。SDK 2.x 以前向けに作成されたペイウォール、カスタムペイウォール、または Observer モードのペイウォールの表示方法は異なります。

以下で使用する viewConfiguration オブジェクトの取得方法については、ペイウォールビルダーのペイウォールと設定の取得を参照してください。

リクエストパラメーター:

パラメータ必須/任意説明
viewConfiguration必須ペイウォールのビジュアル情報を含む AdaptyUI.LocalizedViewConfiguration オブジェクトを指定します。取得には Adapty.getViewConfiguration(paywall) メソッドを使用してください。詳しくは ペイウォールのビジュアル設定の取得 をご覧ください。
products任意画面上のプロダクト表示タイミングを最適化するために AdaptyPaywallProduct の配列を指定します。null を渡した場合、AdaptyUI が必要なプロダクトを自動的に取得します。
eventListener任意ペイウォールのイベントを監視するために AdaptyUiEventListener を指定します。使いやすさの観点から、AdaptyUiDefaultEventListener を継承することを推奨します。詳しくは ペイウォールイベントの処理 をご覧ください。
insets任意

インセットは、タップ可能な要素がシステムバーの後ろに隠れないようにするためのペイウォール周囲のスペースです。

デフォルト値は UNSPECIFIED で、Adapty がインセットを自動調整します。これはエッジツーエッジのペイウォールに最適です。

ペイウォールがエッジツーエッジでない場合は、カスタムインセットを設定することをお勧めします。設定方法については、以下の ペイウォールインセットの変更 セクションをご覧ください。

personalizedOfferResolver任意パーソナライズされた価格表示(詳細)を示すには、AdaptyUiPersonalizedOfferResolver を実装し、AdaptyPaywallProduct に対してその価格がパーソナライズされている場合は true、そうでない場合は false を返す独自のロジックを渡します。
tagResolver任意ペイウォールテキスト内のカスタムタグを解決するには AdaptyUiTagResolver を使用します。このリゾルバはタグパラメータを受け取り、対応する文字列に変換します。詳しくはペイウォールビルダーのカスタムタグのトピックをご覧ください。
timerResolver任意カスタムタイマー機能を使用する場合は、ここにリゾルバを渡してください。
Tip

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

ペイウォールのインセットを変更する

インセットとは、システムバーの裏側にタップ可能な要素が隠れないようにするための、ペイウォール周囲のスペースのことです。デフォルトでは、Adapty がインセットを自動的に調整します。これはエッジツーエッジのペイウォールではうまく機能します。

ペイウォールがエッジツーエッジでない場合は、カスタムインセットを設定することをお勧めします。

  • ステータスバーとナビゲーションバーの両方がAdaptyPaywallViewと重ならない場合は、AdaptyPaywallInsets.NONEを使用してください。
  • ペイウォールが上部のステータスバーとは重なるが下部とは重ならないといったカスタム設定の場合は、以下の例のようにbottomInsetのみを0に設定できます。

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

モバイルアプリで開発者定義タイマーを使用するには、timerResolver オブジェクトを作成します。これは、カスタムタイマーとペイウォールのレンダリング時に置き換えられる文字列値をペアにした辞書またはマップです。以下に例を示します:

この例では、CUSTOM_TIMER_NY は Adapty ダッシュボードで設定した開発者定義タイマーの Timer ID です。timerResolver により、アプリは正しい値(例:New Year’s Day などのタイマー終了時刻から現在時刻を引いて計算した 13d 09h 03m 34s)でタイマーを動的に更新します。

カスタムタグを使う

モバイルアプリでカスタムタグを使用するには、tagResolver オブジェクト(カスタムタグとペイウォール表示時に置換される文字列値を対応付けるディクショナリまたはマップ)を作成します。以下に例を示します。

この例では、USERNAME は Adapty ダッシュボードで <USERNAME/> として入力したカスタムタグです。tagResolver によって、アプリがこのカスタムタグを John のような指定した値に動的に置き換えます。

tagResolver はペイウォールを表示する直前に作成・設定することをおすすめします。準備ができたら、ペイウォールを表示するために使用する AdaptyUI メソッドに渡してください。

ローディングインジケーターの色を変更する

ローディングインジケーターのデフォルト色は、以下の方法で上書きできます。


<style name="AppTheme" parent="android:Theme.Material.Light.NoActionBar">

    <item name="adapty_progressIndicatorColor">@color/yourColor</item>
</style>