Method: courses.announcements.list

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

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

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

  • PERMISSION_DENIED אם המשתמש ששלח את הבקשה לא מורשה לגשת לקורס המבוקש או אם יש שגיאות גישה.
  • INVALID_ARGUMENT אם הבקשה בפורמט שגוי.
  • NOT_FOUND אם הקורס המבוקש לא קיים.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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

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