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 di creazione di un alias corrispondente. id viene 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, verrà generato un errore.
name

string

Il nome del corso. Ad esempio, "Biologia di seconda superiore". Il nome è obbligatorio. Deve contenere da 1 a 750 caratteri e deve contenere una stringa UTF-8 valida.
section

string

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

string

Intestazione facoltativa per la descrizione. Ad esempio, "Ti diamo il benvenuto in biologia di seconda superiore". Se impostato, questo campo deve essere una stringa UTF-8 valida e non più lunga di 3600 caratteri.
description

string

Descrizione facoltativa. Ad esempio, "Impariamo a conoscere la struttura degli esseri viventi grazie a una combinazione di libri di testo, lezioni degli ospiti e lavori di laboratorio. Aspettati di essere entusiasta." Se impostato, questo campo deve contenere 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 più lunga di 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

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. Se specifichi questo campo in una maschera di aggiornamento del corso, verrà generato un errore.

Sola lettura.

Un timestamp nel formato RFC3339 UTC "Zulu" 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. Se specifichi questo campo in una maschera di aggiornamento del corso, verrà generato un errore.

Sola lettura.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 l'iscrizione a questo corso. Se specifichi questo campo in una maschera di aggiornamento del corso, verrà 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 che compaiono nella sezione "Informazioni" pagina di questo corso.

Sola lettura.
guardiansEnabled

boolean

Indica se le notifiche per i tutori sono abilitate 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 eventi per i lavori del corso e annunci durante il 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 la UI o l'API). L'ID del calendario verrà inserito solo dopo il 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à visualizzato.

Sola lettura

CourseState

Gli stati possibili in cui può trovarsi 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 modificarlo in un altro stato.
PROVISIONED Il corso è stato creato, ma non ancora attivato. È accessibile all'insegnante principale e agli amministratori di dominio, che possono modificarlo o cambiarlo nello stato ACTIVE o DECLINED. Un corso può essere modificato in PROVISIONED solo se lo stato è DECLINED.
DECLINED Il corso è stato creato, ma è stato rifiutato. È accessibile dal proprietario del corso e dagli amministratori di dominio, ma non verrà visualizzato nella UI web. Non puoi modificare il corso se non cambiarlo nello stato PROVISIONED. Un corso può essere modificato in DECLINED solo se lo stato è PROVISIONED.
SUSPENDED Il corso è stato sospeso. Non puoi modificare il corso e solo l'utente identificato dall'ownerId può visualizzarlo. Un corso può essere inserito in questo stato se potenzialmente viola i Termini di servizio.

CourseMaterialSet

Un insieme di materiali che appare nella sezione "Informazioni" pagina del corso. Questi materiali potrebbero includere un programma didattico, 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 questo insieme.
materials[]

object (CourseMaterial)

Materiali allegati a questo set.

CourseMaterial

Materiale allegato a un corso come parte di un set 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 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 informazioni dettagliate, 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ò vedere il voto complessivo.
gradeCategories[]

object (GradeCategory)

Categorie di voto disponibili per le attività del corso.

CalculationType

Possibili metodi di calcolo del voto complessivo.

Enum
CALCULATION_TYPE_UNSPECIFIED Nessun metodo specificato. Non viene mai restituito.
TOTAL_POINTS Voto complessivo è la somma dei voti divisa per la somma dei punti totali, indipendentemente dalla categoria.
WEIGHTED_CATEGORIES Voto complessivo indica la media ponderata per categoria.

DisplaySetting

Possibili impostazioni per la visualizzazione del voto complessivo.

Enum
DISPLAY_SETTING_UNSPECIFIED Nessuna impostazione specificata. Non viene mai restituito.
SHOW_OVERALL_GRADE Mostra il voto complessivo nel registro e nel profilo dello studente a insegnanti e 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 dagli studenti nel loro profilo.

Metodi

checkAddOnCreationEligibility

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

checkGradingPeriodsSetupEligibility

 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 in un corso.

list

 Restituisce un elenco dei corsi che l'utente che ha inviato la richiesta è autorizzato a visualizzare, limitato a quelli che corrispondono alla richiesta.

patch

 Aggiorna uno o più campi di un corso.

update

 Consente di aggiornare un corso.

updateGradingPeriodSettings

 Aggiorna le impostazioni del periodo di valutazione di un corso.