קבלת מטא-נתונים של תוספים ל-Classroom בהקשר של פוסט ספציפי.
כדי לשמור על התקינות של מודל הנתונים וההרשאות שלו, תוסף צריך להפעיל אותו כדי לאמת את הפרמטרים של השאילתה ואת התפקיד של המשתמש ששלח את הבקשה בכל פעם שהתוסף נפתח ב-iframe.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED
לשגיאות גישה.INVALID_ARGUMENT
אם הבקשה בפורמט שגוי.NOT_FOUND
אם אחד מהמשאבים שזוהו לא קיים.
בקשת HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
courseId |
חובה. מזהה הקורס. |
itemId |
המזהה של ההודעה, הקורס אוcourseWorkMaterial שאליהם מצורף הקובץ המצורף. השדה הזה הוא חובה, אבל הוא לא מסומן ככזה בזמן שאנחנו מעבירים את הנתונים מה-postId. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
addOnToken |
זה שינוי אופציונלי. אסימון שמאשר את הבקשה. האסימון מועבר כפרמטר של שאילתה כשהמשתמש מופנה אוטומטית מ-Classroom לכתובת ה-URL של התוסף. אסימון ההרשאה נדרש אם אף אחד מהתנאים הבאים לא מתקיים:
|
attachmentId |
זה שינוי אופציונלי. המזהה של הקובץ המצורף. השדה הזה הוא חובה לכל הבקשות, אלא אם המשתמש נמצא ב-Attachment Discovery iframe. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של AddOnContext
.
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
מידע נוסף זמין במדריך להרשאות.