Les modules complémentaires Google Classroom sont désormais disponibles pour tous les développeurs. Pour en savoir plus, consultez la documentation sur les modules complémentaires.
Récupère les métadonnées des modules complémentaires Classroom dans le contexte d'un post spécifique.
Pour préserver l'intégrité de son propre modèle de données et d'autorisations, un module complémentaire doit appeler cette méthode pour valider les paramètres de requête et le rôle de l'utilisateur à l'origine de la requête chaque fois que le module complémentaire est ouvert dans un iframe.
Cette méthode renvoie les codes d'erreur suivants:
Identifiant de l'Announcement, de l'CourseWork ou de l'CourseWorkMaterial auquel l'élément joint est associé. Ce champ est obligatoire, mais n'est pas marqué comme tel pendant la migration depuis postId.
addOnToken
string
Facultatif. Jeton qui autorise la requête.
Le jeton est transmis en tant que paramètre de requête lorsque l'utilisateur est redirigé depuis Classroom vers l'URL du module complémentaire.
Le jeton d'autorisation est obligatoire si aucune des conditions suivantes n'est remplie:
Le module complémentaire contient des pièces jointes au post.
Le projet de développeur qui émet la requête est le même que celui qui a créé le post.
attachmentId
string
Facultatif. Identifiant de la pièce jointe. Ce champ est obligatoire pour toutes les requêtes, sauf lorsque l'utilisateur se trouve dans l'iframe de découverte des pièces jointes.
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de AddOnContext.
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: courses.posts.getAddOnContext\n\n| This method is deprecated; use the `course.announcements`, `course.courseWork` or `course.courseWorkMaterials` method instead.\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}/posts/{postId}/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| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\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| `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)."]]
