Method: courses.students.create

ユーザーをコースの生徒として追加します。

ドメイン管理者は、ドメイン内のユーザーをドメイン内のコースに生徒として直接追加できます。生徒は登録コードを使用してコースに自分自身を追加できます。

このメソッドは、次のエラーコードを返します。

  • PERMISSION_DENIED: リクエスト元のユーザーにこのコースの生徒を作成するための権限がない場合、またはアクセス エラーの場合。
  • NOT_FOUND: リクエストされたコース ID が存在しない場合。
  • FAILED_PRECONDITION リクエストされたユーザーのアカウントが無効になっている場合、次のリクエスト エラーが発生します。
    • CourseMemberLimitReached
    • CourseNotModifiable
    • UserGroupsMembershipLimitReached
    • InactiveCourseOwner
  • ALREADY_EXISTS: ユーザーがすでにコースの生徒または教師である場合。

HTTP リクエスト

POST https://classroom.googleapis.com/v1/courses/{courseId}/students

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
courseId

string

生徒を作成するコースの ID。この識別子は、Classroom に割り当てられた識別子または alias のいずれかです。

クエリ パラメータ

パラメータ
enrollmentCode

string

生徒を作成するコースの登録コード。このコードは、userId がリクエスト元のユーザーに対応する場合に必要です。リクエスト元のユーザーが、任意のユーザーの生徒を作成するための管理者権限を持っている場合は、省略できます。

リクエストの本文

リクエストの本文には Student のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Student のインスタンスが含まれます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

詳しくは、認可ガイドをご覧ください。