Method: courses.announcements.getAddOnContext

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

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

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
courseId

string

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

string

המזהה של ההודעה, הקורס אורך את הקורס 'WorkWorkMaterial' או של הקורס שאליו מצורף הקובץ. חובה למלא את השדה הזה, אבל הוא לא מסומן ככזה בזמן שאנחנו מבצעים העברה מ-postId.

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

פרמטרים
addOnToken

string

אפשרות. אסימון שמאשר את הבקשה.

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

אסימון ההרשאה נדרש כאשר אף אחד מהתנאים הבאים מתקיים:

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

גוף הבקשה

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

גוף התגובה

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

היקפי הרשאות

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

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

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