REST Resource: courses

Risorsa: corso

Un corso in Classroom.

Rappresentazione 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)
  }
}
Campi
id

string

Identificatore di questo corso assegnato da Classroom.

Se creating a course, puoi impostare facoltativamente questo identificatore su un alias string nella richiesta per creare un alias corrispondente. Il id è ancora assegnato da Classroom e non può essere aggiornato dopo la creazione del corso.

Se specifichi questo campo in una maschera di aggiornamento del corso, viene generato un errore.
name

string

Nome del corso. Ad esempio, "Biologia, 10° anno". Il nome è obbligatorio. Deve avere una lunghezza compresa tra 1 e 750 caratteri e deve essere una stringa UTF-8 valida.
section

string

Sezione del corso. Ad esempio, "Periodo 2". Se impostato, questo campo deve essere una stringa UTF-8 valida e non deve contenere più di 2800 caratteri.
descriptionHeading

string

Intestazione facoltativa per la descrizione. Ad esempio, "Ti do il benvenuto al corso di biologia della 10a classe". Se impostato, questo campo deve essere una stringa UTF-8 valida e non deve superare i 3600 caratteri.
description

string

Descrizione facoltativa. Ad esempio, "Impareremo la struttura degli esseri viventi attraverso una combinazione di libri di testo, lezioni di ospiti e lavori di laboratorio. Ti aspettiamo con entusiasmo." Se impostato, questo campo deve essere una stringa UTF-8 valida e non deve superare i 30.000 caratteri.
room

string

Posizione facoltativa della stanza. Ad esempio, "301". Se impostato, questo campo deve essere una stringa UTF-8 valida e non deve superare i 650 caratteri.
ownerId

string

L'identificatore del proprietario di un corso.

Se specificato come parametro di un create course request, questo campo è obbligatorio. L'identificatore può essere uno dei seguenti:

  • l'identificatore numerico dell'utente
  • l'indirizzo email dell'utente
  • la stringa letterale "me", che indica l'utente che effettua la richiesta

Questo valore deve essere impostato in una richiesta di creazione. Gli amministratori possono anche specificare questo campo in un patch course request per trasferire la proprietà. In altri contesti, è di sola lettura.
creationTime

string (Timestamp format)

Data di creazione del corso. Se specifichi questo campo in una maschera di aggiornamento del corso, viene generato un errore.

Sola lettura.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Ora dell'aggiornamento più recente di questo corso. Se specifichi questo campo in una maschera di aggiornamento del corso, viene generato un errore.

Sola lettura.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

Codice di iscrizione da utilizzare per partecipare al corso. Se specifichi questo campo in una maschera di aggiornamento del corso, viene generato un errore.

Sola lettura.
courseState

enum (CourseState)

Stato del corso. Se non specificato, lo stato predefinito è PROVISIONED.
teacherGroupEmail

string

L'indirizzo email di un gruppo Google contenente tutti gli insegnanti del corso. Questo gruppo non accetta email e può essere utilizzato solo per le autorizzazioni.

Sola lettura.
courseGroupEmail

string

L'indirizzo email di un gruppo Google contenente tutti i membri del corso. Questo gruppo non accetta email e può essere utilizzato solo per le autorizzazioni.

Sola lettura.
teacherFolder

object (DriveFolder)

Informazioni su una cartella di Drive condivisa con tutti gli insegnanti del corso.

Questo campo verrà impostato solo per gli insegnanti del corso e per gli amministratori di dominio.

Sola lettura.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Insiemi di materiali visualizzati nella pagina "Informazioni" di questo corso.

Sola lettura.
guardiansEnabled

boolean

Indica se le notifiche per i tutori sono attive o meno per questo corso.

Sola lettura.
calendarId

string

L'ID calendario di un calendario visibile a tutti i membri del corso, a cui Classroom aggiunge gli eventi relativi ai lavori e agli annunci del corso.

Il calendario di un corso viene creato in modo asincrono quando il corso viene impostato su CourseState.ACTIVE per la prima volta (al momento della creazione o quando viene aggiornato su CourseState.ACTIVE tramite l'interfaccia utente o l'API).ACTIVE L'ID calendario non verrà compilato fino al completamento della procedura di creazione.

Sola lettura.
gradebookSettings

object (GradebookSettings)

Le impostazioni del registro dei voti che specificano come verrà calcolato il voto complessivo di uno studente per il corso e a chi verrà mostrato.

Sola lettura

CourseState

Possibili stati di un corso.

Enum
COURSE_STATE_UNSPECIFIED Nessuno stato del corso. Nessun messaggio del corso restituito utilizzerà questo valore.
ACTIVE Il corso sia attivo.
ARCHIVED Il corso è stato archiviato. Non puoi modificarlo, a meno che non lo imposti in uno stato diverso.
PROVISIONED Il corso è stato creato, ma non ancora attivato. È accessibile all'insegnante principale e agli amministratori di dominio, che possono modificarlo o impostarlo sugli stati ACTIVE o DECLINED. Un corso può essere modificato in PROVISIONED solo se è nello stato DECLINED.
DECLINED Il corso è stato creato, ma rifiutato. È accessibile al proprietario del corso e agli amministratori di dominio, anche se non viene visualizzato nell'interfaccia utente web. Non puoi modificare il corso, tranne per impostarlo sullo stato PROVISIONED. Un corso può essere modificato in DECLINED solo se è nello stato PROVISIONED.
SUSPENDED Il corso è stato sospeso. Non puoi modificare il corso e solo l'utente identificato dal ownerId può visualizzarlo. Un corso può essere inserito in questo stato se potenzialmente viola i Termini di servizio.

CourseMaterialSet

Un insieme di materiali che viene visualizzato nella pagina "Informazioni" del corso. Questi materiali possono includere un programma, una pianificazione o altre informazioni di contesto relative al corso nel suo complesso.

Rappresentazione JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Campi
title

string

Titolo per questo set.
materials[]

object (CourseMaterial)

Materiali allegati a questo set.

CourseMaterial

Un materiale allegato a un corso come parte di un insieme di materiali.

Rappresentazione 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.
}
Campi
Campo unione material. Dati del materiale. material può essere solo uno dei seguenti:
driveFile

object (DriveFile)

Allegato di file di Google Drive.
youTubeVideo

object (YouTubeVideo)

Allegato video di YouTube.
form

object (Form)

Allegato di Moduli Google.

GradebookSettings

Le impostazioni del registro di un corso. Per maggiori dettagli, consulta l'articolo del Centro assistenza.

Rappresentazione JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Campi
calculationType

enum (CalculationType)

Indica in che modo viene calcolato il voto complessivo.
displaySetting

enum (DisplaySetting)

Indica chi può visualizzare il voto complessivo.
gradeCategories[]

object (GradeCategory)

Categorie di voto disponibili per i lavori del corso.

CalculationType

Possibili metodi di calcolo del voto complessivo.

Enum
CALCULATION_TYPE_UNSPECIFIED Nessun metodo specificato. Questo valore non viene mai restituito.
TOTAL_POINTS Il voto complessivo è la somma dei voti divisa per la somma dei punti totali, indipendentemente dalla categoria.
WEIGHTED_CATEGORIES Il voto complessivo è la media ponderata per categoria.

DisplaySetting

Possibili impostazioni per la visualizzazione del voto complessivo.

Enum
DISPLAY_SETTING_UNSPECIFIED Nessuna impostazione specificata. Questo valore non viene mai restituito.
SHOW_OVERALL_GRADE Mostra il voto complessivo nel registro e nel profilo dello studente sia agli insegnanti che agli studenti.
HIDE_OVERALL_GRADE Non viene visualizzato il voto complessivo nel registro o nel profilo dello studente.
SHOW_TEACHERS_ONLY Mostra il voto complessivo agli insegnanti nel registro e nel profilo dello studente. Non viene mostrato agli studenti nel loro profilo.

Metodi

checkAddOnCreationEligibility
(deprecated)

 Restituisce se un utente è idoneo a creare allegati di componenti aggiuntivi in un determinato corso.

checkGradingPeriodsSetupEligibility
(deprecated)

 Restituisce se un utente è idoneo ad aggiornare GradingPeriodSettings in un determinato corso.

create

 Crea un corso.

delete

 Consente di eliminare un corso.

get

 Restituisce un corso.

getGradingPeriodSettings

 Restituisce le impostazioni del periodo di valutazione in un corso.

list

 Restituisce un elenco di corsi che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta.

patch

 Aggiorna uno o più campi di un corso.

update

 Aggiorna un corso.

updateGradingPeriodSettings

 Aggiorna le impostazioni del periodo di valutazione di un corso.