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.

Si la valeur est creating a course, vous pouvez éventuellement définir cet identifiant sur alias string dans la requête afin de 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 du cours, une erreur est renvoyée.
name

string

Intitulé du cours. Exemple : "Biologie de terminale". 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. Exemple : "Période 2". S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne doit pas dépasser 2 800 caractères.
descriptionHeading

string

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

string

Description facultative. Par exemple : « Nous apprendrons la structure des créatures vivantes à partir d'une combinaison de manuels scolaires, de conférences et de travaux en laboratoire. Attendez-vous à être enthousiaste !" S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne doit pas dépasser 30 000 caractères.
room

string

Emplacement de la salle facultatif. Exemple : "301". S'il est défini, ce champ doit être une chaîne UTF-8 valide et ne doit 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 de create course request, ce champ est obligatoire. Il peut s'agir de l'un des éléments 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 à l'origine de la demande

Vous devez définir ces valeurs 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 les autres cas, 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 du cours, une erreur est renvoyée.

Lecture seule.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. 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. Si vous spécifiez ce champ dans un masque de mise à jour du cours, une erreur est renvoyée.

Lecture seule.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

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

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 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 supports de cours affichés 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 d'un agenda visible par tous les membres du cours, dans lequel Classroom ajoute des événements pour les devoirs et des annonces au cours 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 remplacé par ACTIVE via l'interface utilisateur ou l'API). L'ID de l'agenda n'est renseigné qu'une fois le processus de création terminé.

Lecture seule.
gradebookSettings

object (GradebookSettings)

Paramètres du carnet de notes qui indiquent comment la note globale d'un élève sera calculée et à qui elle sera présentée.

Lecture seule

CourseState

États possibles dans lesquels un cours peut se trouver.

Enums
COURSE_STATE_UNSPECIFIED Aucun état du 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 lui attribuer un état différent.
PROVISIONED Le cours a été créé, mais n'est 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é. Il est accessible par le propriétaire du cours et les administrateurs du domaine, bien qu'il ne soit pas affiché dans l'interface utilisateur Web. Vous ne pouvez pas modifier le cours, sauf pour lui attribuer 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 placé dans cet état s'il est susceptible d'enfreindre les conditions d'utilisation.

CourseMaterialSet

Ensemble de supports qui apparaît sur la page "À propos" du cours. Ces supports peuvent inclure un programme, 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 dans le cadre 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 pour 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 documents de travail du cours.

CalculationType

Méthodes possibles pour calculer la note globale.

Enums
CALCULATION_TYPE_UNSPECIFIED Aucune méthode spécifiée. Cet élément n'est jamais renvoyé.
TOTAL_POINTS La note globale correspond à la somme des notes divisée par la somme du total des 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 l'affichage de la note globale.

Enums
DISPLAY_SETTING_UNSPECIFIED Aucun paramètre spécifié. Cet élément n'est jamais renvoyé.
SHOW_OVERALL_GRADE Affiche la note globale dans le carnet de notes et sur le profil de l'élève, pour les enseignants et les élèves.
HIDE_OVERALL_GRADE La note globale n'apparaît 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 le profil de l'élève. est masqué pour les élèves dans leur profil d'élève ;

Méthodes

checkAddOnCreationEligibility

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

create

 Crée un cours.

delete

 Supprime un cours.

get

 Renvoie un cours.

list

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

patch

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

update

 Met à jour un cours.