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

返される生徒の課題を、指定された識別子を持つ生徒が所有する課題に制限するための省略可能な引数。識別子は次のいずれかになります。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエストしているユーザーを示す文字列リテラル "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 遅延が true の StudentSubmission を返します。
NOT_LATE_ONLY late が false の StudentSubmission を返します。