Method: courses.courseWork.list

リクエスト元が閲覧を許可されている課題のリストを返します。

コースの生徒は、PUBLISHED コースワークのみを表示できます。コースの教師とドメイン管理者は、すべてのコースの課題を表示できます。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

クエリ パラメータ

パラメータ
courseWorkStates[]

enum (CourseWorkState)

復帰する勤務ステータスの制限。一致するコースワークのみが返されます。指定しない場合、作業ステータスが PUBLISHED のアイテムが返されます。
orderBy

string

結果の並べ替え順序（省略可）。フィールドのカンマ区切りのリスト（並べ替え方向のキーワードは省略可）。サポートされているフィールドは updateTime と dueDate です。サポートされている方向キーワードは asc と desc です。指定しない場合、デフォルトの動作は updateTime desc です。例: dueDate asc,updateTime desc、updateTime,dueDate desc
pageSize

integer

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

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

string

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

それ以外の場合は、list リクエストがこのトークンを生成したリクエストと同一である必要があります。
previewVersion

enum (PreviewVersion)

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

リクエスト本文

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

レスポンスの本文

コースの課題を一覧表示した場合のレスポンス。

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

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

object (CourseWork)

リクエストに一致する課題アイテム。
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

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