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 を返します。