Method: courses.courseWorkMaterials.list

Renvoie une liste de supports de cours que le demandeur est autorisé à consulter.

Les élèves du cours ne peuvent consulter que les supports de cours PUBLISHED. Les enseignants du cours et les administrateurs de domaine peuvent consulter tous les supports de cours.

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

  • PERMISSION_DENIED si l'utilisateur demandeur n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si la requête est mal formée.
  • NOT_FOUND si le cours demandé n'existe pas.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Identifiant du cours. Cet identifiant peut être celui attribué par Classroom ou un alias.

Paramètres de requête

Paramètres
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Restriction sur l'état des devoirs à renvoyer. Seuls les supports de cours correspondants sont renvoyés. Si aucune valeur n'est spécifiée, les éléments dont l'état des devoirs est PUBLISHED sont renvoyés.
orderBy

string

Ordre de tri facultatif pour les résultats. Liste de champs séparés par une virgule avec un mot clé de tri facultatif. Le champ accepté est updateTime. Les mots clés de direction acceptés sont asc et desc. Si aucune valeur n'est spécifiée, le comportement par défaut est updateTime desc. Exemples : updateTime asc, updateTime
pageSize

integer

Nombre maximal d'éléments à renvoyer. Si la valeur est nulle ou non spécifiée, le serveur peut attribuer un maximum.

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.
materialDriveId

string

Filtrage facultatif des supports de cours comportant au moins un support Drive dont l'ID correspond à la chaîne fournie. Si materialLink est également spécifié, les supports de cours doivent comporter des supports correspondant aux deux filtres.
previewVersion

enum (PreviewVersion)

Facultatif. Version preview de l'API. Ce paramètre doit être défini pour accéder aux nouvelles fonctionnalités de l'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 supports de cours.

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

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

object (CourseWorkMaterial)

Éléments de support de cours 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.

Niveaux d'accès des autorisations

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

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

Pour en savoir plus, consultez le guide sur les autorisations.