コースの招待状を管理する

Classroom の Invitation リソースは、生徒、教師、オーナーなどの特定のコースロールを持つコースに参加するためのユーザーの招待を表します。

各 Invitation リソースには次のフィールドが含まれています。

• id: 招待に Classroom が割り当てた ID。
• userId: コースに招待されたユーザーの ID。
• courseId: ユーザーが招待されているコース。
• role: 招待するユーザーがコースで持つコースロール。

招待状を作成する

invitations.create() メソッドを使用すると、特定のロールを持つユーザーをコースに招待できます。リクエスト本文に Invitation リソースを含め、courseId、userId、role を指定します。

Java

classroom/snippets/src/main/java/CreateInvitation.java

GitHub で表示

Invitation invitation = null;
try {
  /* Set the role the user is invited to have in the course. Possible values of CourseRole can be
  found here: https://developers.google.com/classroom/reference/rest/v1/invitations#courserole.*/
  Invitation content =
      new Invitation().setCourseId(courseId).setUserId(userId).setRole("TEACHER");

  invitation = service.invitations().create(content).execute();

  System.out.printf(
      "User (%s) has been invited to course (%s).\n",
      invitation.getUserId(), invitation.getCourseId());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The course or user does not exist.\n");
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return invitation;

招待状を取得する

invitations.get() メソッドを呼び出し、招待状の id を指定して、特定の招待状を取得します。

Java

classroom/snippets/src/main/java/GetInvitation.java

GitHub で表示

Invitation invitation = null;
try {
  invitation = service.invitations().get(id).execute();
  System.out.printf(
      "Invitation (%s) for user (%s) in course (%s) retrieved.\n",
      invitation.getId(), invitation.getUserId(), invitation.getCourseId());
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The invitation id (%s) does not exist.\n", id);
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return invitation;

招待に応じる

招待を承認すると、招待が削除され、招待されたユーザーが招待に指定されたロールでコースに追加されます。invitations.accept() メソッドを呼び出して招待の id を指定し、招待を承諾します。

Java

classroom/snippets/src/main/java/AcceptInvitation.java

GitHub で表示

try {
  service.invitations().accept(id).execute();
  System.out.printf("Invitation (%s) was accepted.\n", id);
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The invitation id (%s) does not exist.\n", id);
  }
  throw e;
} catch (Exception e) {
  throw e;
}

招待状を削除する

招待状を更新する唯一の方法は、招待状を削除して新しい招待状を作成することです。招待状を削除するには、invitations.delete() メソッドを呼び出して id を指定します。

Java

classroom/snippets/src/main/java/DeleteInvitation.java

GitHub で表示

try {
  service.invitations().delete(id).execute();
  System.out.printf("Invitation (%s) was deleted.\n", id);
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The invitation id (%s) does not exist.\n", id);
  }
  throw e;
} catch (Exception e) {
  throw e;
}