Google Classroom-Add-ons sind jetzt allgemein für Entwickler verfügbar. Weitere Informationen finden Sie in der
Dokumentation zu Add-ons.
Method: courses.courseWork.getAddOnContext
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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 |
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.
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.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: courses.courseWork.getAddOnContext\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nGets metadata for Classroom add-ons in the context of a specific post.\n\nTo maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview).\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if one of the identified resources does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `itemId` | `string` Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from postId. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\n| `addOnToken` | `string` Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: - The add-on has attachments on the post. - The developer project issuing the request is the same project that created the post. |\n| `attachmentId` | `string` Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [AddOnContext](/workspace/classroom/reference/rest/v1/AddOnContext).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.addons.student`\n- `\n https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
