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 per questo corso assegnato da Classroom.

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

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

string

Il nome del corso. Ad esempio, "Biologia di 10ª elementare". Il nome è obbligatorio. Deve contenere da 1 a 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 superare i 2800 caratteri.
descriptionHeading

string

Intestazione facoltativa per la descrizione. Ad esempio, "Benvenuto in Biologia di 1° superiore". Se impostato, questo campo deve essere una stringa UTF-8 valida e non deve superare i 3600 caratteri.
description

string

Descrizione facoltativa. Ad esempio, "Studieremo la struttura degli esseri viventi attraverso una combinazione di libri di testo, lezioni di ospiti e attività di laboratorio. Preparati a emozionarti." Se impostato, questo campo deve essere una stringa UTF-8 valida e non più lunga di 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
  • il valore letterale della stringa "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)

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

Sola lettura.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 questo campo viene specificato in una maschera di aggiornamento del corso, viene generato un errore.

Sola lettura.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 questo campo viene specificato 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 che contiene 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 di dominio.

Sola lettura.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

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

Sola lettura.
guardiansEnabled

boolean

Se le notifiche per i tutori sono abilitate per questo corso.

Sola lettura.
calendarId

string

L'ID calendario di un calendario visibile a tutti i membri del corso, a cui Classroom aggiunge eventi per i lavori del corso e gli 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 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

CourseState

Gli stati possibili di un corso.

Enum
COURSE_STATE_UNSPECIFIED Nessuno stato del corso. Nessun messaggio del corso 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 attivato. È accessibile all'insegnante principale e agli amministratori di dominio, che possono modificarlo o impostarlo sullo stato 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 al proprietario del corso e agli amministratori di dominio, anche se non verrà 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 si trova 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 potenzialmente viola i Termini di servizio.

CourseMaterialSet

Un insieme di materiali che vengono visualizzati nella pagina "Informazioni" del corso. Questi materiali possono 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 insieme.
materials[]

object (CourseMaterial)

I materiali allegati a questo set.

CourseMaterial

Un materiale allegato a un corso nell'ambito 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 sui materiali. 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 come viene calcolato il voto complessivo.
displaySetting

enum (DisplaySetting)

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

object (GradeCategory)

Le categorie di voto disponibili per i compiti 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 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 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. Viene nascosto agli studenti nel loro profilo.

Metodi

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

 Restituisce un valore che indica 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 dei 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.