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

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