ディープリンクを追加する

ディープリンクの URL を作成するには、以下を使用する必要があります。

• アプリがインストールされている Stripe アカウント ID です。詳細については、ユーザーコンテキストをご覧ください。
• ビューを定義した Dashboard ページの URL です。
• アプリと、アプリを開く場所を指定する apps パラメーターです。
• アプリケーション ID です。stripe-app.json マニフェストファイルの id フィールドで指定されます。

ディープリンクの形式

ディープリンク URL の構造は次のとおりです。

https://dashboard.stripe.com/<MODE>/acct_<ACCOUNT_ID>/<PAGE>?apps[<APP_ID>][TARGET]=VIEWPORT_ID

各項目は次のとおりです:

• MODE: テスト環境では test を指定し、本番環境では省略します
• ACCOUNT_ID: Stripe アカウント ID (acct_ で始まる)
• PAGE: 表示する Dashboard ページ (customers、invoices、dashboard など)
• APP_ID: マニフェストファイルに記載されたアプリケーション ID
• TARGET: drawer や modal など、アプリを開く場所
• VIEWPORT_ID: マニフェストファイルで設定したビューポート ID (stripe.dashboard.payment.list など)

例

Dashboard (https://dashboard.stripe.com/test/customers?) の Customers ページでビューを定義し、アプリケーション ID が com.example.my-app の場合:

• 以下は、テスト環境とサンドボックスのディープリンクです。

    <a href="https://dashboard.stripe.com/test/acct_id/customers?apps[com.example.my-app][drawer]=">Deep Link</a>
  

• 本番環境のディープリンクは次のようになります。

  <a href="https://dashboard.stripe.com/acct_id/customers?apps[com.example.my-app][drawer]=">Deep Link</a>
  

ビューを定義した Dashboard ページでアプリを開くことができます。たとえば、Dashboard のホームで開くには次のようにします。

 <a href="https://dashboard.stripe.com/test/acct_id/dashboard?apps[com.example.my-app][drawer]=">Deep Link</a>

アカウント登録モーダルへのディープリンクを作成するには、drawer ではなく modal を使用します。

<a href="https://dashboard.stripe.com/acct_id/dashboard?apps[com.example.my-app][modal]=">Open in Modal</a>

ユーザーとディープリンクを共有するときは、必ず本番環境の URL を使用してください。貴社のアプリをインストールしたユーザーについては、任意の場所でリンクを共有できます。アプリをインストールしていないユーザーがディープリンクをクリックした場合、Stripe は、ダッシュボードで開くことができない閉じたアプリにユーザーを誘導します。

1. アプリをインストールしたユーザーとしてダッシュボードにログインします。

2. ディープリンクをクリックします。

   開けないアプリに移動する場合は、以下を確認してください。

   • apps パラメーターが、マニフェストの正しいアプリケーション ID を使用していること
   • URL パスのアカウント ID が正しいこと (形式: acct_ の後に英数字が続く)
   • ユーザーがそのアカウントにアプリをインストールしていること
   • URL の Dashboard ページに、アプリ用のビューが定義されていること