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