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 は次のいずれかです。

  • ユーザーの数字 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 を返します。