アプリを公開する際、認証と認可のために主に次の 4 つのタスクを完了する必要があります。
- OAuth 同意画面に入力します。
- OAuth 2.0 認証情報を作成する。
- Google Workspace Marketplace SDK でアプリの実行に必要なすべてのスコープを構成する
- OAuth 確認用にアプリを送信する。
各場所に追加するスコープは一致している必要があります。スコープは次の方法で使用されます。
- OAuth 同意画面に追加されたスコープは、OAuth の確認に使用されます。
- Google Workspace Marketplace SDK に追加されたスコープは、ドメイン全体と個別のインストールで使用され、Google Workspace Marketplace からインストールされたときにアプリを承認します。
- マニフェストに追加されたスコープは、アプリが適切に機能するために必要です。
たとえば、Google スプレッドシート アドオンと Google ドキュメント アドオンを含むアプリを公開する場合、各アドオンの Apps Script マニフェストには、アドオンに固有のスコープのみが含まれます。Google Cloud プロジェクトの OAuth 同意画面と Google Workspace Marketplace SDK には、両方のアドオンのスコープが含まれています。
前提条件
- Google Cloud プロジェクトで課金を有効にします。
- アプリをビルドしてテストする。
- 認証と承認について
- Google Apps Script でアプリを作成した場合は、Apps Script プロジェクトの Google Cloud プロジェクトを更新します。
1. OAuth 同意画面に入力する
OAuth 同意画面は、誰がデータへのアクセスをリクエストしているのかと、どのような種類のデータへのアクセスがアプリに許可されるのかをユーザーに示すプロンプトです。
- Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- アプリのユーザータイプを選択し、[作成] をクリックします。
- アプリ登録フォームに入力し、[保存して続行] をクリックします。
Google Workspace 組織の外部で使用するアプリを作成する場合は、[スコープを追加または削除] をクリックします。スコープを選択する際は、次のベスト プラクティスをおすすめします。
- アプリに必要な最小レベルのアクセス権を提供するスコープを選択します。使用可能なスコープの一覧については、Google API の OAuth 2.0 スコープをご覧ください。
- [非機密のスコープ]、[機密のスコープ]、[制限付きスコープ] の 3 つのセクションに表示されているスコープを確認します。[機密性の高いスコープ] または [制限付きスコープ] セクションに表示されているスコープについては、機密性のない代替のスコープを特定して、不要な追加審査を回避してください。
- スコープによっては、Google による追加の審査が必要になる場合があります。Google Workspace 組織内でのみ使用されるアプリの場合、スコープは同意画面に表示されず、制限付きスコープまたは機密スコープを使用する場合でも、Google による追加の審査は必要ありません。詳細については、スコープ カテゴリをご覧ください。
- アプリに必要なスコープを選択したら、[保存して次へ] をクリックします。
- ユーザータイプに [外部] を選択した場合は、テストユーザーを追加します。
- [テストユーザー] で [ユーザーを追加] をクリックします。
- メールアドレスと他の承認済みテストユーザーを入力し、[保存して次へ] をクリックします。
- アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がなければ、[ダッシュボードに戻る] をクリックします。
2. OAuth 2.0 認証情報を作成する
アプリの作成方法に応じて、OAuth 2.0 認証情報を作成する方法は 2 つあります。
Apps Script でアプリを作成した場合
Apps Script プロジェクトをデフォルトの Google Cloud プロジェクトから新しい標準プロジェクトに切り替えます。別の標準プロジェクトに切り替えるをご覧ください。
Apps Script プロジェクトを Google Cloud プロジェクトに関連付けると、OAuth 2.0 認証情報が自動的に作成されます。
Apps Script を使用してアプリをビルドしなかった場合
OAuth 2.0 認証情報を作成するには、OAuth クライアント ID 認証情報をご覧ください。
3. スコープを構成する
アプリが必要とする OAuth スコープの完全なリストを指定します。可能な限り狭いスコープを使用します。
アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルを含む OAuth 2.0 URI 文字列です。スコープとは、ユーザーの Google アカウント データなど、Google Workspace データの操作に対するアプリのリクエストです。
アプリがインストールされると、アプリで使用されるスコープをユーザーが検証するよう求められます。通常は、できるだけ範囲の狭いスコープを選択し、アプリで必要のないスコープはリクエストしないようにします。ユーザーは、明確に説明された限定的なスコープに対してアクセス権限を付与する傾向があります。
4. OAuth の確認を送信する（公開アプリのみ）
一般公開アプリが機密性の高いスコープまたは制限付きのスコープを使っている場合は、OAuth 確認審査プロセスを受ける必要があります。
- OAuth の確認では、リクエストされたスコープまたはデータの使用方法をユーザーに説明するフローまたは手順を示すデモ動画を送信する必要があります。
- アプリで制限付きスコープを使用している場合は、セキュリティ評価を受ける必要が生じることもあります。セキュリティ評価が必要な理由をご覧ください。
確認を送信する手順は次のとおりです。
- Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- [プロジェクト セレクタ] をクリックして、プロジェクトを選択します。
- [アプリを編集] をクリックします。
- 必要な情報を入力し、[確認のため送信] をクリックします。
- [確認が必要] ダイアログで適切な理由を入力し、[送信] をクリックして確認プロセスを開始します。
機密性の高いスコープや制限付きのスコープを使用するようにアプリを更新した場合は、OAuth 検証のためにアプリを再度送信する必要があります。アプリの審査のために再度送信する必要はありません。
OAuth の確認とアプリの審査の違い
OAuth の確認は、アプリの審査とは別のプロセスです。同意画面がアプリの ID と目的を正確に表し、アプリがユーザーデータを不正使用していないことを確認することに重点を置いています。アプリの OAuth 確認が完了するまで、アプリのリスティングは承認されません。OAuth の確認の詳細については、OAuth API の確認に関するよくある質問をご覧ください。
アプリの審査では、Google Workspace Marketplace API で提供された情報、アプリの機能とユーザビリティが重視されます。アプリの審査基準について詳しくは、アプリの審査についてをご覧ください。