Google Docs API のスコープの選択

このドキュメントには、Google ドキュメント API 固有の認可と認証の情報が記載されています。このドキュメントを読む前に、認証と認可について学習するで、Google Workspace の一般的な認証と認可の情報を必ずお読みください。

認可用に OAuth 2.0 を構成する

OAuth 同意画面を構成し、スコープを選択して、ユーザーとアプリの審査担当者に表示する情報を定義し、後で公開できるようにアプリを登録します。

ドキュメント API のスコープ

アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは OAuth 2.0 URI 文字列で、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルが含まれます。スコープとは、ユーザーの Google アカウント データを含む Google Workspace データを操作する、アプリからのリクエストです。

アプリがインストールされると、ユーザーはアプリで使用されているスコープを検証するよう求められます。一般的には、可能な限り最も狭い範囲のスコープを選択し、アプリが必要としないスコープをリクエストしないようにする必要があります。ユーザーが、明確に説明された制限付きのスコープに対するアクセス権を付与しやすくなります。

可能であれば、ファイルごとのアクセス スコープが付与され、アプリに必要な特定の機能へのアクセスが限定されるため、機密性の低いスコープを使用することをおすすめします。

ドキュメント 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 API にアクセスする必要がある場合は、それらのスコープも追加できます。Google API スコープの詳細については、OAuth 2.0 を使用した Google API へのアクセスをご覧ください。

特定の OAuth 2.0 スコープの詳細については、Google API の OAuth 2.0 スコープをご覧ください。