Method: courses.courseWorkMaterials.list

Affiche la liste des supports de cours que le demandeur est autorisé à consulter.

Les élèves ne peuvent voir que le PUBLISHED contenu du cours. Les enseignants du cours et les administrateurs du domaine peuvent consulter tous les documents du cours.

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

  • PERMISSION_DENIED si l'utilisateur à l'origine de la requête n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si la requête est incorrecte.
  • 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 l'identifiant attribué par Classroom ou un alias.

Paramètres de requête

Paramètres
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Restriction concernant l'état de la tâche à renvoyer. Seuls les éléments de cours correspondants sont renvoyés. Si ce paramètre n'est pas spécifié, les éléments dont l'état de travail 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, updateTime desc est le comportement par défaut. Exemples: updateTime asc, updateTime
pageSize

integer

Nombre maximal d'éléments à renvoyer. Une valeur nulle ou non spécifiée indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer un nombre inférieur au nombre de résultats 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 devoirs de cours contenant au moins un élément Drive dont l'ID correspond à la chaîne fournie. Si materialLink est également spécifié, le matériel de cours doit contenir des éléments correspondant aux deux filtres.

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

Champs d'application 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 d'autorisation.