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 が一致する Drive マテリアルが 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

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