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 を持つ Google ドライブの教材を 1 つ以上含むコースの課題のフィルタ。materialLink も指定する場合、コースの教材には両方のフィルタに一致する資料が必要です。

リクエスト本文

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

レスポンスの本文

コースの課題資料をリストした場合のレスポンス。

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

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

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