Method: courses.announcements.getAddOnContext

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:

  • PERMISSION_DENIED pour les erreurs d'accès.
  • INVALID_ARGUMENT si la requête est incorrecte.
  • 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

string

Obligatoire. Identifiant du cours.
itemId

string

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.

Paramètres de requête

Paramètres
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 :

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

Pour en savoir plus, consultez le guide d'autorisation.