Method: courses.courseWork.getAddOnContext

Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.

Um die Integrität des eigenen Daten- und Berechtigungsmodells zu wahren, sollte ein Add-on diese Funktion aufrufen, um Abfrageparameter 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}/courseWork/{itemId}/addOnContext

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Erforderlich. Kennung des Kurses.
itemId

string

Kennung der Announcement, CourseWork oder CourseWorkMaterial, unter der der Anhang angehängt ist. Dieses Feld ist erforderlich, wird aber während der Migration von postId nicht als solches gekennzeichnet.

Abfrageparameter

Parameter
addOnToken

string

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:

  • Das Add-on enthält Anhänge zum Beitrag.
  • Das Entwicklerprojekt, das die Anfrage stellt, ist dasselbe Projekt, in dem der Beitrag erstellt wurde.
attachmentId

string

Optional. Die Kennung des Anhangs. Dieses Feld ist für alle Anfragen erforderlich, es sei denn, der Nutzer befindet sich im iframe für die Suche nach Anhängen.

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.