フローとペイウォールの表示 - Unity
フローや旧ペイウォールビルダーで作成したペイウォールは、ユーザーに表示するためのレンダリングをアプリのコードで行う必要はありません。フローやペイウォールには、表示内容と表示方法の両方が含まれています。
このガイドは、Adapty がレンダリングするフローとペイウォールを対象としています。カスタムペイウォールや Observer モード の場合は手順が異なります。
- カスタムペイウォールを表示するには、カスタムペイウォールの表示を参照してください。
- Observer modeでフローを表示するには、Observer modeでのフローの表示を参照してください。
以下で使用するviewオブジェクトの取得方法については、フローとペイウォールの取得を参照してください。
フローまたはペイウォールを表示するには、CreateFlowView メソッドで作成した view に対して view.Present() メソッドを呼び出します。デフォルトでは、閉じた view は破棄されます。再度フローを表示するには、CreateFlowView をもう一度呼び出して新しい view インスタンスを作成するか、閉じる際に view を保持するようにしてください。
破棄された view を再利用するとエラーが発生します。
view.Present((error) => {
// handle the error
});Adapty SDK がモバイルアプリにどのように組み込まれているか、実際の例を見たいですか?ペイウォールの表示、購入処理、その他の基本的な機能を含むフルセットアップを示したサンプルアプリをご覧ください。
ビューを保持して再表示する
保持されたビューは SDK バージョン 4.3.0 以降で使用できます。
view.Dismiss() はビューをメモリから解放します。代わりにビューを保持するには、destroy パラメータに false を渡してください:
view.Dismiss(false, (error) => {
// handle the error
});そのビューを再表示すると、ユーザーはフローが構築した状態のまま、離れた画面に戻ります。ビューは Id を保持しているため、同じ view.Id でリスナーにイベントが届き続けます。
ビューを保持し続けるとメモリに残ります。不要になったら、view.Destroy() を呼び出してください:
view.Destroy((error) => {
// handle the error
});Destroy() は、ビューがまだ画面に表示されている場合は先に非表示にしてから破棄します。また、作成したがまだ表示していないビューや、iOS でユーザーが下にスワイプして閉じたページシートビューも解放できます。通常の Dismiss() の後に呼び出さないでください。そのビューはすでに解放されており、呼び出しは失敗します。
ユーザーが Close ボタンをタップしたときにビューを維持するには、Close アクションハンドラーで destroy: false を指定して閉じてください。FlowViewDidPerformAction メソッドはアプリ内のすべてのフローとペイウォールで実行されるため、再表示する予定のビューのみを保持するには view.Id を比較してください。ビューを作成するときにフィールドに保存しておくと、後で比較して再表示できます。
private AdaptyUIFlowView keptView;
void CreateKeptView(AdaptyFlow flow) {
AdaptyUI.CreateFlowView(flow, new AdaptyUICreateFlowViewParameters(), (view, error) => {
if (error != null) {
// handle the error
return;
}
keptView = view;
});
}
public void FlowViewDidPerformAction(
AdaptyUIFlowView view,
AdaptyUIUserAction action
) {
switch (action.Type) {
case AdaptyUIUserActionType.Close:
view.Dismiss(view.Id != keptView?.Id, null);
break;
default:
// handle other events
break;
}
}保持した view は、フローまたはペイウォールを再表示するときや、Destroy() で解放するときに必要です。keptView.Destroy() を呼び出したら、keptView を null に設定してください。そうしないと、上記の比較が解放済みのビューと一致してしまいます。なお、FlowViewDidReceiveError の呼び出しを含め、view.Dismiss() を呼び出すとビューが解放されます。ビューエラーが発生した場合は、CreateFlowView で新しいビューを作成してください。
ダイアログを表示する
Android でフローまたはペイウォールが表示されている場合は、ネイティブのアラートダイアログの代わりにこのメソッドを使用してください。Android では、通常のアラートがフロービューの背後に表示されるため、ユーザーには見えなくなります。このメソッドを使用することで、すべてのプラットフォームでフローの前面にダイアログが正しく表示されます。
var dialog = new AdaptyUIDialogConfiguration()
.SetTitle("Close this screen?")
.SetContent("You will lose access to exclusive offers.")
.SetDefaultActionTitle("Stay")
.SetSecondaryActionTitle("Close");
AdaptyUI.ShowDialog(view, dialog, (action, error) => {
if (error == null) {
if (action == AdaptyUIDialogActionType.Secondary) {
// User confirmed - close the flow
view.Dismiss((error) => {
// handle the error
});
}
// If primary - do nothing, user stays
}
});iOSの表示スタイルを設定する
Present()メソッドにiosPresentationStyleパラメータを渡すことで、iOSでのフローまたはペイウォールの表示スタイルを設定できます。このパラメータにはAdaptyUIIOSPresentationStyle.FullScreen(デフォルト)またはAdaptyUIIOSPresentationStyle.PageSheetを指定できます。
view.Present(AdaptyUIIOSPresentationStyle.PageSheet, (error) => {
// handle the error
});ユーザーはページシートを下にスワイプして閉じることができます。Dismiss() を呼び出さない場合、ビューはメモリに残ります。再度表示するか、SDK 4.3.0 以降では Destroy() で解放できます。
ペイウォールビルダーを使ってペイウォールをカスタマイズした場合、ユーザーに表示するためのレンダリングコードをアプリ側で書く必要はありません。このようなペイウォールには、表示する内容と表示方法の両方が含まれています。
このガイドは旧ペイウォールビルダーを対象としており、Adapty SDK 3.3.0 以降が必要です。
カスタムペイウォールを表示する場合は、カスタムペイウォールを表示するを参照してください。
ペイウォールを表示するには、CreatePaywallView メソッドで作成した view に対して view.Present() メソッドを呼び出します。各 view は一度しか使用できません。ペイウォールを再表示する必要がある場合は、CreatePaywallView をもう一度呼び出して新しい view インスタンスを作成してください。
同じ view を再作成せずに再利用すると、AdaptyUIError.viewAlreadyPresented エラーが発生する可能性があります。
view.Present((error) => {
// handle the error
});Adapty SDK がモバイルアプリにどのように組み込まれているか、実際の例を見たいですか?ペイウォールの表示、購入処理、その他の基本的な機能を含むフルセットアップを示したサンプルアプリをご覧ください。
ダイアログを表示する
Android でペイウォールビューが表示されている場合は、ネイティブのアラートダイアログの代わりにこのメソッドを使用してください。Android では、通常のアラートはペイウォールビューの背面に表示されるため、ユーザーには見えません。このメソッドを使用すると、すべてのプラットフォームでペイウォールの上に正しくダイアログが表示されます。
var dialog = new AdaptyUIDialogConfiguration()
.SetTitle("Close paywall?")
.SetContent("You will lose access to exclusive offers.")
.SetDefaultActionTitle("Stay")
.SetSecondaryActionTitle("Close");
AdaptyUI.ShowDialog(view, dialog, (action, error) => {
if (error == null) {
if (action == AdaptyUIDialogActionType.Secondary) {
// User confirmed - close the paywall
view.Dismiss();
}
// If primary - do nothing, user stays
}
});iOSプレゼンテーションスタイルを設定する
Present() メソッドに iosPresentationStyle パラメータを渡すことで、iOS でのペイウォールの表示スタイルを設定できます。パラメータには AdaptyUIIOSPresentationStyle.FullScreen(デフォルト)または AdaptyUIIOSPresentationStyle.PageSheet を指定できます。
view.Present(AdaptyUIIOSPresentationStyle.PageSheet, (error) => {
// handle the error
});