Method: courses.topics.list

Renvoie la liste des sujets que le demandeur est autorisé à consulter.

Cette méthode renvoie les codes d'erreur suivants:

  • PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si le format de la requête est incorrect.
  • NOT_FOUND si le cours demandé n'existe pas.

Requête HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/topics

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Identifiant du cours. Il peut s'agir de l'identifiant attribué par Classroom ou d'un alias.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal d'articles à renvoyer. "0" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer moins de résultats que le nombre spécifié.
pageToken

string

Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée.

Par ailleurs, la requête list doit être identique à celle qui a généré ce jeton.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse lors de la création de la liste des sujets.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "topic": [
    {
      object (Topic)
    }
  ],
  "nextPageToken": string
}
Champs
topic[]

object (Topic)

Éléments de thème correspondant à la requête.
nextPageToken

string

Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/classroom.topics.readonly

Pour en savoir plus, consultez le Guide relatif aux autorisations.