インストール後のアクションと設定を有効にする

アプリのインストール後に発生する追加設定をサポートします。

ユーザーがアプリをインストールしたら、ユーザーに追加アクションや設定を求めることができます。たとえば、アプリでユーザーが外部サービスにアクセスするために、ユーザーに個別の認証情報を求めることができます。Stripe Apps ではこれらの追加アクションを、_「インストール後のアクション」_と呼びます。インストール後のアクションの複数のタイプからいずれかを選択して設定できます。

アプリ自体の内部 (SettingsView コンポーネントを使用)
外部 (Web サイトへのリンクを使用)。

インストール後のアクションを定義しない場合は、インストール後にダッシュボードにアプリが表示されます。

インストール後のアクションを追加する

インストール後のアクションを追加するには、以下の手順を使用します。

アプリのマニフェストファイルを開きます。

新しいフィールド、post_install_action を追加します。

stripe-app.json
{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {}
}

アプリケーション設定のニーズを満たす、post_install_action の設定オプションを追加します。
アプリを Stripe にアップロードします。
アプリの新しいリリースを作成します。
マーケットプレイスにアプリを公開します。

設定オプション

Stripe Apps は、以下のインストール後のアクションをサポートしています。

アプリにリンクする
設定にリンクする
外部 URL にリンクする

アプリにリンクする (デフォルト)

ユーザーがアプリをインストールした後のデフォルトのアクションでは、そのユーザーがアプリケーションインターフェイス (存在する場合) にリダイレクトされます。

この動作には、実装すべき追加設定は必要ありません。

外部 URL にリンクする

アプリを設定するために、ユーザーに外部サイトを訪れてもらう必要がある場合には、アプリマニフェストの post_install_action パラメーターを以下のように更新します。

stripe-app.json
{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {
    "type": "external",
    "url": "https://[YOUR-URL]"
  }
}

[YOUR-URL] を外部サイトの URL に置き換えます。

ユーザーがアプリをインストールすると、アプリマニフェストで指定された URL にユーザーをリダイレクトするボタンが表示されます。

この URL には account_id クエリ文字列パラメーターが含まれ、ユーザーの識別に使用できます。以下の例をご覧ください。

https://www.company.com/marketplace/stripe?account_id=12345

設定にリンクする

アプリに SettingsView コンポーネントが含まれている場合は、post_install_action を設定してインストール後にそれを開くことができます。このアクションを有効にするには、アプリのマニフェストファイルを次のように更新します。

stripe-app.json
{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {
    "type": "settings"
  }
}

ユーザーがアプリをインストールすると、アプリケーションの SettingsView コンポーネントにユーザーをリダイレクトするボタンが表示されます。