Unity SDKでカスタムペイウォールとプロダクトを取得する
カスタムペイウォールを表示する前に、ペイウォールに関する情報を取得する必要があります。このトピックはカスタムペイウォールに関するものです。Flow & Paywall Builder または old Paywall Builder でカスタマイズされたフローやペイウォールの取得方法については、フロー & ペイウォールの取得を参照してください。
Adapty SDK がモバイルアプリにどのように組み込まれているか、実際の例を見たいですか?ペイウォールの表示、購入処理、その他の基本的な機能を含むフルセットアップを示したサンプルアプリをご覧ください。
モバイルアプリでフローとプロダクトの取得を始める前に(クリックして展開)
-
Adapty ダッシュボードでプロダクトを作成します。
-
Adapty ダッシュボードでフローまたはペイウォールを作成し、プロダクトを組み込みます。
-
Adapty ダッシュボードでプレースメントを作成し、フローまたはペイウォールをプレースメントに組み込みます。
-
モバイルアプリにAdapty SDK をインストールします。
フローの情報を取得する
Adapty では、プロダクトは App Store と Google Play 両方のプロダクトを組み合わせたものです。これらのクロスプラットフォームプロダクトはフローやペイウォールに統合されており、モバイルアプリの特定のプレースメント内に表示することができます。
プロダクトを表示するには、GetFlow メソッドを使ってプレースメントのいずれかから AdaptyFlow を取得する必要があります。
プロダクト ID をハードコードしないでください。 ハードコードするのはプレースメント ID のみです。フローはリモートで設定されるため、プロダクトの数や利用可能なオファーはいつでも変更される可能性があります。アプリはこれらの変更を動的に処理する必要があります。今日はフローが 2 つのプロダクトを返し、明日は 3 つを返す場合でも、コードを変更せずにすべてを表示できるようにしてください。
Adapty.GetFlow(
"YOUR_PLACEMENT_ID",
AdaptyPlacementFetchPolicy.Default,
TimeSpan.FromSeconds(5),
(flow, error) => {
if (error != null) {
// handle the error
return;
}
// flow - the requested flow
}
);
| パラメーター | 必須/任意 | 説明 |
|---|---|---|
| placementId | 必須 | プレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。 |
| fetchPolicy | デフォルト: AdaptyPlacementFetchPolicy.Default |
ただし、ユーザーが不安定なインターネット環境にいると考えられる場合は、 3 番目のポリシー キャッシュはアプリを再起動しても保持され、アプリのアンインストール時または手動クリーンアップ時にのみクリアされます。 Adapty SDK はフローとペイウォールを 2 つのレイヤーに保存します: 上記で説明した定期更新キャッシュとフォールバックペイウォールです。また、フローとペイウォールをより速く取得するために CDN を使用し、CDN が到達不能な場合のスタンドアロンフォールバックサーバーも用意しています。このシステムは、インターネット接続が乏しい場合でも、常にフローとペイウォールの最新バージョンを取得できるよう信頼性を確保するために設計されています。 |
| loadTimeout | デフォルト: 5 秒 | この値はこのメソッドのタイムアウトを制限します。Adapty サーバーが時間内に応答しないかエラーを返した場合、SDK はキャッシュされたフローを返します。何もキャッシュされておらず、サーバーがタイムアウトまたはサーバーエラーを返した場合、SDK はフォールバックサーバー(プレースメントの All Users オーディエンスのみを提供する CDN コピー)からフローをリクエストします。最終手段として、SDK はフォールバックファイルからフローを返します。 この操作は内部で複数のリクエストで構成される場合があるため、まれにこのメソッドが |
ユーザーがフローを必要とする前にキャッシュを埋めるには、Adapty.PreloadFlows(Unity SDK 4.3.0+)を使って複数のプレースメントをまとめてプリロードしてください。AdaptyPlacementFetchPolicy.ReturnCacheDataElseLoad を渡すと、ネットワークを使う前にプリロード済みのキャッシュから読み込めます。
プロダクトIDをハードコードしないでください!フローはリモートで設定されるため、利用可能なプロダクト、プロダクトの数、特別オファー(無料トライアルなど)は随時変更される可能性があります。これらのシナリオにコードが対応できるようにしてください。
例えば、最初に2つのプロダクトを取得した場合、アプリはその2つのプロダクトを表示する必要があります。その後3つのプロダクトを取得した場合は、コードを変更することなく3つすべてを表示できる必要があります。ハードコードする必要があるのは、プレースメントIDのみです。
レスポンスパラメータ:
| パラメーター | 説明 |
|---|---|
| Flow | AdaptyFlow オブジェクト。フロー識別子、ペイウォールのバリエーション(Paywalls — それぞれ独自のプロダクト識別子を持つ)、RemoteConfigs リスト(設定済みロケールごとに1エントリ)、およびその他のプロパティを含みます。フローのプロダクトを取得するには、GetPaywallProducts(flow) を呼び出してください。 |
v4では、GetFlowにlocaleパラメーターはありません。CreateFlowViewでフローをレンダリングする際、ローカライゼーションは自動的に解決されます。カスタムペイウォールの場合、利用可能なすべてのロケールがflow.RemoteConfigsにまとめて返されます。ユーザーのデバイスやアプリの設定に合ったロケールを選択してください。詳細はローカライゼーションとロケールコードを参照してください。
プロダクトの取得
フローを取得したら、それに対応するプロダクトの配列を取得できます:
Adapty.GetPaywallProducts(flow, (products, error) => {
if (error != null) {
// handle the error
return;
}
// products - the requested products array
});レスポンスパラメーター:
| パラメータ | 説明 |
|---|---|
| Products | AdaptyPaywallProduct オブジェクトのリスト。プロダクト識別子、プロダクト名、価格、通貨、サブスクリプション期間、その他いくつかのプロパティを含みます。 |
独自のフロー設計を実装する際、AdaptyPaywallProduct オブジェクトのプロパティにアクセスする必要があります。以下に最もよく使用されるプロパティを示します。
| プロパティ | 説明 |
|---|---|
| Title | プロダクトのタイトルを表示するには、product.LocalizedTitle を使用します。なお、ローカライズはデバイスのロケールではなく、ユーザーが選択したストアの国に基づいて行われます。 |
| Price | ローカライズされた価格を表示するには、product.Price.LocalizedString を使用します。このローカライズはデバイスのロケール情報に基づきます。また、product.Price.Amount を使用して価格を数値として取得することもできます。値はローカル通貨で提供されます。対応する通貨記号を取得するには、product.Price.CurrencySymbol を使用します。 |
| Subscription Period | 期間(週、月、年など)を表示するには、product.Subscription?.LocalizedPeriod を使用します。このローカライズはデバイスのロケールに基づきます。サブスクリプション期間をプログラムで取得するには、product.Subscription?.Period を使用します。そこから Unit 列挙型にアクセスして長さを取得できます(AdaptySubscriptionPeriodUnit.Day、AdaptySubscriptionPeriodUnit.Week、AdaptySubscriptionPeriodUnit.Month、AdaptySubscriptionPeriodUnit.Year、または AdaptySubscriptionPeriodUnit.Unknown)。NumberOfUnits の値で期間の単位数を取得できます。たとえば四半期ごとのサブスクリプションの場合、Unit プロパティには AdaptySubscriptionPeriodUnit.Month、NumberOfUnits プロパティには 3 が表示されます。 |
| Billing plan | iOS のみ。12か月コミットメントプロダクトの場合、product.Subscription?.PricingTerms を使用して Apple が要求する2つの価格を表示します。月払いの場合は BillingPrice.LocalizedString と BillingPeriod、年間合計の場合は CommitmentInfo.Price.LocalizedString と CommitmentInfo.Period を使用します。BillingPlan はコミットメントプランの場合 AdaptySubscriptionBillingPlan.Monthly、それ以外の場合は AdaptySubscriptionBillingPlan.UpFront となります。コミットメントプランでは、product.Price と product.Subscription?.Period は月払いの金額・期間ではなく、年間合計の金額と期間を返します。Android では PricingTerms は null になります。Adapty SDK 4.3.0 以降が必要です。 |
| Introductory Offer | サブスクリプションに初回オファーが含まれていることを示すバッジなどを表示するには、product.Subscription?.Offer?.Phases プロパティを確認してください。これは最大2つの割引フェーズ(無料トライアルフェーズと初回価格フェーズ)を含むことができるリストです。各フェーズオブジェクトには以下の便利なプロパティがあります:• PaymentMode:AdaptyPaymentMode.FreeTrial、AdaptyPaymentMode.PayAsYouGo、AdaptyPaymentMode.PayUpFront、AdaptyPaymentMode.Unknown の値を持つ列挙型。無料トライアルは AdaptyPaymentMode.FreeTrial タイプになります。• Price:割引価格を持つ AdaptyPrice オブジェクト。数値として取得するには Price.Amount、表示するには Price.LocalizedString を使用します。無料トライアルの場合は Price.Amount に 0 が入ります。• LocalizedNumberOfPeriods:オファーの長さをデバイスのロケールでローカライズした文字列。たとえば3日間のトライアルオファーの場合、このフィールドには "3 days" が表示されます。• SubscriptionPeriod:オファー期間の個別の詳細をこのプロパティで取得することもできます。オファーについても前のセクションと同様の方法で機能します。• LocalizedSubscriptionPeriod:ユーザーのロケールに合わせてフォーマットされた割引のサブスクリプション期間。 |
デフォルトオーディエンスフローによるフロー取得の高速化
通常、フローの取得はほぼ瞬時に行われるため、この処理を高速化することを特に気にする必要はありません。ただし、オーディエンスやプレースメントの数が多く、ユーザーのインターネット接続が不安定な場合は、フローの取得に予想以上の時間がかかることがあります。そのような状況では、何も表示しないよりもスムーズなユーザー体験を提供するために、デフォルトのフローを表示したい場合があるでしょう。
これに対処するには、GetFlowForDefaultAudience メソッドを使用できます。このメソッドは、指定されたプレースメントの All Users オーディエンス向けフローを取得します。ただし、推奨されるアプローチは GetFlow メソッドでフローを取得することであり、詳細は上記の フロー情報の取得 セクションを参照してください。
GetFlow を推奨する理由
GetFlowForDefaultAudience メソッドにはいくつかの重大な欠点があります:
- 後方互換性の問題: 異なるアプリバージョン(現行バージョンと将来のバージョン)で異なるフローを表示する必要がある場合、課題が生じる可能性があります。現行(レガシー)バージョンに対応したフローを設計するか、現行(レガシー)バージョンのユーザーがレンダリングされないフローで問題に遭遇することを受け入れるかのどちらかになります。
- ターゲティングの喪失: すべてのユーザーが All Users オーディエンス向けに設計された同一のフローを見ることになり、国、マーケティングのアトリビューション、または独自のカスタム属性に基づくパーソナライズされたターゲティングが失われます。
これらのデメリットを受け入れてでも高速なフローフェッチのメリットを活用したい場合は、以下のように GetFlowForDefaultAudience メソッドを使用してください。そうでない場合は、上記の GetFlow を使用してください。
Adapty.GetFlowForDefaultAudience(
"YOUR_PLACEMENT_ID",
AdaptyPlacementFetchPolicy.Default,
(flow, error) => {
if (error != null) {
// handle the error
return;
}
// flow - the requested flow
}
);
| パラメーター | 必須/任意 | 説明 |
|---|---|---|
| placementId | 必須 | プレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。 |
| fetchPolicy | デフォルト: AdaptyPlacementFetchPolicy.Default |
ただし、ユーザーが不安定なインターネット環境にいると思われる場合は、 3つ目のポリシー キャッシュはアプリを再起動しても保持され、アプリの再インストールまたは手動クリーンアップ時にのみ削除されます。 |
カスタムペイウォールを表示する前に、それらに関する情報を取得する必要があります。このトピックはカスタムペイウォールに関するものです。ペイウォールビルダーでカスタマイズされたペイウォールの取得方法については、ペイウォールビルダーのペイウォールと設定の取得を参照してください。
Adapty SDK がモバイルアプリにどのように組み込まれているか、実際の例を見たいですか?ペイウォールの表示、購入処理、その他の基本的な機能を含むフルセットアップを示したサンプルアプリをご覧ください。
モバイルアプリでペイウォールとプロダクトの取得を開始する前に(クリックして展開)
-
Adapty ダッシュボードでプロダクトを作成します。
-
ペイウォールを作成し、プロダクトをペイウォールに組み込む(Adapty ダッシュボード内)。
-
プレースメントを作成し、ペイウォールをプレースメントに組み込む(Adapty ダッシュボード内)。
-
Adapty SDK をインストールする(モバイルアプリ内)。
ペイウォール情報の取得
Adaptyでは、プロダクトはApp StoreとGoogle Play両方のプロダクトを組み合わせたものです。これらのクロスプラットフォームプロダクトはペイウォールに統合され、特定のモバイルアプリのプレースメント内で表示できます。
プロダクトを表示するには、getPaywall メソッドを使ってプレースメントのいずれかからペイウォールを取得する必要があります。
プロダクトIDをハードコードしないでください。 ハードコードすべき唯一のIDはプレースメントIDです。ペイウォールはリモートで設定されるため、プロダクトの数や利用可能なオファーはいつでも変わる可能性があります。アプリはこれらの変更を動的に処理する必要があります。今日ペイウォールが2つのプロダクトを返し、明日3つ返しても、コード変更なしにすべて表示できるようにしてください。
Adapty.GetPaywall("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
if(error != null) {
// handle the error
return;
}
// paywall - the resulting object
});
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| placementId | 必須 | プレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。 |
| locale | 任意 デフォルト: | ペイウォールのローカライゼーションの識別子。このパラメータは、マイナス(-)文字で区切られた1つ以上のサブタグで構成される言語コードを指定します。最初のサブタグは言語、2番目のサブタグは地域を表します。 例: ロケールコードおよび推奨する使用方法については、ローカライゼーションとロケールコードを参照してください。 |
| fetchPolicy | デフォルト: AdaptyPlacementFetchPolicy.Default |
ただし、ユーザーが不安定なインターネット環境を使用していると考えられる場合は、 3番目のポリシー キャッシュはアプリを再起動しても保持され、アプリのアンインストール時または手動でクリーンアップした場合のみ削除されます。 Adapty SDK はペイウォールを2つのレイヤーで保存します: 上述の定期更新されるキャッシュとフォールバックペイウォールです。また、ペイウォールをより高速に取得するために CDN を使用し、CDN が到達不能な場合に備えてスタンドアロンのフォールバックサーバーも用意しています。このシステムは、インターネット接続が不安定な場合でも信頼性を確保しながら、常に最新バージョンのペイウォールを取得できるよう設計されています。 |
| loadTimeout | デフォルト: 5秒 | このメソッドのタイムアウト時間を制限する値です。Adapty サーバーが時間内に応答しないか、エラーを返した場合、SDK はフォールバックサーバー(プレースメントの All Users オーディエンスのみを提供する CDN コピー)、キャッシュ、またはフォールバックファイルからペイウォールを返します。 このメソッドは内部で複数のリクエストが実行される場合があるため、まれに |
プロダクトIDはハードコードしないでください!ペイウォールはリモートで設定されるため、利用可能なプロダクト、プロダクトの数、特典(無料トライアルなど)は時間とともに変わる場合があります。これらのシナリオをコードで処理するようにしてください。
例えば、最初に2つのプロダクトを取得した場合、アプリはその2つを表示します。後で3つのプロダクトを取得した場合も、コード変更なしにすべての3つを表示できるようにしてください。ハードコードが必要なのはプレースメントIDだけです。
レスポンスパラメータ:
| パラメータ | 説明 |
|---|---|
| Paywall | プロダクトIDのリスト、ペイウォール識別子、リモートコンフィグ、その他いくつかのプロパティを含む AdaptyPaywall オブジェクト。 |
プロダクトの取得
ペイウォールを取得したら、対応するプロダクト配列を取得できます:
Adapty.GetPaywallProducts(paywall, (products, error) => {
if(error != null) {
// handle the error
return;
}
// products - the requested products array
});レスポンスパラメータ:
| パラメータ | 説明 |
|---|---|
| Products | プロダクト識別子、プロダクト名、価格、通貨、サブスクリプション期間、その他いくつかのプロパティを含む AdaptyPaywallProduct オブジェクトのリスト。 |
独自のペイウォールデザインを実装する場合、AdaptyPaywallProduct オブジェクトのプロパティへのアクセスが必要になるでしょう。以下によく使用されるプロパティを示しますが、すべての利用可能なプロパティの詳細はリンク先のドキュメントを参照してください。
| プロパティ | 説明 |
|---|---|
| Title | プロダクトのタイトルを表示するには、product.LocalizedTitle を使用します。ローカライズはデバイスのロケールではなく、ユーザーが選択したストアの国に基づいて行われます。 |
| Price | ローカライズされた価格を表示するには、product.Price.LocalizedString を使用します。このローカライズはデバイスのロケール情報に基づいています。product.Price.Amount を使用して数値として価格を取得することもできます。値はローカル通貨で提供されます。関連する通貨記号を取得するには、product.Price.CurrencySymbol を使用します。 |
| Subscription Period | 期間(週、月、年など)を表示するには、product.Subscription?.LocalizedPeriod を使用します。このローカライズはデバイスのロケールに基づいています。サブスクリプション期間をプログラムで取得するには、product.Subscription?.Period を使用します。そこから Unit 列挙型にアクセスして長さを取得できます(AdaptySubscriptionPeriodUnit.Day、AdaptySubscriptionPeriodUnit.Week、AdaptySubscriptionPeriodUnit.Month、AdaptySubscriptionPeriodUnit.Year、または AdaptySubscriptionPeriodUnit.Unknown)。NumberOfUnits の値で期間単位の数を取得できます。たとえば、四半期ごとのサブスクリプションの場合、Unit プロパティに AdaptySubscriptionPeriodUnit.Month、NumberOfUnits プロパティに 3 が表示されます。 |
| Introductory Offer | サブスクリプションに初回オファーが含まれていることを示すバッジなどのインジケーターを表示するには、product.Subscription?.Offer?.Phases プロパティを確認してください。これは最大2つの割引フェーズ(無料トライアルフェーズと初回価格フェーズ)を含むことができるリストです。各フェーズオブジェクトには以下の便利なプロパティが含まれています:• PaymentMode:AdaptyPaymentMode.FreeTrial、AdaptyPaymentMode.PayAsYouGo、AdaptyPaymentMode.PayUpFront、AdaptyPaymentMode.Unknown の値を持つ列挙型。無料トライアルは AdaptyPaymentMode.FreeTrial タイプになります。• Price:割引価格を含む AdaptyPrice オブジェクト — 数値には Price.Amount、表示には Price.LocalizedString を使用します。無料トライアルの場合は Price.Amount が 0 になります。• LocalizedNumberOfPeriods:デバイスのロケールを使用してローカライズされた、オファーの長さを説明する文字列。たとえば、3日間のトライアルオファーの場合、このフィールドには "3 days" が表示されます。• SubscriptionPeriod:あるいは、このプロパティでオファー期間の個別の詳細を取得できます。オファーに対して前のセクションで説明したものと同じ方法で機能します。• LocalizedSubscriptionPeriod:ユーザーのロケールに合わせてフォーマットされた割引のサブスクリプション期間。 |
デフォルトオーディエンスペイウォールでペイウォール取得を高速化する
通常、ペイウォールはほぼ即座に取得されるため、このプロセスを高速化することを心配する必要はありません。ただし、多数のオーディエンスやペイウォールがあり、ユーザーのインターネット接続が弱い場合、ペイウォールの取得に予想以上の時間がかかることがあります。そのような状況では、ペイウォールをまったく表示しないよりも、デフォルトのペイウォールを表示してスムーズなユーザー体験を確保したい場合があります。
この問題を解決するには、GetPaywallForDefaultAudience メソッドを使用できます。このメソッドは、指定されたプレースメントの All Users オーディエンス向けペイウォールを取得します。ただし、推奨されるアプローチは、上記のペイウォールの取得セクションで説明した getPaywall メソッドを使用することです。
GetPaywallForDefaultAudience の代わりに GetPaywall の使用を検討してください。前者には次のような重要な制限があります:
- 互換性の問題: 複数のアプリバージョンをサポートする際に問題が生じる可能性があり、後方互換性のある設計が必要になるか、古いバージョンでは正しく表示されない場合があります。
- パーソナライズなし: 「すべてのユーザー」オーディエンス向けのコンテンツのみが表示され、国・アトリビューション・カスタム属性に基づいたターゲティングは利用できません。
これらのデメリットよりも高速なフェッチが優先されるユースケースでは、以下に示すように GetPaywallForDefaultAudience を使用してください。それ以外の場合は、上記で説明した GetPaywall を使用してください。
Adapty.GetPaywallForDefaultAudience("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
if(error != null) {
// handle the error
return;
}
// paywall - the resulting object
});パラメータ:
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| placementId | 必須 | 対象のプレースメントの識別子。Adapty ダッシュボードでプレースメントを作成する際に指定した値です。 |
| locale | 任意 デフォルト: | ペイウォールのローカライズ識別子。このパラメータは、マイナス(-)で区切られた1つまたは2つのサブタグで構成される言語コードを指定します。最初のサブタグは言語、2番目は地域を表します。 例: |
| fetchPolicy | デフォルト: AdaptyPlacementFetchPolicy.Default |
ただし、ユーザーがインターネット接続が不安定な状況に置かれていると考える場合は、 3つ目のポリシー キャッシュはアプリを再起動しても保持され、アプリの再インストール時または手動でのクリア時にのみ削除されます。 Adapty SDK はペイウォールをローカルに2つのレイヤーで保存します。上記の定期更新キャッシュとフォールバックペイウォールです。また、ペイウォールをより高速に取得するためにCDNを使用し、CDNに接続できない場合に備えてスタンドアロンのフォールバックサーバーも用意しています。このシステムは、インターネット接続が不安定な状況でも信頼性を確保しながら、常に最新バージョンのペイウォールを取得できるよう設計されています。 |