Method: courses.courseWorkMaterials.list

リクエスト元が閲覧できるコースの課題教材のリストを返します。

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

クエリ パラメータ

パラメータ
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

返される課題のステータスの制限。一致するコースの課題教材のみが返されます。指定しない場合は、課題のステータスが PUBLISHED のアイテムが返されます。
orderBy

string

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

integer

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

サーバーから返される結果の数が、指定した数よりも少なくなることがあります。
pageToken

string

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

list リクエストは、このトークンが生成されたリクエストと同一である必要があります。
materialDriveId

string

ID が指定された文字列と一致するドライブ素材が 1 つ以上あるコースの課題教材をフィルタします（省略可）。materialLink も指定されている場合、コースの課題教材には両方のフィルタに一致する素材が必要です。
previewVersion

enum (PreviewVersion)

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

リクエストの本文

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

レスポンスの本文

コースの課題教材を一覧表示する際のレスポンス。

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

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

object (CourseWorkMaterial)

リクエストに一致するコースの課題教材アイテム。
nextPageToken

string

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

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

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