REST Resource: courses

Risorsa: Course

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

string

Identificatore di questo corso assegnato da Classroom.

Quando creating a course, puoi facoltativamente impostare questo identificatore su un alias string nella richiesta per creare un alias corrispondente. id viene comunque 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

Il nome del corso. Ad esempio, "Biologia 2° superiore". Il nome è obbligatorio. Deve contenere da 1 a 750 caratteri ed 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 superare i 2800 caratteri.
descriptionHeading

string

Intestazione facoltativa per la descrizione. Ad esempio, "Benvenuti al corso di biologia del 2° anno". 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 lavoro di laboratorio. Preparati a un'esperienza entusiasmante!" Se impostato, questo campo deve essere una stringa UTF-8 valida e non deve superare i 30.000 caratteri.
room

string

Posizione della stanza facoltativa. 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.

Questo campo è obbligatorio se specificato come parametro di un create course request. 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 richiedente

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)

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

Sola lettura.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Sola lettura.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Codice di registrazione da utilizzare per partecipare a questo 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 viene 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 Drive condivisa con tutti gli insegnanti del corso.

Questo campo verrà impostato solo per gli insegnanti del corso e gli amministratori del 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 per questo corso.

Sola lettura.
calendarId

string

L'ID calendario di un calendario che tutti i membri del corso possono visualizzare, a cui Classroom aggiunge eventi per i lavori del corso e gli annunci nel 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 a ACTIVE tramite l'interfaccia utente o l'API). L'ID calendario non verrà compilato fino al completamento della procedura di creazione.

Sola lettura.
gradebookSettings

object (GradebookSettings)

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

Sola lettura.
subject

string

Facoltativo. L'argomento del corso.
learningStandardSettings

object (CourseLearningStandardSettings)

Facoltativo.

Impostazioni relative agli standard di apprendimento disponibili nel corso. A un corso possono essere assegnate al massimo 20 radici di set di standard di apprendimento.
levels

string

Facoltativo. Livelli del corso. Esempi: "9th grade", "Middle school", "4th - 5th", "K-2", "3000". Se impostato, questo campo deve essere una stringa UTF-8 valida e contenere meno di 1000 caratteri.

Questo campo può essere cancellato solo utilizzando il metodo courses.patch.

CourseState

Possibili stati in cui può trovarsi un corso.

Enum
COURSE_STATE_UNSPECIFIED Nessuno stato del corso. Nessun messaggio Course restituito utilizzerà questo valore.
ACTIVE Il corso è attivo.
ARCHIVED Il corso è stato archiviato. Non puoi modificarlo, se non per cambiarne lo stato.
PROVISIONED Il corso è stato creato, ma non è ancora stato 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 si trova nello stato DECLINED.
DECLINED Il corso è stato creato, ma rifiutato. È accessibile dal proprietario del corso e dagli amministratori del dominio, anche se non verrà visualizzato nell'interfaccia utente web. Non puoi modificare il corso, se non 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 da ownerId può visualizzarlo. Un corso può essere inserito in questo stato se viola potenzialmente i Termini di servizio.

CourseMaterialSet

Un insieme di materiali visualizzati nella pagina "Informazioni" del corso. Questi materiali potrebbero includere un programma, un calendario o altre informazioni di base relative al corso nel suo complesso.

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

string

Titolo di 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 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Campi
Dati sui materiali. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
driveFile

object (DriveFile)

File di Google Drive allegato.
youTubeVideo

object (YouTubeVideo)

Allegato video di YouTube.
form

object (Form)

Allegato di Moduli Google.
Fine dei campi che si escludono a vicenda.

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 come viene calcolato il voto complessivo.
displaySetting

enum (DisplaySetting)

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

object (GradeCategory)

Categorie di voto disponibili per i materiali 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

Impostazioni possibili per la visualizzazione della valutazione complessiva.

Enum
DISPLAY_SETTING_UNSPECIFIED Nessuna impostazione specificata. Questo valore non viene mai restituito.
SHOW_OVERALL_GRADE Mostra il voto complessivo nel registro dei voti e nel profilo dello studente sia agli insegnanti che agli studenti.
HIDE_OVERALL_GRADE Non mostra 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. Nasconde i dati agli studenti nel loro profilo.

CourseLearningStandardSettings

Le impostazioni del set di standard di apprendimento per un corso.

Rappresentazione JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Campi
standardSets[]

object (LearningStandardSetRoot)

Obbligatorio. L'insieme di radici degli standard di apprendimento applicati a questo corso.

LearningStandardSetRoot

Rappresenta la radice di un insieme selezionato di standard di apprendimento. I discendenti delle radici selezionate verranno mostrati quando imposti gli obiettivi di apprendimento sugli elementi dello stream nell'interfaccia utente di Classroom.

Rappresentazione JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Campi
caseGuid

object (CaseGuid)

Obbligatorio. Il GUID di Satchel Rosetta Exchange per una radice di un set di standard di apprendimento.
documentTitle

string

Solo output. Il titolo del documento della radice del set di standard di apprendimento.
standardTitle

string

Solo output. Il titolo della radice del set di standard di apprendimento.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Solo output. Lo stato di disponibilità della radice del set di standard di apprendimento. Utilizza questo campo per determinare se la radice del set di standard di apprendimento è stata eliminata dall'origine.

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

 Elimina un corso.

get

 Restituisce un corso.

getGradingPeriodSettings

 Restituisce le impostazioni del periodo di valutazione di un corso.

list

 Restituisce un elenco di corsi che l'utente richiedente è autorizzato a visualizzare, limitato a quelli che corrispondono 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.