- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
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 ses propres données et modèles 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 demande chaque fois qu'il est ouvert dans un iFrame.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED
pour les erreurs d'accèsINVALID_ARGUMENT
si le format de la requête est incorrect.NOT_FOUND
si l'une des ressources identifiées n'existe pas.
Requête HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{itemId}/addOnContext
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
courseId |
Obligatoire. Identifiant du cours. |
itemId |
Identifiant de l'annonce, du cours CourseWork ou du CourseWorkMaterial auquel la pièce jointe est jointe. Ce champ est obligatoire, mais n'est pas marqué comme tel lors de la migration depuis postId. |
Paramètres de requête
Paramètres | |
---|---|
addOnToken |
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 lorsque aucune des conditions suivantes n'est vraie:
|
attachmentId |
Facultatif. Identifiant du rattachement. Ce champ est obligatoire pour toutes les demandes, sauf lorsque l'utilisateur se trouve dans l'iFrame de découverte de 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 :
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
Pour en savoir plus, consultez le Guide relatif aux autorisations.