REST Resource: courses

Ressource : Course

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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
Champs
id

string

Identifiant de ce cours attribué par Classroom.

Lorsque vous creating a course, vous pouvez éventuellement définir cet identifiant sur un 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éé.

La spécification de ce champ dans un masque de mise à jour de cours entraîne une erreur.
name

string

Nom du cours. Par exemple, "Biologie de seconde". 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". 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

Titre facultatif pour la description. Par exemple, "Bienvenue au cours de biologie de seconde". 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 allons étudier la structure des êtres vivants à l'aide de manuels, de conférences et de travaux pratiques. Préparez-vous à être émerveillé !" 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 facultatif de la salle. Par 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 d'un create course request, ce champ est obligatoire. L'identifiant peut être l'un des suivants :

  • Identifiant numérique de l'utilisateur
  • Adresse e-mail de l'utilisateur
  • La chaîne littérale "me", indiquant l'utilisateur demandeur

Ce champ doit être défini 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. La spécification de ce champ dans un masque de mise à jour de cours entraîne une erreur.

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. La spécification de ce champ dans un masque de mise à jour de cours entraîne une erreur.

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. La spécification de ce champ dans un masque de mise à jour de cours entraîne une erreur.

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

Lecture seule.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Ensembles de supports qui s'affichent 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 d'un agenda visible par tous les membres du cours, auquel Classroom ajoute des événements pour les devoirs et les 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 sur ACTIVE via l'UI 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.
subject

string

Facultatif. Sujet du cours.
learningStandardSettings

object (CourseLearningStandardSettings)

Facultatif.

Paramètres liés aux normes d'apprentissage disponibles dans le cours. Un cours ne peut pas comporter plus de 20 racines de référentiels de normes d'apprentissage.
levels

string

Facultatif. Niveaux du cours. Exemples : "9th grade", "Middle school", "4th - 5th", "K-2", "3000". S'il est défini, ce champ doit être une chaîne UTF-8 valide de moins de 1 000 caractères.

Ce champ ne peut être effacé qu'à l'aide de la méthode courses.patch.

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 le faire passer à un autre é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 le 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é. Il est accessible par le propriétaire du cours et les administrateurs du domaine, 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 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 l'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 s'affiche sur la page "À propos" du cours. Il peut s'agir d'un programme, d'un planning 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)

Matériaux associés à cet ensemble.

CourseMaterial

Support de cours joint à un cours dans le cadre d'un ensemble de supports de cours.

Représentation JSON 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Champs
Données matérielles. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
driveFile

object (DriveFile)

Pièce jointe Google Drive.
youTubeVideo

object (YouTubeVideo)

Vidéo YouTube en pièce jointe.
form

object (Form)

Pièce jointe Google Forms.
Fin des champs mutuellement exclusifs.

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 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 est la somme des notes divisée par la somme du total des points, quelle que soit la catégorie.
WEIGHTED_CATEGORIES La note globale est 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 Affiche la note globale dans le carnet de notes et le profil de l'élève, à la fois pour les enseignants et les élèves.
HIDE_OVERALL_GRADE La note globale ne s'affiche pas dans le carnet de notes ni sur le profil de l'élève.
SHOW_TEACHERS_ONLY Affiche la note globale pour les enseignants dans le carnet de notes et le profil de l'élève. Masquer pour les élèves dans leur profil d'élève.

CourseLearningStandardSettings

Paramètres des normes d'apprentissage pour un cours.

Représentation JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Champs
standardSets[]

object (LearningStandardSetRoot)

Obligatoire. Ensemble de racines de normes d'apprentissage appliquées à ce cours.

LearningStandardSetRoot

Représente la racine d'un ensemble sélectionné de normes d'apprentissage. Les descendants des racines sélectionnées s'afficheront lorsque vous définirez des objectifs d'apprentissage sur les éléments du flux dans l'interface utilisateur de Classroom.

Représentation JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Champs
caseGuid

object (CaseGuid)

Obligatoire. GUID Satchel Rosetta Exchange pour la racine d'un référentiel de normes d'apprentissage.
documentTitle

string

Uniquement en sortie. Titre du document de la racine du référentiel de normes d'apprentissage.
standardTitle

string

Uniquement en sortie. Titre de la racine du référentiel de normes d'apprentissage.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Uniquement en sortie. État de disponibilité de la racine du référentiel de normes d'apprentissage. Utilisez cette option pour déterminer si la racine du référentiel de normes d'apprentissage a été supprimée de la source.

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 paramètres GradingPeriodSettings d'un cours donné.

create

 Crée un cours.

delete

 Supprime un cours.

get

 Renvoie un cours.

getGradingPeriodSettings

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

list

 Renvoie la 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 de période de notation d'un cours.