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 facoltativamente impostare 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.

La specifica di questo campo in una maschera di aggiornamento del corso genera un errore.
name

string

Il nome del corso. Ad esempio, "Biologia della seconda media". Il nome è obbligatorio. Deve avere una lunghezza compresa tra 1 e 750 caratteri e 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, "Ti diamo il benvenuto in biologia di terza media". 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 a conoscere la struttura degli esseri viventi grazie a una combinazione di libri di testo, lezioni per gli ospiti e lavori di laboratorio. Aspettati di essere entusiasti!" 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.

Se specificato come parametro di 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 che ha inviato la richiesta

Questo 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 e ora di creazione del corso. La specifica di questo campo in una maschera di aggiornamento del corso genera un errore.

Sola lettura.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi 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. La specifica di questo campo in una maschera di aggiornamento del corso genera un errore.

Sola lettura.

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

string

Codice di registrazione da utilizzare per partecipare a questo corso. La specifica di questo campo in una maschera di aggiornamento del corso genera 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 che contiene 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)

Insieme di materiali che vengono visualizzati nella pagina "Informazioni" di questo corso.

Sola lettura.
guardiansEnabled

boolean

Indica se le notifiche per i tutori sono attivate per questo corso.

Sola lettura.
calendarId

string

L'ID del calendario di un calendario visibile a tutti i membri del corso, a cui Classroom aggiunge eventi per il lavoro e gli annunci del corso.

Il calendario di un corso viene creato in modo asincrono quando il corso viene impostato per la prima volta su CourseState.ACTIVE (al momento della creazione o quando viene aggiornato a ACTIVE tramite l'interfaccia utente o l'API). L'ID calendario non verrà completato fino al completamento del processo 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

Possibili stati in cui può trovarsi un corso.

Enum
COURSE_STATE_UNSPECIFIED Nessuno stato del corso. Nessun messaggio di corso restituito utilizzerà questo valore.
ACTIVE Il corso è attivo.
ARCHIVED Il corso è stato archiviato. Non puoi modificarlo se non per passare a uno stato diverso.
PROVISIONED Il corso è stato creato, ma non è ancora stato attivato. È accessibile all'insegnante principale e agli amministratori di dominio, che possono modificarlo o impostarlo come ACTIVE o DECLINED. Un corso può essere modificato in PROVISIONED solo se è nello stato DECLINED.
DECLINED Il corso è stato creato, ma è stato rifiutato. È accessibile al proprietario del corso e agli amministratori di dominio, ma non verrà visualizzato nell'interfaccia utente web. Non puoi modificare il corso se non per passare allo 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 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 di studio, un programma o altre informazioni di base relative al corso nel suo complesso.

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

string

Titolo per questa serie.
materials[]

object (CourseMaterial)

Materiali allegati a questa serie.

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 di unione material. Dati dei materiali. material può essere solo uno dei seguenti:
driveFile

object (DriveFile)

Allegato file di Google Drive.
youTubeVideo

object (YouTubeVideo)

Allegato video di YouTube.
form

object (Form)

Allegato di Moduli Google.

GradebookSettings

Le impostazioni del registro per un corso. Per maggiori dettagli, consulta questo 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ò vedere il voto complessivo.
gradeCategories[]

object (GradeCategory)

Le categorie di voto disponibili per le attività del corso.

CalculationType

Possibili metodi di calcolo del voto complessivo.

Enum
CALCULATION_TYPE_UNSPECIFIED Nessun metodo specificato. Questo 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 visualizzare il voto complessivo.

Enum
DISPLAY_SETTING_UNSPECIFIED Nessuna impostazione specificata. Questo non viene mai restituito.
SHOW_OVERALL_GRADE Mostra il voto complessivo nel registro e nel profilo dello studente sia per gli insegnanti che per gli 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 nascosta agli studenti nel loro profilo.

Metodi

checkAddOnCreationEligibility

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

create

 Crea un corso.

delete

 Elimina un corso.

get

 Restituisce un corso.

list

 Restituisce un elenco di corsi che l'utente richiedente è autorizzato a visualizzare, limitato a quelli che corrispondono alla richiesta.

patch

 Consente di aggiornare uno o più campi di un corso.

update

 Aggiorna un corso.