Flutter SDK のリモートコンフィグペイウォールでペイウォールとプロダクトを取得する

リモートコンフィグとカスタムペイウォールを表示する前に、それらに関する情報を取得する必要があります。このトピックはリモートコンフィグとカスタムペイウォールに関するものです。フローおよびペイウォールビルダーでカスタマイズされたペイウォールの取得については、フローとペイウォールを取得するを参照してください。

モバイルアプリでペイウォールとプロダクトの取得を開始する前に（クリックして展開）

1. Adapty ダッシュボードでプロダクトを作成する。

2. ペイウォールを作成し、プロダクトをペイウォールに組み込む（Adapty ダッシュボード）

3. プレースメントを作成し、ペイウォールをプレースメントに組み込む（Adapty ダッシュボード）

4. Adapty SDK をインストールする（モバイルアプリ）

フローの情報を取得する

Adapty では、プロダクトは App Store と Google Play 両方のプロダクトを組み合わせたものです。これらのクロスプラットフォームのプロダクトはペイウォールに統合され、モバイルアプリの特定のプレースメントで表示できるようになります。

プロダクトを表示するには、getFlow メソッドを使ってプレースメントの一つから AdaptyFlow を取得する必要があります。

try {
  final flow = await Adapty().getFlow(placementId: 'YOUR_PLACEMENT_ID');
  // the requested flow
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
  // handle the error
}

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

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

パラメーター	説明
Flow	フローの識別子（instanceIdentity、variationId）、名前、プレースメント、ペイウォールのバリアント（paywalls）、リモートコンフィグ（remoteConfigs）を含む AdaptyFlow オブジェクト。

プロダクトの取得

フローを取得したら、それに対応するプロダクトの配列を取得できます。

try {
  final products = await Adapty().getPaywallProducts(flow: flow);
  // the requested products array
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
  // handle the error
}

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

パラメータ	説明
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 列挙型にアクセスして、長さ（day、week、month、year、または unknown）を取得できます。numberOfUnits の値は期間ユニット数を返します。例えば、四半期サブスクリプションの場合、unit プロパティには AdaptyPeriodUnit.month、numberOfUnits プロパティには 3 が設定されます。
Introductory Offer	サブスクリプションに初回オファーが含まれているかどうかをバッジなどで表示するには、product.subscription?.offer?.phases プロパティを確認してください。これはリストで、フリートライアルフェーズと初回価格フェーズの最大2つの割引フェーズを含めることができます。各フェーズオブジェクトには以下の便利なプロパティがあります： • paymentMode：AdaptyPaymentMode.freeTrial、AdaptyPaymentMode.payAsYouGo、AdaptyPaymentMode.payUpFront、AdaptyPaymentMode.unknown の値を持つ列挙型です。フリートライアルは AdaptyPaymentMode.freeTrial タイプになります。 • price：割引価格を数値で表します。フリートライアルの場合は 0 になります。 • localizedNumberOfPeriods：オファーの期間をデバイスのロケールでローカライズした文字列です。例えば、3日間のトライアルオファーの場合、このフィールドには 3 days と表示されます。 • subscriptionPeriod：オファー期間の個別の詳細をこのプロパティで取得することもできます。オファーに対しても前のセクションで説明したのと同じ方法で機能します。 • localizedSubscriptionPeriod：ユーザーのロケールに合わせてフォーマットされた割引のサブスクリプション期間です。

デフォルトオーディエンスフローによるフロー取得の高速化

通常、フローはほぼ瞬時に取得されるため、この処理を高速化することを特に気にする必要はありません。ただし、オーディエンスやプレースメントの数が多く、ユーザーのインターネット接続が不安定な場合、フローの取得に予想以上の時間がかかることがあります。そのような状況では、何も表示しないよりも、デフォルトのフローを表示してスムーズなユーザー体験を確保したい場合があるでしょう。 これに対処するために、getFlowForDefaultAudience メソッドを使用できます。このメソッドは、指定されたプレースメントの All Users オーディエンス向けフローを取得します。ただし、推奨されるアプローチは getFlow メソッドを使用してフローを取得することであり、詳細は上記のフロー情報の取得セクションをご覧ください。

try {
  final flow = await Adapty().getFlowForDefaultAudience(placementId: 'YOUR_PLACEMENT_ID');
  // the requested flow
} on AdaptyError catch (adaptyError) {
  // handle error
} catch (e) {
  // handle unknown error
}

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

リモートコンフィグとカスタムペイウォールを表示する前に、それらの情報を取得する必要があります。このトピックはリモートコンフィグとカスタムペイウォールに関するものです。ペイウォールビルダーでカスタマイズされたペイウォールの取得については、ペイウォールビルダーのペイウォールと設定の取得を参照してください。

モバイルアプリでペイウォールとプロダクトの取得を始める前に（クリックして展開）

1. Adapty ダッシュボードでプロダクトを作成する。

2. ペイウォールを作成し、プロダクトをペイウォールに組み込む（Adapty ダッシュボードで行います）。

3. プレースメントを作成し、ペイウォールをプレースメントに組み込む（Adapty ダッシュボードで行います）。

4. Adapty SDK をインストールする（モバイルアプリに導入します）。

ペイウォール情報の取得

Adapty では、プロダクトはApp StoreとGoogle Play両方のプロダクトを組み合わせたものです。これらのクロスプラットフォームのプロダクトはペイウォールに組み込まれており、モバイルアプリの特定のプレースメント内でユーザーに表示できます。

プロダクトを表示するには、getPaywall メソッドを使ってプレースメントからペイウォールを取得する必要があります。

try {
  final paywall = await Adapty().getPaywall(placementId: "YOUR_PLACEMENT_ID", locale: "en");
  // the requested paywall
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
}

パラメーター	必須/任意	説明
placementId	必須	プレースメントの識別子です。Adapty ダッシュボードでプレースメントを作成する際に指定した値を使用します。
locale	任意 デフォルト: en	ペイウォールのローカライゼーションの識別子です。このパラメーターは、マイナス（-）文字で区切られた1つ以上のサブタグで構成される言語コードである必要があります。最初のサブタグは言語を、2番目のサブタグは地域を表します。 例: en は英語、pt-br はブラジルポルトガル語を表します。 ロケールコードおよびその推奨使用方法については、ローカライゼーションとロケールコードを参照してください。
fetchPolicy	デフォルト: .reloadRevalidatingCacheData	デフォルトでは、SDK はサーバーからデータの読み込みを試み、失敗した場合はキャッシュされたデータを返します。ユーザーが常に最新のデータを受け取れるため、この設定を推奨します。 ただし、ユーザーがネットワークの不安定な環境にいることが多いと判断した場合は、.returnCacheDataElseLoad を使用してキャッシュが存在するときにキャッシュデータを返すことを検討してください。この場合、最新データを取得できないことがありますが、ネットワーク状況に関わらず読み込みが速くなります。キャッシュは定期的に更新されるため、セッション中にネットワークリクエストを避けるために使用しても問題ありません。 キャッシュはアプリを再起動しても保持され、アプリのアンインストール時または手動でクリアした場合にのみ削除されます。 Adapty SDK はペイウォールを2層で保存します。1つは上記の定期更新されるキャッシュ、もう1つはフォールバックペイウォールです。また、ペイウォールをより速く取得するためにCDNを使用し、CDNが利用できない場合に備えてスタンドアロンのフォールバックサーバーも用意しています。このシステムは、インターネット接続が不安定な状況でも信頼性を確保しながら、常に最新のペイウォールを取得できるように設計されています。
loadTimeout	デフォルト: 5秒	このメソッドのタイムアウト時間を制限します。タイムアウトに達した場合、キャッシュデータまたはローカルフォールバックが返されます。 内部で複数のリクエストが実行される場合があるため、まれに loadTimeout で指定した時間よりわずかに遅れてタイムアウトすることがあります。
プロダクトIDをハードコードしないでください！ペイウォールはリモートで設定されるため、利用可能なプロダクト、プロダクト数、特典（無料トライアルなど）は随時変更される可能性があります。これらのシナリオにコードが対応できるようにしてください。

たとえば、最初に2つのプロダクトを取得した場合、アプリはその2つを表示します。しかし、後で3つのプロダクトを取得した場合は、コードを変更することなく3つすべてを表示できるようにする必要があります。ハードコードが必要なのはプレースメントIDだけです。

レスポンスパラメータ：

パラメータ	説明
Paywall	AdaptyPaywall オブジェクト。プロダクト ID のリスト、ペイウォール識別子、リモートコンフィグ、その他いくつかのプロパティを含みます。

プロダクトを取得する

ペイウォールを取得したら、それに対応するプロダクトの配列を取得できます：

try {
  final products = await Adapty().getPaywallProducts(paywall: paywall);
  // the requested products array
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
}

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

パラメーター	説明
Products	AdaptyPaywallProduct オブジェクトのリスト。プロダクト識別子、プロダクト名、価格、通貨、サブスクリプション期間、その他複数のプロパティを含みます。
独自のペイウォールデザインを実装する際、AdaptyPaywallProduct オブジェクトから以下のプロパティにアクセスする必要があります。よく使われるプロパティを以下に示しますが、利用可能なすべてのプロパティの詳細については、リンク先のドキュメントを参照してください。
プロパティ	説明
-------------------------	----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
タイトル	プロダクトのタイトルを表示するには、product.localizedTitle を使用します。ローカライズはデバイスのロケールではなく、ユーザーが選択したストアの国に基づいています。
価格	ローカライズされた価格を表示するには、product.price.localizedString を使用します。このローカライズはデバイスのロケール情報に基づいています。product.price.amount を使用して価格を数値として取得することもできます。値はローカル通貨で提供されます。関連する通貨記号を取得するには、product.price.currencySymbol を使用します。
サブスクリプション期間	期間（週、月、年など）を表示するには、product.subscription?.localizedPeriod を使用します。このローカライズはデバイスのロケールに基づいています。サブスクリプション期間をプログラムで取得するには、product.subscription?.period を使用します。そこから unit 列挙型にアクセスして長さ（day、week、month、year、または unknown）を取得できます。numberOfUnits の値で期間の単位数を取得できます。たとえば、四半期ごとのサブスクリプションの場合、unit プロパティに AdaptyPeriodUnit.month、numberOfUnits プロパティに 3 が表示されます。
初回オファー	サブスクリプションに初回オファーが含まれていることを示すバッジやインジケーターを表示するには、product.subscription?.offer?.phases プロパティを確認します。これは最大2つの割引フェーズ（無料トライアルフェーズと初回価格フェーズ）を含むリストです。各フェーズオブジェクトには以下の便利なプロパティが含まれています： • paymentMode：AdaptyPaymentMode.freeTrial、AdaptyPaymentMode.payAsYouGo、AdaptyPaymentMode.payUpFront、AdaptyPaymentMode.unknown の値を持つ列挙型。無料トライアルは AdaptyPaymentMode.freeTrial タイプになります。 • price：数値としての割引価格。無料トライアルの場合は 0 になります。 • localizedNumberOfPeriods：オファーの長さをデバイスのロケールでローカライズした文字列。たとえば、3日間のトライアルオファーの場合、このフィールドには 3 days と表示されます。 • subscriptionPeriod：オファー期間の個別の詳細をこのプロパティで取得することもできます。オファーに対しても前のセクションで説明したのと同じ方法で機能します。 • localizedSubscriptionPeriod：ユーザーのロケールに合わせてフォーマットされた割引のサブスクリプション期間。

デフォルトオーディエンスのペイウォールでフェッチを高速化する

通常、ペイウォールはほぼ瞬時にフェッチされるため、このプロセスを高速化することを特に気にする必要はありません。ただし、オーディエンスやペイウォールの数が多く、ユーザーのインターネット接続が不安定な場合は、ペイウォールのフェッチに予想以上の時間がかかることがあります。そのような状況では、ペイウォールをまったく表示しないよりも、デフォルトのペイウォールを表示してスムーズなユーザー体験を確保したい場合があるでしょう。 これを解決するには、getPaywallForDefaultAudience メソッドを使用します。このメソッドは、All Users オーディエンス向けの指定プレースメントのペイウォールを取得します。ただし、推奨アプローチは getPaywall メソッドによるペイウォールの取得であることを必ず理解してください。詳細は上記のペイウォール情報の取得セクションを参照してください。

try {
    final paywall = await Adapty().getPaywallForDefaultAudience(placementId: 'YOUR_PLACEMENT_ID');
} on AdaptyError catch (adaptyError) {
    // handle error
} catch (e) {
    // handle unknown error
}

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