Method: courses.announcements.list

リクエスト元が表示を許可されているお知らせのリストを返します。

コースの生徒は、PUBLISHED のお知らせのみを表示できます。コースの教師とドメイン管理者は、すべてのお知らせを表示できます。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

クエリ パラメータ

パラメータ
announcementStates[]

enum (AnnouncementState)

返されるお知らせの state の制限。この引数を指定しない場合は、デフォルト値の PUBLISHED が使用されます。
orderBy

string

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

integer

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

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

string

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

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

リクエストの本文

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

レスポンスの本文

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

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

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

object (Announcement)

リクエストに一致するお知らせアイテム。
nextPageToken

string

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

認可スコープ

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

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

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