REST Resource: courses

Ressource: Cours

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.

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

La spécification de ce champ dans un masque de mise à jour de cours génère une erreur.
name

string

Nom du cours. Exemple : "Biologie de 1re". Veuillez saisir un nom. Il doit comporter entre 1 et 750 caractères, et une chaîne UTF-8 valide.
section

string

section du cours. (par exemple, "Période 2"). S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne pas dépasser 2 800 caractères.
descriptionHeading

string

En-tête facultatif pour la description. Par exemple, "Bienvenue en biologie de 2de". S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne pas dépasser 3 600 caractères.
description

string

Description facultative. Par exemple : "Nous allons découvrir la structure des créatures vivantes grâce à un ensemble de manuels scolaires, de conférences organisées par des invités et de travaux de laboratoire. Attendez-vous à être enthousiaste !" S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne pas dépasser 30 000 caractères.
room

string

Emplacement facultatif de la salle. Exemple : "301". S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne pas dépasser 650 caractères.
ownerId

string

Identifiant du propriétaire d'un cours.

Lorsqu'il est spécifié en tant que paramètre d'un élément create course request, ce champ est obligatoire. Il peut s'agir de l'un des types d'identifiants suivants:

  • l'identifiant numérique de l'utilisateur
  • L'adresse e-mail de l'utilisateur
  • Le littéral de chaîne "me", indiquant l'utilisateur demandeur

Vous devez définir ce paramètre 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 cas, il est en lecture seule.
creationTime

string (Timestamp format)

Heure de création du cours. La spécification de ce champ dans un masque de mise à jour de cours génère une erreur.

En lecture seule.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Heure de la dernière mise à jour de ce cours. La spécification de ce champ dans un masque de mise à jour de cours génère une erreur.

En lecture seule.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

Code d'inscription à utiliser pour rejoindre ce cours. La spécification de ce champ dans un masque de mise à jour de cours génère une erreur.

En lecture seule.
courseState

enum (CourseState)

État du cours Si aucune valeur n'est spécifiée, l'état par défaut est PROVISIONED.
teacherGroupEmail

string

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

En lecture seule.
courseGroupEmail

string

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

En 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 du domaine.

En lecture seule.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Ensembles de supports figurant sur la page "À propos" de ce cours.

En lecture seule.
guardiansEnabled

boolean

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

En lecture seule.
calendarId

string

ID de l'agenda d'un agenda visible par tous les membres du cours, auquel Classroom ajoute des é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 mis à jour vers ACTIVE via l'interface utilisateur ou l'API). L'ID de l'agenda ne sera pas renseigné tant que le processus de création ne sera pas terminé.

En lecture seule.
gradebookSettings

object (GradebookSettings)

Les 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 la modifier, sauf pour la changer d'état.
PROVISIONED Le cours a été créé, mais pas encore activé. Il est accessible par l'enseignant principal et les administrateurs du domaine, qui peuvent le modifier, ou lui attribuer l'état ACTIVE ou DECLINED. Un cours ne peut être remplacé par PROVISIONED que s'il est à l'état DECLINED.
DECLINED Le cours a été créé, mais a été refusé. Le propriétaire du cours et les administrateurs du domaine peuvent y accéder, mais il ne s'affiche pas dans l'interface utilisateur Web. Vous ne pouvez pas modifier le cours, sauf pour le faire passer à l'état PROVISIONED. Un cours ne peut être remplacé par 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 le ownerId peut le consulter. Un cours peut être associé à cet état s'il est susceptible d'enfreindre les conditions d'utilisation.

CourseMaterialSet

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

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

string

Titre de cet ensemble.
materials[]

object (CourseMaterial)

Supports de cours associés à cet ensemble.

CourseMaterial

Support de cours associé à un cours faisant partie d'un ensemble de supports.

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 Material. material ne peut être qu'un des éléments suivants :
driveFile

object (DriveFile)

Fichier Google Drive en pièce jointe.
youTubeVideo

object (YouTubeVideo)

Vidéo YouTube en pièce jointe.
form

object (Form)

Pièce jointe Google Forms.

GradebookSettings

Paramètres du carnet de notes d'un cours. Pour en savoir plus, consultez cet 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 travaux et devoirs du cours.

CalculationType

Méthodes possibles pour calculer 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 des points totaux, 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 l'affichage de la note globale.

Enums
DISPLAY_SETTING_UNSPECIFIED Aucun paramètre spécifié. Cette valeur n'est jamais renvoyée.
SHOW_OVERALL_GRADE Indique aux enseignants et aux élèves la note globale dans le carnet de notes et le profil de l'élève.
HIDE_OVERALL_GRADE N'affiche pas la note globale 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 le profil de l'élève. ne s'affiche pas pour les élèves dans leur profil.

Méthodes

checkAddOnCreationEligibility

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

checkGradingPeriodsSetupEligibility

 Indique si un utilisateur peut mettre à jour les paramètres GradingPeriodSettings dans un cours donné.

create

 Crée un cours.

delete

 Supprime un cours.

get

 Renvoie un cours.

getGradingPeriodSettings

 Affiche les paramètres de la période de notation d'un cours.

list

 Affiche la liste des cours que l'utilisateur à l'origine de la requête est autorisé à consulter, limités à ceux qui correspondent à la requête.

patch

 Met à jour un ou plusieurs champs dans un cours.

update

 Met à jour un cours.

updateGradingPeriodSettings

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