מחזירה רשימה של הודעות למגיש הבקשה.
תלמידים בקורס יכולים לראות רק הודעות לגבי PUBLISHED
. המורים של הקורסים ומנהלי הדומיינים יכולים להציג את כל ההודעות.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED
אם המשתמש ששלח את הבקשה לא מורשה לגשת לקורס המבוקש או בגלל שגיאות גישה.INVALID_ARGUMENT
אם הבקשה לא תקינה.NOT_FOUND
אם הקורס המבוקש לא קיים.
בקשת HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
courseId |
מזהה הקורס. המזהה יכול להיות המזהה שהוקצה ל-Classroom או |
פרמטרים של שאילתה
פרמטרים | |
---|---|
announcementStates[] |
הוחזרה הגבלה על |
orderBy |
סדר המיון של התוצאות (אופציונלי). רשימת שדות שמופרדים בפסיקים עם מילות מפתח אופציונליות למיון לפי כיוון. השדה הנתמך הוא |
pageSize |
מספר הפריטים המרבי להחזרה. הערך 'אפס' או 'לא צוין' מציין שהשרת עשוי להקצות ערך מקסימלי. השרת עשוי להחזיר פחות ממספר התוצאות שצוין. |
pageToken |
הערך בכל מקרה אחר, הבקשה של |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
תשובה כשמוצגת עבודה בקורס.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"announcements": [
{
object ( |
שדות | |
---|---|
announcements[] |
פריטי הודעות שתואמים לבקשה. |
nextPageToken |
אסימון שמזהה את הדף הבא של התוצאות שיוחזרו. אם השדה ריק, אין תוצאות נוספות זמינות. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/classroom.announcements
https://www.googleapis.com/auth/classroom.announcements.readonly
למידע נוסף, ניתן לעיין במדריך ההרשאות.