このページでは、Google Workspace Marketplace SDK を使用して Google Workspace Marketplace でアプリを構成し、管理する方法について説明します。
アプリを利用できるようにするには、Marketplace SDK でアプリを設定する必要があります。Marketplace SDK は、Marketplace でアプリを作成して制御できるツールキットです。Marketplace SDK を使用して、次のような Marketplace の設定を管理します。
- アプリが特定の Google Workspace 組織（限定公開アプリ）で利用可能か、すべての Marketplace ユーザー（一般公開アプリ）で利用可能か
- アプリをインストールできる Marketplace ユーザーの種類
- アプリが統合される Google Workspace アプリケーション
- アプリに必要な OAuth スコープ
- アプリの構築と保守を行うユーザーに関する情報
アプリを非公開で公開する場合でも、一般公開する場合でも、Marketplace SDK を使用して Marketplace でアプリを管理する必要があります。
Marketplace SDK を有効にする
まだ有効にしていない場合は、Google Cloud プロジェクトで Marketplace SDK を有効にします。
Google Cloud コンソールで Cloud プロジェクトを開く
まだ開いていない場合は、このサンプルで使用する Cloud プロジェクトを開きます。
- Google Cloud コンソールで、[プロジェクトを選択] ページに移動します。
- 使用する Google Cloud プロジェクトを選択します。または、[プロジェクトを作成] をクリックし、画面の指示に沿って操作します。Google Cloud プロジェクトを作成する場合は、プロジェクトの課金を有効にする必要がある場合があります。
Marketplace SDK を有効にする
Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Workspace Marketplace SDK を有効にします。
アプリの構成設定を決定する
次のリファレンスでは、Marketplace SDK の [アプリの構成] ページで使用可能な設定について説明します。
アプリを閲覧、インストールできるユーザーを選択する
アプリを構成する際に、次の設定を使用してアプリにアクセスできるユーザーを指定します。
- アプリの公開設定: Google Workspace 組織内でアプリを公開する場合、アプリのリスティングを非公開にするか、組織内のすべてのユーザーに表示するか、Google Workspace を使用しているすべてのユーザーに表示するかを指定します。
- インストール設定: Google Workspace 管理者のみがアプリをインストールできるかどうか。
アプリの掲載情報で指定した設定に関係なく、Google Workspace 組織に属するユーザーは、管理者が設定した内容によっては、アプリを見つけたり、インストールしたり、使用したりできない場合があります。管理者は、次の方法でアプリの利用可否に影響を与えることができます。
- ユーザーが Marketplace でアプリを表示できるかどうか、ユーザーに代わってアプリをインストールできるかどうかを制御します。
- 許可リストを使用して、組織のアプリを管理、キュレートします。許可リストを使用する組織向けにアプリを開発している場合は、アプリを許可リストに追加する方法について管理者にお問い合わせください。
- Google Chat、Google Chat アプリ、またはその両方へのアクセス権を削除するなど、特定の Google Workspace アプリケーションを無効にします。このような場合、ユーザーは Marketplace からアプリをインストールできません。
管理者が Marketplace へのアクセスを管理する方法については、 Marketplace 管理者向けヘルプのドキュメントをご覧ください。
アプリの公開設定
Google Workspace アカウント（職場や学校の組織によって作成されたアカウント）を使用している場合は、[アプリの公開設定] オプションが表示されます。個人用アカウント（末尾が「@gmail.com」のアカウント）を使用している場合は、公開のみが可能です。
- 一般公開: ドメイン外のユーザーがアプリを見つけてインストールできます。公開設定を選択すると、アプリの掲載情報が公開される前に Google による審査と承認が行われます。
- 非公開: ドメイン内のユーザーのみがアプリを検索してインストールできます。
[非公開] として公開することを選択した場合、アプリのリスティングは閲覧や検索の結果に表示されません。ユーザーは、直接 URL でのみアプリのストアページにアクセスできます。
アプリを利用できる国や地域を制限する場合は、ストアの掲載情報を作成する際に [販売 / 配布地域] セクションで設定します。
アプリのインストール設定
[インストール設定] オプションでは、ユーザーまたは Google Workspace 管理者が Marketplace のストア掲載情報ページからアプリをインストールできるかどうかを指定します。
- 個別インストールと管理者によるインストール（デフォルト）: アプリは、個々のユーザーがインストールすることも、ドメイン、組織部門、またはユーザー グループの管理者がインストールすることもできます。個々のインストールが有効になっていても、ユーザーのドメイン ポリシーによってアプリのインストールが禁止されている場合があります。
- 管理者のみがインストール可能: アプリは、ドメイン、組織部門、ユーザー グループの管理者のみがインストールできます。アプリは、Google Workspace Marketplace の検索結果で、管理者と Google アカウントにログインしていないユーザーにのみ表示されます。アプリでドメインのインストールが必要な場合は、このオプションを選択します。
一般的なインストールと公開設定
次の表に、インストールと可視性に関する一般的なアプリ構成オプションの一部を示します。
| アプリの対象ユーザー | アプリの表示設定 | アプリのインストール設定 | アプリをインストールできるユーザー | アプリを使用できるユーザー | |
|---|---|---|---|---|---|
| Google Workspace 組織向けに構築されたアプリの場合 | |||||
| 組織内の特定のユーザー | 非公開と限定公開 | 個別インストールと管理者によるインストール | 許可されている場合、アプリのリスティング URL を知っている組織内のすべてのユーザー。 | 許可されている場合、アプリのリスティング URL を知っている組織内のすべてのユーザー。 | |
| あなたの組織 | プライベート | 個別インストールと管理者によるインストール | 許可されている場合は、組織内のすべてのユーザー。 | 許可されている場合は、組織内のすべてのユーザー。 | |
| あなたの組織 | プライベート | 管理者のみ | 管理者 | 管理者がアプリをインストールしたユーザー。 | |
| 特定の Google Workspace 組織外のユーザーが利用できるアプリの場合 | |||||
| Google Workspace 組織のユーザー | 公開 | 管理者のみ | 管理者 | 管理者がアプリをインストールしたユーザー。 | |
| すべての Google Workspace ユーザー | 公開 | 個別インストールと管理者によるインストール |
|
|
|
アプリが Google Workspace アプリケーションとどのように統合されるかを特定する
アプリまたはアドオンが連携するように設計されている Google Workspace サービス（Google Workspace アドオンや Google Chat アプリなど）を選択します。少なくとも 1 つのオプションを選択する必要があります。場合によっては、アプリのリスティングに複数のアプリ統合を含めることができます。アプリの統合をまとめて一覧表示するをご覧ください。
選択したアプリ統合によっては、追加情報の提供や、Google Cloud プロジェクトでの関連する API の有効化が必要になることがあります。次の表に、それぞれに必要な追加設定を示します。
Google Workspace アドオン
Google Workspace アドオンを公開するには、アドオンのデプロイ ID を指定する必要があります。
Apps Script でデプロイ ID を確認する手順は次のとおりです。
- Apps Script エディタで Google Workspace アドオンを開きます。
- [Deploy > Manage deployments] をクリックします。
- デプロイ ID の下にある [コピー] をクリックします。
HTTP アドオンのデプロイ ID を確認する手順は次のとおりです。
- [アプリの構成] ページの [Google Workspace アドオン] で、[HTTP またはその他のデプロイ > デプロイを選択] をクリックします。
- 公開するデプロイを選択します。
- [選択] をクリックします。
エディタ アドオン（ドキュメント、スプレッドシート、スライド、フォーム）
エディタ用アドオンを公開するには、公開するプロジェクト スクリプト ID とバージョンを指定する必要があります。
プロジェクト スクリプト ID を確認する手順は次のとおりです。
- Apps Script エディタでアドオンを開きます。
- 左側の [プロジェクト設定] をクリックします。
- [ID] で、スクリプト ID をコピーします。
バージョンを確認する手順は次のとおりです。
- Apps Script エディタでアドオンを開きます。
- 右上にある [デプロイ > デプロイを管理] をクリックします。
- バージョン番号は [構成] の下に表示されます。
Google Chat 用アプリ
インタラクティブな Google Chat アプリを公開するには、次のドキュメントをご覧ください。
- Chat 用アプリをアドオンとしてビルドした場合は、Chat API でアドオンの設定を構成する必要があります。手順については、Google Workspace アドオンのドキュメントの Chat 用アプリを構成するをご覧ください。
- インタラクション イベントを使用して Chat 用アプリを構築した場合は、Chat API でインタラクション イベントの設定を構成する必要があります。手順については、Chat API ドキュメントのインタラクション イベントを受信して応答するをご覧ください。
- AppSheet の自動構成を使用して Chat 用アプリを構築した場合は、AppSheet のドキュメントの自動構成を使用して Chat 用アプリを共有するで説明されている手順に沿って、Chat 用アプリを公開します。
ドライブアプリ
ドライブアプリを公開するには、 Google Drive API を有効にして構成する必要があります。
ウェブアプリ
ウェブアプリを公開するには、ユニバーサル ナビゲーション URL（Google アプリ メニュー からウェブアプリを指す URL）を指定する必要があります。ウェブアプリは本番環境で完全に機能している必要があります。
ストアの掲載情報ページに記入する際には、96x96 ピクセルと 48x48 ピクセルのサイズの追加アイコンも用意する必要があります。
Apps Script でウェブアプリを構築した場合は、次の手順でユニバーサル ナビゲーションの URL を取得します。
- Apps Script エディタで Google Workspace アドオンを開きます。
- [Deploy] > [New deployment] をクリックします。
- [タイプを選択] で [ウェブアプリ] をクリックします。
- オプションを入力して、[デプロイ] をクリックします。
- [コピー] をクリックします。
アプリに必要なアクセスレベルを指定する
[OAuth スコープ] で、アプリに必要な OAuth 2.0 スコープの完全なリストを指定します。ここで入力する OAuth スコープは、OAuth 同意画面に表示されるスコープと一致している必要があります。該当する場合は、Apps Script マニフェストとも一致している必要があります。
複数のアプリ統合を含める場合は、各アプリ統合のスコープを Marketplace SDK の [アプリの構成] ページと OAuth 同意画面に追加してください。
可能な限り最も狭いスコープを常に使用します（たとえば、読み取り専用スコープのみが必要な場合は、完全なドライブ スコープを含めないでください）。
Apps Script プロジェクトについては、承認スコープをご覧ください。
アプリ デベロッパーに関する情報を提供する
[デベロッパー情報] で、連絡先情報などの詳細を入力します。これらのフィールドは、アプリのストアの掲載情報ページに表示されます。
| フィールド | |
|---|---|
| 取引業者ステータス |
消費者保護法により、この Marketplace の販売者がトレーダーであるか、トレーダーではないかを、欧州経済領域（EEA）の消費者に通知する必要があります。
指定しない場合は、アプリのストアの掲載情報ページに [トレーダーのステータスが指定されていません] と表示されます。 |
| デベロッパー名 | アプリの作成者として表示する名前。トレーダーの場合は、商号または登録名を指定します。 |
| デベロッパーの住所 |
トレーダーの場合は必須です。非取引業者については収集されません。 ビジネスの所在地。連絡可能な有効な住所を入力してください。 |
| デベロッパーのウェブサイトの URL | デベロッパーとしてお客様（またはお客様の組織）を紹介しているウェブサイト。 |
| デベロッパーのメールアドレス |
連絡先として使用するメールアドレス。アプリの掲載情報には含まれません。このメールアドレスは、使用されるため、常に最新の状態に保つ必要があります。
|
| アプリのウェブサイトの URL | 省略可。アプリについて詳しく説明しているウェブサイト。 |
Marketplace SDK でアプリの構成設定を保存する
前のセクションの情報を使用して、Marketplace SDK にアプリの構成を保存します。
Google Cloud コンソールで、Marketplace SDK の [アプリの構成] ページに移動します。
前のセクションで決定した内容に基づいて、各セクションに入力します。
[下書きを保存] をクリックします。
（省略可）Google アナリティクスでアプリの使用状況に関する分析情報を取得できます。これを行うには、Marketplace SDK で Google アナリティクス ID を追加します。
- [分析] タブに移動します。
- Google アナリティクス ID を入力します。
- [保存] をクリックします。
トラブルシューティング
このセクションでは、発生する可能性のある一般的な問題について説明します。
Marketplace にアプリを公開する際に必要な権限がない
Marketplace SDK の [アプリの構成] ページでアプリを構成しようとすると、次のエラー メッセージが表示され、Marketplace でアプリを公開できません。
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
このエラーは、Marketplace SDK API が有効になっていて、Editor または Owner 以外の IAM ロールを使用している場合に発生します。
このエラーを解決するには、次のいずれかの解決策を実装します。
プロジェクト オーナーに、権限のないアカウントに
roles/appmetadata.workspaceMarketplaceAppConfigurationAdminロールを割り当てるよう依頼してください。これにより、Marketplace SDK でアプリを構成して管理できるようになります。プロジェクト オーナーに、Google Cloud コンソールの [IAM と管理] > [ロール] ページで、カスタムロールに不足している権限を追加するよう依頼します。次に、権限が不足しているアカウントにカスタムロールを割り当てます。
アプリの公開には、プリミティブ
roles/editorまたはroles/ownerを使用できます。ただし、IAM を安全に使用するドキュメントでは、プロジェクト内の他のリソースへの編集アクセスを簡単に制限できないため、この方法は推奨されていません。