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:
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
postId (deprecated)
string
Optional. Verworfen, verwenden Sie stattdessen itemId.
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.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2024-12-05 (UTC)."],[[["Retrieves metadata for Classroom add-ons within a specific post, validating user roles and query parameters."],["Requires `courseId`, `itemId` as path parameters, with optional query parameters like `addOnToken` and `attachmentId`."],["Returns an `AddOnContext` object upon successful execution, providing relevant add-on information."],["May return errors such as `PERMISSION_DENIED`, `INVALID_ARGUMENT`, or `NOT_FOUND` based on the request."],["Needs authorization with specific OAuth scopes, like `classroom.addons.student` or `classroom.addons.teacher`, for access."]]],[]]
