このドキュメントには、Google Classroom API 固有の承認および認証に関する情報が記載されています。このドキュメントを読む前に、認証と認可の詳細で Google Workspace の一般的な認証と認可の情報をお読みください。
認可用に OAuth 2.0 を設定する
OAuth 同意画面を構成し、スコープを選択して、ユーザーとアプリ審査担当者に表示する情報を定義し、後で公開できるようにアプリを登録します。
Classroom API のスコープ
アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは OAuth 2.0 URI 文字列で、Google Workspace アプリ名、アプリがアクセスするデータの種類、アクセスレベルが含まれます。スコープは、ユーザーの Google アカウントのデータなど、Google Workspace のデータを操作するアプリからのリクエストです。
アプリのインストール時に、アプリで使用されているスコープを検証するよう求められます。一般的には、できる限り範囲を絞り込んだスコープを選択し、アプリが必要としないスコープをリクエストしないようにする必要があります。ユーザーが明確に説明された制限付きのスコープに対してより簡単にアクセス権を付与できます。
Classroom API では、次のスコープをサポートしています。
| スコープ | 意味 |
|---|---|
https://www.googleapis.com/auth/classroom.announcements
|
Google Classroom のお知らせの表示と管理を行います。 |
https://www.googleapis.com/auth/classroom.announcements.readonly
|
Google Classroom でお知らせを表示する。 |
https://www.googleapis.com/auth/classroom.courses
|
Google Classroom のクラスの参照、編集、作成、完全削除を行います。 |
https://www.googleapis.com/auth/classroom.courses.readonly
|
Google Classroom のクラスを表示します。 |
https://www.googleapis.com/auth/classroom.coursework.me
|
課題、質問、成績などのコースワーク アイテムを表示、作成、編集できます。 |
https://www.googleapis.com/auth/classroom.coursework.me.readonly
|
Google Classroom で課題と成績を表示します。 |
https://www.googleapis.com/auth/classroom.coursework.students
|
担当している Google Classroom のクラスに所属している生徒の課題と成績を管理し、管理しているクラスの課題と成績を表示します。 |
https://www.googleapis.com/auth/classroom.coursework.students.readonly
|
担当または管理している Google Classroom のクラスに所属している生徒の課題と成績を表示します。 |
https://www.googleapis.com/auth/classroom.courseworkmaterials
|
Google Classroom で授業の資料を表示、編集、作成します。 |
https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly
|
Google Classroom のクラスの授業資料をすべて表示できます。 |
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
|
Google Classroom の保護者を表示します。 |
https://www.googleapis.com/auth/classroom.guardianlinks.students
|
Google Classroom のクラスに所属している生徒の保護者を表示、管理する。 |
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
|
Google Classroom のクラスに所属している生徒の保護者を表示します。 |
https://www.googleapis.com/auth/classroom.profile.emails
|
クラスのユーザーのメールアドレスの参照。 |
https://www.googleapis.com/auth/classroom.profile.photos
|
クラスのメンバーのプロフィール写真を表示する。 |
https://www.googleapis.com/auth/classroom.push-notifications
|
Google Classroom のデータに関する通知を受け取る。 |
https://www.googleapis.com/auth/classroom.rosters
|
Google Classroom のクラス名簿を管理します。 |
https://www.googleapis.com/auth/classroom.rosters.readonly
|
Google Classroom のクラス名簿を表示する。 |
https://www.googleapis.com/auth/classroom.student-submissions.me.readonly
|
Google Classroom で課題と成績を表示します。 |
https://www.googleapis.com/auth/classroom.student-submissions.students.readonly
|
担当または管理している Google Classroom のクラスに所属している生徒の課題と成績を表示します。 |
https://www.googleapis.com/auth/classroom.topics
|
Google Classroom のトピックを表示、作成、編集できます。 |
https://www.googleapis.com/auth/classroom.topics.readonly
|
Google Classroom でトピックを表示します。 |