リダイレクトの構成方法

概要

ユーザーが支払いを完了した後に別のページにリダイレクトするには、アドミンページまたはAPI経由でリダイレクトを設定できます。さまざまな支払いステータス（支払い完了またはキャンセル）に対して、次のリダイレクトを構成できます：

• 自動 — 設定された遅延時間でリダイレクトされます。
• 手動 — ユーザーがリダイレクトボタンをクリックした後、リダイレクトされます。

自動的にリダイレクトを設定することと手動でのリダイレクトを同時に構成することができます。ユーザーは引き続き、アプリケーションに戻るためのリダイレクトボタンをクリックすることができます。それ以外の場合、構成された遅延時間が経過すると自動的にリダイレクトされます。

• user_id — ユーザーID。
• foreigninvoice — external_idパラメータで渡されるトランザクションID。
• invoice_id — トランザクションID。
• status — トランザクション状況。以下の値を持つことができます：

ユーザーがリダイレクトされるURLの例： {Return URL}?user_id=[value]&foreignInvoice=[value]&invoice_id=[value]&status=done

ユーザーが支払いを完了する前に決済UIタブを閉じた場合、次の形式で指定されたリダイレクトURLにリダイレクトされます：{Return URL}?user_id=[value]&invoice_id=. 決済UIがPay Station Embedで開いた場合、決済UIを閉じるとウィジェットが閉じ、ユーザーはゲームに戻ります。

自動リダイレクトを構成する

以下の場所で自動リダイレクトを構成することができます：

アドミンページでの自動リダイレクトを構成する

1. アドミンページであなたのプロジェクトを開き、ペイステーション>設定>リダイレクトポリシーに移動します。

2. 「リターンURL」フィールドには、支払いを行った後にユーザーがリダイレクトされるURLアドレスまたはパス（ディープリンク）を入力します。ゲームモバイルアプリケーションでユーザーが決済UIを開いたときのユーザーエクスペリエンスを向上させるには、リターンURLとしてディープリンクを指定することをお勧めします。
3. ドロップダウンリストで、「自動リダイレクト条件」を選択します：
   • なし — リダイレクトしません。
   • 支払い完了 — 支払いが完了した場合リダイレクトされます。
   • 支払い完了またはキャンセル — 支払いが完了またはキャンセルされた場合リダイレクトされます。
   • 任意の支払い — 任意の支払いステータスに応じてリダイレクトされます。
4. 「遅延」フィールドに、リダイレクトタイムアウトを秒単位で入力します。デフォルトでは、リダイレクトは0秒でアクティブになります。
5. リダイレクトボタンを追加せずに自動リダイレクトのみを構成したい場合は、「手動リダイレクト条件」ドロップダウンリストで、「なし — リダイレクトしません」を選択してください。
6. 「保存」をクリックします。

API経由で自動リダイレクトを構成する

リダイレクトを構成するには、トークンを作成する APIコールで以下のデータを渡します：

• settings.return_url — 支払いを行った後にユーザーがリダイレクトされるURLアドレスまたはパス（ディープリンク）。ゲームモバイルアプリケーションでユーザーが決済UIを開いたときのユーザーエクスペリエンスを向上させるには、リターンURLとしてディープリンクを指定することをお勧めします。
• settings.redirect_policy.redirect_conditions — リダイレクト条件：
  • none — リダイレクトしません。
  • successful — 支払いが完了した場合リダイレクトされます。
  • successful_or_canceled — 支払いが完了またはキャンセルされた場合リダイレクトされます。
  • any — 任意の支払いステータスに応じてリダイレクトされます。
• settings.redirect_policy.delay — settings.return_urlパラメータで渡されたURLへのリダイレクトがアクティブになるまでのタイムアウト時間（秒）です。デフォルトでは、リダイレクトは0秒でアクティブになります。

手動リダイレクトを構成する

以下の場所で手動リダイレクトを構成することができます：

• アドミンページで
• API経由で

アドミンページでの手動リダイレクトを構成する

1. アドミンページであなたのプロジェクトを開き、ペイステーション>設定>リダイレクトポリシーに移動します。

1. 「リターンURL」フィールドには、支払いを行った後にユーザーがリダイレクトされるURLアドレスまたはパス（ディープリンク）を入力します。ゲームモバイルアプリケーションでユーザーが決済UIを開いたときのユーザーエクスペリエンスを向上させるには、リターンURLとしてディープリンクを指定することをお勧めします。
2. 手動リダイレクトのみを構成したい場合は、「自動リダイレクト条件」ドロップダウンリストで、「なし — リダイレクトしません」を選択してください。
3. 「遅延」フィールドを空白のままにしてください。
4. 「手動リダイレクト条件」ドロップダウンリストで、リダイレクトボタンが表示されたときの支払いステータスを選択します：
   • なし — リダイレクトしません。
   • 支払い完了 — 支払いが完了した場合リダイレクトされます。
   • 支払い完了またはキャンセル — 支払いが完了またはキャンセルされた場合リダイレクトされます。
   • 任意の支払い — 任意の支払いステータスに応じてリダイレクトされます。
5. 「リダイレクトボタンのキャプション」フィールドに、ユーザーをリターンURLにリダイレクトするボタンのコピーを入力します。
6. 「保存する」をクリックします。

API経由で手動リダイレクトを構成する

リダイレクトを構成するには、トークンを作成する APIコールで以下のデータを渡します：

• settings.return_url — 支払いを行った後にユーザーがリダイレクトされるURLアドレスまたはパス（ディープリンク）。ゲームモバイルアプリケーションでユーザーが決済UIを開いたときのユーザーエクスペリエンスを向上させるには、リターンURLとしてディープリンクを指定することをお勧めします。
• settings.redirect_policy.manual_redirection_action — ユーザーが「閉じる」ボタンまたは「戻る」ボタンをクリックすることによってトリガーされる決済UI の動作:
  • redirect（デフォルト） — ユーザーはリターンURLにリダイレクトされます。
  • postmessage — 閉じるアイコンをクリックすると、close-widgetイベントが送信され、戻るボタンをクリックすると、returnイベントが送信されます。この場合、ユーザーはリターンURLにリダイレクトされません。決済UIを閉じる、またはリダイレクトする場合は、イベントの処理を構成する必要があります。この設定はAPI使用時のみ有効です。
• settings.redirect_policy.redirect_button_caption — ユーザーをリターンURLにリダイレクトするボタンのコピー。
• settings.redirect_policy.status_for_manual_redirection — リダイレクトボタンが表示されたら、支払いステータスが表示されます：
  • none — リダイレクトしません。
  • successful — 支払いが完了した場合リダイレクトされます。
  • successful_or_canceled — 支払いが完了またはキャンセルされた場合リダイレクトされます。
  • any — 任意の支払いステータスに応じてリダイレクトされます。

リダイレクト構成の例

アドミンページで、3秒間の遅延を伴う自動リダイレクトを設定しました。この操作は、モバイル版とデスクトップ版の両方の決済UIに適用されます。アドミンページで設定されたコンフィギュレーションは次のようになります：

ゲームのモバイルアプリケーションで決済UIを開くための設定を更新する必要がある場合、つまり、リダイレクトボタンを追加したり、リターンURLとしてディープリンクを指定したりするには、トークンで渡された設定を更新する必要があります：

{
    "user": {
        "country": {
            "value": "US"
        },
        "id": {
            "value": "1234abCd"
        },
        "name": {
            "value": "John Smith"
        }
    },
    "settings": {
        "currency": "USD",
        "project_id": 123456,
        "language": "en",
        "return_url": "myapp://payment/successful",
        "ui": {
            "desktop": {
                "header": {
                    "visible_logo": true
                }
            }
        },
        "redirect_policy": {
            "redirect_conditions": "any",
            "redirect_button_caption": "Back to Store",
            "manual_redirection_action": "redirect",
            "status_for_manual_redirection": "any"
        },
        "external_id": "1a2b3c"
    },
    "custom_parameters": {
        "timestamp": 1234512345123,
        "sku": "testSKU",
        "amount": "10"
    },
    "purchase": {
        "virtual_items": {
            "items": [
                {
                    "sku": "testSKU",
                    "amount": 1
                }
            ]
        }
    }
}