このドキュメントでは、Google Docs API 固有の認可と認証について説明します。このドキュメントを読む前に、認証と認可についてで Google Workspace の一般的な認証と認可に関する情報をご確認ください。
認可用に OAuth 2.0 を構成する
OAuth 同意画面を設定し、スコープを選択することで、ユーザーとアプリの審査担当者に表示する情報を定義し、後でアプリを公開できるようにアプリを登録します。
Docs API スコープ
アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルを含む OAuth 2.0 URI 文字列です。スコープとは、ユーザーの Google アカウント データなど、Google Workspace データの操作に対するアプリのリクエストです。
アプリがインストールされると、アプリで使用されるスコープをユーザーが検証するよう求められます。通常は、できるだけ範囲の狭いスコープを選択し、アプリで必要のないスコープはリクエストしないようにします。ユーザーは、明確に説明された限定的なスコープに対してアクセス権限を付与する傾向があります。
可能であれば、機密性のないスコープを使用することをおすすめします。ファイルごとのアクセス スコープが付与され、アプリに必要な特定の機能へのアクセスが制限されるためです。
Docs API は、次のスコープをサポートしています。
| スコープコード | 説明 | 用途 |
|---|---|---|
https://www.googleapis.com/auth/documents |
Google ドキュメントのすべてのドキュメントの参照、編集、作成、削除を行えます。 | デリケートなコンテンツ |
https://www.googleapis.com/auth/documents.readonly |
Google ドキュメントのすべてのドキュメントを表示します。 | デリケートなコンテンツ |
https://www.googleapis.com/auth/drive.file |
このアプリで操作する Google ドライブ上の特定のファイルのみを表示、編集、作成、削除します。 | 推奨 機密性なし |
https://www.googleapis.com/auth/drive |
Google ドライブのすべてのファイルの表示、編集、作成、削除を行えます。 | 制限付き |
https://www.googleapis.com/auth/drive.readonly |
Google ドライブのすべてのファイルの表示、ダウンロードを行えます。 | 制限付き |
表の [使用状況] 列には、次の定義に従って各スコープの機密性が示されます。
機密性なし: これらのスコープは、承認アクセスの最も小さいスコープを提供し、基本的なアプリの確認のみを必要とします。この要件については、アプリの確認を送信するをご覧ください。
機密性の高いデータ: これらのスコープは、アプリに対してユーザーが承認した特定の Google ユーザーデータへのアクセスを提供します。追加のアプリ検証を受ける必要があります。この要件については、機密性の高いスコープと制限付きスコープの要件をご覧ください。
制限付き: これらのスコープは、Google のユーザーデータへの幅広いアクセスを可能にします。制限付きスコープの確認プロセスを完了する必要があります。この要件について詳しくは、Google API サービスのユーザーデータ ポリシーと特定の API スコープの追加要件をご覧ください。制限付きのスコープのデータをサーバーに保存する（または転送する）場合は、セキュリティ評価を受ける必要があります。
アプリで他の Google API にアクセスする必要がある場合は、それらのスコープも追加できます。Google API スコープの詳細については、OAuth 2.0 を使用した Google API へのアクセスをご覧ください。
特定の OAuth 2.0 スコープについて詳しくは、Google API の OAuth 2.0 スコープをご覧ください。