Method: courses.courseWork.getAddOnContext

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

Damit die Integrität des eigenen Daten- und Berechtigungsmodells gewahrt bleibt, sollte ein Add-on es aufrufen, um 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}/courseWork/{itemId}/addOnContext

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Erforderlich. ID des Kurses.
itemId

string

ID der Ankündigung, von „courseWork“ oder „courseWorkMaterial“, unter der der Anhang angehängt ist. Dieses Feld ist erforderlich, ist 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 an die URL des Add-ons weitergeleitet wird.

Das Autorisierungstoken ist erforderlich, wenn keine der folgenden Bedingungen zutrifft:

  • Das Add-on enthält Anhänge im Beitrag.
  • Das Entwicklerprojekt, von dem die Anfrage stammt, ist das Projekt, von dem der Beitrag erstellt wurde.

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.