Method: courses.announcements.list

הפונקציה מחזירה רשימה של ההודעות שהמבקש מורשה לראות.

התלמידים יכולים לראות רק PUBLISHED הודעות. מורים בקורס ואדמינים של דומיין יכולים לראות את כל ההודעות.

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • PERMISSION_DENIED אם למשתמש המבקש אין הרשאה לגשת לקורס המבוקש או בגלל שגיאות גישה.
  • INVALID_ARGUMENT אם הבקשה לא תקינה.
  • NOT_FOUND אם הקורס המבוקש לא קיים.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
courseId

string

המזהה של הקורס. המזהה הזה יכול להיות המזהה שהוקצה ב-Classroom או alias.

פרמטרים של שאילתה

פרמטרים
announcementStates[]

enum (AnnouncementState)

הגבלה על state ההודעות שמוחזרות. אם לא מציינים את הארגומנט הזה, ערך ברירת המחדל הוא PUBLISHED.
orderBy

string

סדר מיון אופציונלי של התוצאות. רשימה מופרדת בפסיקים של שדות עם מילת מפתח אופציונלית לכיוון המיון. השדה הנתמך הוא updateTime. מילות המפתח הנתמכות לקבלת כיוונים הן asc ו-desc. אם לא צוין ערך, updateTime desc הוא התנהגות ברירת המחדל. דוגמאות: updateTime asc, ‏ updateTime
pageSize

integer

מספר הפריטים המקסימלי להחזרה. אפס או ערך לא מצוין מצביעים על כך שהשרת עשוי להקצות ערך מקסימלי.

יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
pageToken

string

הערך nextPageToken שהוחזר מקריאה קודמת של list, ומציין שצריך להחזיר את דף התוצאות הבא.

הבקשה 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

מידע נוסף זמין במדריך ההרשאות.