REST Resource: courses

Ressource : Cours

Un cours dans Classroom.

Représentation JSON 
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  }
}
Champs
id

string

Identifiant de ce cours attribué par Classroom.

Lorsque creating a course, vous pouvez éventuellement définir cet identifiant sur alias string dans la requête pour créer un alias correspondant. Le id est toujours attribué par Classroom et ne peut pas être modifié une fois le cours créé.

Si vous spécifiez ce champ dans un masque de mise à jour de cours, une erreur se produit.
name

string

Nom du cours. Par exemple, "Biologie en 3e". Veuillez saisir un nom. Il doit comporter entre 1 et 750 caractères et être une chaîne UTF-8 valide.
section

string

Section du cours. Par exemple, "Période 2". Si ce champ est défini, il doit s'agir d'une chaîne UTF-8 valide et ne doit pas dépasser 2 800 caractères.
descriptionHeading

string

Titre facultatif pour la description. Par exemple, "Bienvenue en biologie de 3e". Si ce champ est défini, il doit s'agir d'une chaîne UTF-8 valide et ne doit pas dépasser 3 600 caractères.
description

string

Description facultative. Par exemple : "Nous allons étudier la structure des créatures vivantes à l'aide de manuels, de conférences et de travaux pratiques. Préparez-vous à être enthousiaste !" Si ce champ est défini, il doit s'agir d'une chaîne UTF-8 valide et ne doit pas dépasser 30 000 caractères.
room

string

Emplacement de la pièce (facultatif). Par exemple, "301". Si ce champ est défini, il doit s'agir d'une chaîne UTF-8 valide et ne doit pas dépasser 650 caractères.
ownerId

string

Identifiant du propriétaire d'un cours.

Ce champ est obligatoire lorsqu'il est spécifié en tant que paramètre d'un create course request. L'identifiant peut être l'un des suivants :

  • Identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur demandeur.

Cette valeur doit être définie dans une requête de création. Les administrateurs peuvent également spécifier ce champ dans un patch course request pour transférer la propriété. Dans d'autres contextes, il est en lecture seule.
creationTime

string (Timestamp format)

Heure de création du cours. Si vous spécifiez ce champ dans un masque de mise à jour de cours, une erreur se produit.

Lecture seule.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Heure de la dernière mise à jour de ce cours. Si vous spécifiez ce champ dans un masque de mise à jour de cours, une erreur se produit.

Lecture seule.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Code d'inscription à utiliser pour rejoindre ce cours. Si vous spécifiez ce champ dans un masque de mise à jour de cours, une erreur se produit.

Lecture seule.
courseState

enum (CourseState)

État du cours. Si aucun état n'est spécifié, la valeur par défaut est PROVISIONED.
teacherGroupEmail

string

Adresse e-mail d'un groupe Google contenant tous les enseignants du cours. Ce groupe n'accepte pas les e-mails et ne peut être utilisé que pour les autorisations.

Lecture seule.
courseGroupEmail

string

Adresse e-mail d'un groupe Google contenant tous les membres du cours. Ce groupe n'accepte pas les e-mails et ne peut être utilisé que pour les autorisations.

Lecture seule.
teacherFolder

object (DriveFolder)

Informations sur un dossier Drive partagé avec tous les enseignants du cours.

Ce champ ne sera défini que pour les enseignants du cours et les administrateurs de domaine.

Lecture seule.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Ensembles de ressources qui apparaissent sur la page "À propos" de ce cours.

Lecture seule.
guardiansEnabled

boolean

Indique si les notifications destinées aux représentants légaux sont activées pour ce cours.

Lecture seule.
calendarId

string

ID de l'agenda que tous les membres du cours peuvent consulter et dans lequel Classroom ajoute les événements liés aux devoirs et aux annonces du cours.

L'agenda d'un cours est créé de manière asynchrone lorsque le cours est défini sur CourseState.ACTIVE pour la première fois (au moment de la création ou lorsqu'il est défini sur ACTIVE via l'interface utilisateur ou l'API). L'ID de l'agenda ne sera renseigné qu'une fois le processus de création terminé.

Lecture seule.
gradebookSettings

object (GradebookSettings)

Paramètres du carnet de notes qui spécifient comment la note globale d'un élève pour le cours sera calculée et à qui elle sera affichée.

Lecture seule

CourseState

États possibles d'un cours.

Enums
COURSE_STATE_UNSPECIFIED Aucun état de cours. Aucun message de cours renvoyé n'utilisera cette valeur.
ACTIVE Le cours est actif.
ARCHIVED Le cours a été archivé. Vous ne pouvez pas le modifier, sauf pour changer son état.
PROVISIONED Le cours a été créé, mais pas encore activé. Elle est accessible à l'enseignant principal et aux administrateurs de domaine, qui peuvent la modifier ou la faire passer à l'état ACTIVE ou DECLINED. Un cours ne peut être défini sur PROVISIONED que s'il est à l'état DECLINED.
DECLINED Le cours a été créé, mais refusé. Le journal est accessible au propriétaire du cours et aux administrateurs du domaine, mais il ne s'affiche pas dans l'interface utilisateur Web. Vous ne pouvez pas modifier le cours, sauf pour le définir sur l'état PROVISIONED. Un cours ne peut être défini sur DECLINED que s'il est à l'état PROVISIONED.
SUSPENDED Le cours a été suspendu. Vous ne pouvez pas modifier le cours, et seul l'utilisateur identifié par ownerId peut le consulter. Un cours peut être placé dans cet état s'il est susceptible d'enfreindre les conditions d'utilisation.

CourseMaterialSet

Ensemble de ressources qui s'affiche sur la page "À propos" du cours. Il peut s'agir d'un programme, d'un calendrier ou d'autres informations générales sur le cours dans son ensemble.

Représentation JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Champs
title

string

Titre de cet ensemble.
materials[]

object (CourseMaterial)

Supports associés à cet ensemble.

CourseMaterial

Support de cours associé à un cours dans un ensemble de supports de cours.

Représentation JSON 
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
Champs
Champ d'union material. Données sur les matériaux. material ne peut être qu'un des éléments suivants :
driveFile

object (DriveFile)

Pièce jointe de fichier Google Drive.
youTubeVideo

object (YouTubeVideo)

Pièce jointe vidéo YouTube.
form

object (Form)

Pièce jointe Google Forms.

GradebookSettings

Paramètres du carnet de notes d'un cours. Pour en savoir plus, consultez l'article du Centre d'aide.

Représentation JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Champs
calculationType

enum (CalculationType)

Indique comment la note globale est calculée.
displaySetting

enum (DisplaySetting)

Indique qui peut voir la note globale.
gradeCategories[]

object (GradeCategory)

Catégories de notes disponibles pour les devoirs du cours.

CalculationType

Méthodes possibles de calcul de la note globale.

Enums
CALCULATION_TYPE_UNSPECIFIED Aucune méthode spécifiée. Cette valeur n'est jamais renvoyée.
TOTAL_POINTS La note globale correspond à la somme des notes divisée par la somme du nombre total de points, quelle que soit la catégorie.
WEIGHTED_CATEGORIES La note globale correspond à la moyenne pondérée par catégorie.

DisplaySetting

Paramètres possibles pour afficher la note globale.

Enums
DISPLAY_SETTING_UNSPECIFIED Aucun paramètre spécifié. Cette valeur n'est jamais renvoyée.
SHOW_OVERALL_GRADE Affiche la note globale dans le carnet de notes et le profil de l'élève pour les enseignants et les élèves.
HIDE_OVERALL_GRADE La note globale ne s'affiche pas dans le carnet de notes ni dans le profil de l'élève.
SHOW_TEACHERS_ONLY Affiche la note globale aux enseignants dans le carnet de notes et sur le profil des élèves. Elle est masquée pour les élèves dans leur profil.

Méthodes

checkAddOnCreationEligibility
(deprecated)

 Indique si un utilisateur est autorisé à créer des pièces jointes de modules complémentaires dans un cours donné.

checkGradingPeriodsSetupEligibility
(deprecated)

 Indique si un utilisateur est autorisé à modifier les GradingPeriodSettings d'un cours donné.

create

 Crée un cours.

delete

 Supprime un cours.

get

 Renvoie un cours.

getGradingPeriodSettings

 Renvoie les paramètres des périodes de notation d'un cours.

list

 Renvoie une liste des cours que l'utilisateur à l'origine de la requête est autorisé à consulter, en se limitant à ceux qui correspondent à la requête.

patch

 Met à jour un ou plusieurs champs d'un cours.

update

 Met à jour un cours.

updateGradingPeriodSettings

 Met à jour les paramètres des périodes de notation d'un cours.