Method: courses.courseWork.studentSubmissions.list

リクエストの OAuth スコープを考慮して、リクエスト元に閲覧が許可されている生徒の提出物のリストを返します。- を courseWorkId として指定すると、複数のコースの課題に対する生徒の提出物を含めることができます。

コースの受講生は、自分の課題のみ閲覧できます。コースの教師とドメイン管理者は、生徒のすべての提出物を表示できます。

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

  • PERMISSION_DENIED: リクエスト元のユーザーに、リクエストされたコースまたはコース課題へのアクセスを許可されていない場合、またはアクセスエラーの場合。
  • INVALID_ARGUMENT: リクエストの形式が正しくない場合。
  • リクエストされたコースが存在しない場合は NOT_FOUND。

HTTP リクエスト

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions

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

パスパラメータ

パラメータ
courseId

string

コースの識別子。この識別子は、Classroom によって割り当てられた識別子か alias のいずれかです。
courseWorkId

string

リクエストする生徒の提出物の ID。指定されたコースのすべてのコース課題について、生徒の提出物をリクエストするために、文字列リテラル "-" に設定することもできます。

クエリ パラメータ

パラメータ
userId

string

オプションの引数。返された生徒の提出物を、指定された ID を持つ生徒が所有しているものに限定します。ID は次のいずれかになります。

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

enum (SubmissionState)

リクエストされた送信ステータス。指定すると、返された生徒の提出物が、指定された提出ステータスのいずれかに一致します。
late

enum (LateValues)

リクエストされた遅延値。指定すると、返される生徒の提出物はリクエストされた値によって制限されます。指定しない場合、late 値に関係なく送信内容が返されます。
pageSize

integer

返されるアイテムの最大数。ゼロまたは未指定の場合は、サーバーが最大値を割り当てることができます。

サーバーが返す結果の数は、指定した数より少ないことがあります。
pageToken

string

前回の list 呼び出しから返された nextPageToken 値。結果の次のページを返す必要があることを示します。

それ以外の点では、list リクエストは、このトークンの生成元となったリクエストと同じである必要があります。
previewVersion

enum (PreviewVersion)

省略可。API のプレビュー版。プレビュー プログラムでデベロッパーが利用できる新しい API 機能にアクセスするには、設定する必要があります。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

生徒の提出物を一覧表示するときのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "studentSubmissions": [
    {
      object (StudentSubmission)
    }
  ],
  "nextPageToken": string
}
フィールド
studentSubmissions[]

object (StudentSubmission)

リクエストに一致する生徒の提出物。
nextPageToken

string

返される結果の次のページを識別するトークン。空の場合、これ以上結果はありません。

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students
  • https://www.googleapis.com/auth/classroom.coursework.me

詳細については、承認ガイドをご覧ください。

LateValues

返されるアイテムの遅延値に関する制限。

列挙型
LATE_VALUES_UNSPECIFIED 送信遅延値に対する制限が指定されていません。
LATE_ONLY late が true の場合は StudentSubmissions を返します。
NOT_LATE_ONLY late が false の場合に StudentSubmissions を返す。