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

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