Method: courses.studentGroups.list

Renvoie la liste des groupes d'un cours.

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

  • NOT_FOUND si le cours n'existe pas.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Obligatoire. Identifiant du cours.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal d'éléments à renvoyer. Si la valeur est zéro ou non spécifiée, le serveur peut attribuer un maximum, qui est actuellement défini sur 75 éléments.

Le serveur peut renvoyer un nombre de résultats inférieur à celui 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.

La requête list doit être identique à celle qui a généré ce jeton.
previewVersion

enum (PreviewVersion)

Facultatif. Version preview de l'API. Ce paramètre doit être défini pour accéder aux nouvelles fonctionnalités d'API mises à la disposition des développeurs dans le programme Preview.

Corps de la requête

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

Corps de la réponse

Réponse lors de la liste des groupes d'élèves.

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

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

object (StudentGroup)

Groupes d'élèves.
nextPageToken

string

Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, cela signifie qu'il n'y a plus de résultats.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

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