Ruft die Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.
Um die Integrität seines eigenen Daten- und Berechtigungsmodells zu wahren, sollte ein Add-on dieses aufrufen, um die Suchparameter und die Rolle des anfragenden Nutzers zu validieren, wenn das Add-on in einem iFrame geöffnet wird.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
für Zugriffsfehler.INVALID_ARGUMENT
, wenn die Anfrage fehlerhaft ist.NOT_FOUND
, wenn eine der identifizierten Ressourcen nicht vorhanden ist.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/courses/{courseId}/posts/{postId}/addOnContext
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
courseId |
Erforderlich. ID des Kurses. |
postId |
Optional. Eingestellt. Verwenden Sie stattdessen „itemId“. |
Abfrageparameter
Parameter | |
---|---|
itemId |
Kennung der Ankündigung, der CourseWork oder dercourseWorkMaterial-Ankündigung, unter der der Anhang angehängt ist. Dieses Feld ist erforderlich, ist aber bei der Migration von postId nicht entsprechend gekennzeichnet. |
addOnToken |
Optional. Token, das die Anfrage autorisiert. Das Token wird als Abfrageparameter übergeben, wenn der Nutzer von Classroom zur URL des Add-ons weitergeleitet wird. Das Autorisierungstoken ist erforderlich, wenn keine der folgenden Bedingungen zutrifft:
|
attachmentId |
Optional. Die ID des Anhangs. Dieses Feld ist für alle Anfragen erforderlich, es sei denn, der Nutzer befindet sich im iFrame der Anhangserkennung. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von AddOnContext
.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.