リクエスト元が表示することが許可されたお知らせのリストを返します。
コースの生徒には PUBLISHED
のお知らせのみ表示されます。コースの教師とドメイン管理者はすべてのお知らせを閲覧できます。
このメソッドは、次のエラーコードを返します。
- リクエスト元のユーザーがリクエストされたコースへのアクセスを許可されていない場合、またはアクセスエラーの場合、
PERMISSION_DENIED
。 INVALID_ARGUMENT
: リクエストの形式が正しくありません。- リクエストされたコースが存在しない場合は
NOT_FOUND
。
HTTP リクエスト
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
courseId |
コースの識別子。この ID は、Classroom によって割り当てられた ID または |
クエリ パラメータ
パラメータ | |
---|---|
announcementStates[] |
返されるお知らせの |
orderBy |
(省略可)結果の並べ替え順序。カンマ区切りの順序フィールドを含むフィールドのカンマ区切りリスト。サポートされているフィールドは |
pageSize |
返される最大アイテム数。0 または指定なしは、サーバーが最大値を割り当てる可能性があることを示します。 サーバーから返される結果の数は、指定した数より少ない場合があります。 |
pageToken |
前の それ以外の場合、 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
コースが機能したときの応答。
JSON 表現 |
---|
{
"announcements": [
{
object ( |
フィールド | |
---|---|
announcements[] |
リクエストに一致するお知らせアイテム。 |
nextPageToken |
返された結果の次のページを識別するトークン。空の場合、これ以上の結果はありません。 |
認証スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/classroom.announcements
https://www.googleapis.com/auth/classroom.announcements.readonly
詳しくは、OAuth 2.0 の概要をご覧ください。