Method: courses.courseWork.getAddOnContext

הצגת המטא-נתונים של תוספים ל-Classroom בהקשר של פוסט ספציפי.

כדי לשמור על תקינות מודל הנתונים וההרשאות שלו, תוסף צריך לבצע קריאה ל-method הזה כדי לאמת את פרמטרי השאילתה ואת התפקיד של המשתמש המבקש בכל פעם שהתוסף נפתח ב-iframe.

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

  • PERMISSION_DENIED עבור שגיאות גישה.
  • INVALID_ARGUMENT אם הבקשה לא תקינה.
  • NOT_FOUND אם אחד מהמשאבים שזוהו לא קיים.

בקשת HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
courseId

string

חובה. המזהה של הקורס.
itemId

string

המזהה של Announcement,‏ CourseWork או CourseWorkMaterial שבאמצעותם הקובץ המצורף מצורף. השדה הזה חובה, אבל הוא לא מסומן ככזה בזמן ההעברה מ-postId.

פרמטרים של שאילתה

פרמטרים
addOnToken

string

זה שינוי אופציונלי. אסימון שמאשר את הבקשה.

האסימון מועבר כפרמטר של שאילתה כשהמשתמש מופנה מ-Classroom לכתובת ה-URL של התוסף.

טוקן ההרשאה נדרש אם אף אחד מהמצבים הבאים לא מתקיים:

  • התוסף כולל קבצים מצורפים בפוסט.
  • פרויקט המפתח שממנו נשלחת הבקשה הוא אותו פרויקט שבו נוצר הפוסט.
attachmentId

string

זה שינוי אופציונלי. המזהה של הקובץ המצורף. השדה הזה נדרש בכל הבקשות, מלבד כשהמשתמש נמצא ב-iframe של Attachment Discovery.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של AddOnContext.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

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