ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

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

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

クエリ パラメータ

パラメータ
announcementStates[]

enum (AnnouncementState)

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

orderBy

string

(省略可)結果の並べ替え順序。カンマ区切りの順序フィールドを含むフィールドのカンマ区切りリスト。サポートされているフィールドは updateTime です。サポートされているルート キーワードは ascdesc です。指定しない場合は、updateTime desc がデフォルトの動作です。例: updateTime ascupdateTime

pageSize

integer

返される最大アイテム数。0 または指定なしは、サーバーが最大値を割り当てる可能性があることを示します。

サーバーから返される結果の数は、指定した数より少ない場合があります。

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

詳しくは、OAuth 2.0 の概要をご覧ください。