ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

REST Resource: invitations

リソース: 招待状

コースへの招待。

JSON 表現
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
フィールド
id

string

Classroom によって割り当てられる識別子。

読み取り専用です。

userId

string

招待されたユーザーの ID。

リクエストのパラメータとして指定すると、この識別子に次のいずれかを設定できます。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
courseId

string

ユーザーを招待するコースの ID。

role

enum (CourseRole)

ユーザーを招待するロール。COURSE_ROLE_UNSPECIFIED にすることはできません。

コースのロール

ユーザーが招待される可能性のあるロール。

列挙型
COURSE_ROLE_UNSPECIFIED コースにはロールがありません。
STUDENT コース内の生徒。
TEACHER コースの教師。
OWNER コースのオーナー。

メソッド

accept

招待を承諾して招待を削除し、招待したユーザーを適切なコースの教師または生徒に追加します(該当する場合)。

create

招待状を作成します。

delete

招待状を削除します。

get

招待を返します。

list

リクエスト元のユーザーが表示を許可されている招待のリストを返します。ただし、リスト リクエストに一致するものに限定されます。