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

フローまたはペイウォールビルダーのペイウォールを設計したら、モバイルアプリで表示できます。最初のステップは、プレースメントに関連付けられたフローまたはペイウォールと、そのビュー設定を以下の手順で取得することです。

フロー/ペイウォールの取得

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

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

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

Adapty.GetFlow(
    "YOUR_PLACEMENT_ID",
    AdaptyPlacementFetchPolicy.Default,
    TimeSpan.FromSeconds(5),
    (flow, error) => {
        if (error != null) {
            // handle the error
            return;
        }

        // flow - the requested flow/paywall
    }
);

パラメーター:

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

ビュー設定の取得

フローまたはペイウォールを取得したら、CreateFlowView メソッドを使ってビュー設定の読み込みとビューの作成を一度に行います。別途フラグを確認する必要はありません。プレースメントが Flow Builder（フロー）または Paywall Builder（ペイウォール）で設計されている場合、CreateFlowView は表示可能なビューを返します。プレースメントがビルダー UI のないカスタムペイウォールの場合、CreateFlowView はエラーを返します。その場合はリモートコンフィグペイウォールとして処理してください。

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetPreloadProducts(true)
    .SetLoadTimeout(TimeSpan.FromSeconds(5));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    if (error != null) {
        // the flow has no view configured, or view creation failed
        return;
    }

    // use view
});

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

デフォルトオーディエンス向けのフローまたはペイウォールを取得して高速化する

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

この問題に対処するために、GetFlowForDefaultAudience メソッドを使用できます。このメソッドは、指定されたプレースメントの All Users オーディエンス向けのフローまたはペイウォールを取得します。ただし、推奨されるアプローチは GetFlow メソッドでフローまたはペイウォールを取得することであり、その詳細は上記のフロー/ペイウォールの取得セクションを参照してください。

Adapty.GetFlowForDefaultAudience(
    "YOUR_PLACEMENT_ID",
    AdaptyPlacementFetchPolicy.Default,
    (flow, error) => {
        if (error != null) {
            // handle the error
            return;
        }

        // flow - the requested flow
    }
);

アセットのカスタマイズ

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

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

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

たとえば、次のようなことが可能です。

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

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

var customAssets = new Dictionary<string, AdaptyCustomAsset>
{
    { "custom_image", AdaptyCustomAsset.LocalImageFile("custom_assets/images/custom_image.png") },
    { "hero_video", AdaptyCustomAsset.LocalVideoFile("custom_assets/videos/custom_video.mp4") }
};

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetCustomAssets(customAssets)
    .SetLoadTimeout(TimeSpan.FromSeconds(3));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    // handle the result
});

カスタムタイマーの設定

Unity アプリでカスタムタイマーを使用するには、タイマー ID と終了日時のディクショナリを SetCustomTimers メソッドに渡します。以下に例を示します。

var customTimers = new Dictionary<string, DateTime> {
    { "CUSTOM_TIMER_6H", DateTime.Now.AddHours(6) },
    { "CUSTOM_TIMER_NY", new DateTime(2026, 1, 1) }
};

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetCustomTimers(customTimers)
    .SetLoadTimeout(TimeSpan.FromSeconds(3));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    // handle the result
});

この例では、CUSTOM_TIMER_NY と CUSTOM_TIMER_6H は、Adapty ダッシュボードで設定した開発者定義タイマーの Timer ID です。タイマーリゾルバーにより、アプリは各タイマーを正しい値で動的に更新します。例えば：

• CUSTOM_TIMER_NY: 元日など、タイマー終了までの残り時間。
• CUSTOM_TIMER_6H: ユーザーがフローまたはペイウォールを開いた時点から始まる6時間の残り時間。

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

ペイウォールビルダーでカスタマイズされたペイウォールに関するトピックです。ペイウォールを手動で実装する場合は、リモートコンフィグペイウォールのペイウォールとプロダクトをモバイルアプリで取得するトピックをご参照ください。

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

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

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

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

Adapty.GetPaywall("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // paywall - the resulting object
});

パラメーター：

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

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

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

Unity SDK では、ビュー設定を手動で取得せずに、直接 CreatePaywallView メソッドを呼び出します。

var parameters = new AdaptyUICreatePaywallViewParameters()
  .SetPreloadProducts(preloadProducts)
  .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
  // handle the result
});

パラメーター：

ビューを取得したら、ペイウォールを表示します。

アセットをカスタマイズする

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

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

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

例えば、以下のことができます：

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

シンプルな辞書でカスタムアセットを提供する例：

var customAssets = new Dictionary<string, AdaptyCustomAsset>
{
    { "custom_image", AdaptyCustomAsset.LocalImageFile("custom_assets/images/custom_image.png") },
    { "hero_video", AdaptyCustomAsset.LocalVideoFile("custom_assets/videos/custom_video.mp4") }
};

var parameters = new AdaptyUICreatePaywallViewParameters()
    .SetCustomAssets(customAssets)
    .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
    // handle the result
});

開発者定義のタイマーを設定する

Unity アプリでカスタムタイマーを使用するには、タイマーIDと終了日時の辞書を SetCustomTimers メソッドに直接渡します。以下に例を示します：

var customTimers = new Dictionary<string, DateTime> {
    { "CUSTOM_TIMER_6H", DateTime.Now.AddHours(6) },
    { "CUSTOM_TIMER_NY", new DateTime(2025, 1, 1) }
};

var parameters = new AdaptyUICreatePaywallViewParameters()
    .SetCustomTimers(customTimers)
    .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
    // handle the result
});

この例では、CUSTOM_TIMER_NY と CUSTOM_TIMER_6H は Adapty ダッシュボードで設定した開発者定義タイマーの Timer ID です。タイマーリゾルバーにより、アプリは各タイマーを正しい値で動的に更新します。例えば：

• CUSTOM_TIMER_NY：元旦などのタイマー終了までの残り時間。
• CUSTOM_TIMER_6H：ユーザーがペイウォールを開いてから始まる6時間の残り時間。

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

通常、ペイウォールはほぼ即座に取得されるため、このプロセスを高速化することを心配する必要はありません。ただし、オーディエンスやペイウォールが多数あり、ユーザーのインターネット接続が弱い場合、ペイウォールの取得に想定より時間がかかることがあります。そのような場合、ペイウォールをまったく表示しないよりも、デフォルトのペイウォールを表示してスムーズなユーザー体験を確保したいことがあります。

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

Adapty.GetPaywallForDefaultAudience("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // paywall - the resulting object
});

パラメーター：