REST Resource: forms

Risorsa: modulo

Un documento di Moduli Google. Viene creato un modulo in Drive; per eliminarlo o modificarne le protezioni di accesso, utilizza l'API Drive.

Rappresentazione JSON 
{
  "formId": string,
  "info": {
    object (Info)
  },
  "settings": {
    object (FormSettings)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "revisionId": string,
  "responderUri": string,
  "linkedSheetId": string
}
Campi
formId

string

Solo output. L'ID modulo.
info

object (Info)

Obbligatorio. Il titolo e la descrizione del modulo.
settings

object (FormSettings)

Le impostazioni del modulo. Deve essere aggiornato con UpdateSettingsRequest; viene ignorato durante forms.create e UpdateFormInfoRequest.
items[]

object (Item)

Obbligatorio. Un elenco di elementi del modulo, che possono includere intestazioni di sezione, domande, contenuti multimediali incorporati e così via.
revisionId

string

Solo output. L'ID revisione del modulo. Utilizzato in WriteControl nelle richieste di aggiornamento per identificare la revisione su cui si basano le modifiche.

Il formato dell'ID revisione può cambiare nel tempo, pertanto deve essere considerato in modo opaco. Viene garantito che un ID revisione restituito sia valido solo per 24 ore dopo la restituzione e non possa essere condiviso tra gli utenti. Se l'ID revisione non è stato modificato tra una chiamata e l'altra, significa che il modulo non è stato modificato. Al contrario, un ID modificato (per lo stesso modulo e lo stesso utente) di solito significa che il modulo è stato aggiornato; tuttavia, un ID modificato può anche essere dovuto a fattori interni come modifiche al formato dell'ID.
responderUri

string

Solo output. L'URI del modulo da condividere con gli utenti che rispondono. Si apre una pagina che consente all'utente di inviare le risposte, ma non di modificare le domande.
linkedSheetId

string

Solo output. L'ID del foglio Google collegato che sta accumulando risposte da questo modulo (se esiste un foglio di questo tipo).

Informazioni

Informazioni generali per un modulo.

Rappresentazione JSON 
{
  "title": string,
  "documentTitle": string,
  "description": string
}
Campi
title

string

Obbligatorio. Il titolo del modulo visibile a chi risponde.
documentTitle

string

Solo output. Il titolo del documento visibile su Drive. Se Info.title è vuoto, documentTitle potrebbe essere inserito al suo posto nell'interfaccia utente di Moduli Google ed essere visibile a chi risponde. documentTitle può essere impostato al momento della creazione, ma non da una richiesta batchUpdate. Utilizza l'API Google Drive se devi aggiornare documentTitle in modo programmatico.
description

string

La descrizione del modulo.

FormSettings

Le impostazioni di un modulo.

Rappresentazione JSON 
{
  "quizSettings": {
    object (QuizSettings)
  }
}
Campi
quizSettings

object (QuizSettings)

Impostazioni relative ai moduli dei quiz e alla valutazione.

QuizSettings

Impostazioni relative ai moduli dei quiz e alla valutazione. Questi valori devono essere aggiornati con UpdateSettingsRequest.

Rappresentazione JSON 
{
  "isQuiz": boolean
}
Campi
isQuiz

boolean

Se questo modulo è un quiz o meno. Se il valore è true, le risposte vengono valutate in base alla domanda Grading. Se viene impostato su false, tutte le domande Grading vengono eliminate.

Articolo

Un singolo elemento del modulo. kind definisce il tipo di elemento.

Rappresentazione JSON 
{
  "itemId": string,
  "title": string,
  "description": string,

  // Union field kind can be only one of the following:
  "questionItem": {
    object (QuestionItem)
  },
  "questionGroupItem": {
    object (QuestionGroupItem)
  },
  "pageBreakItem": {
    object (PageBreakItem)
  },
  "textItem": {
    object (TextItem)
  },
  "imageItem": {
    object (ImageItem)
  },
  "videoItem": {
    object (VideoItem)
  }
  // End of list of possible types for union field kind.
}
Campi
itemId

string

L'ID articolo.

Può essere fornito al momento della creazione, ma l'ID non deve essere già utilizzato nel modulo. Se non viene specificato, viene assegnato un nuovo ID.
title

string

Il titolo dell'articolo.
description

string

La descrizione dell'articolo.
Campo di unione kind. Obbligatorio. Il tipo di elemento desiderato. kind può essere solo uno dei seguenti:
questionItem

object (QuestionItem)

Pone una domanda all'utente.
questionGroupItem

object (QuestionGroupItem)

Pone una o più domande all'utente con un'unica richiesta principale.
pageBreakItem

object (PageBreakItem)

Inizia una nuova pagina con un titolo.
textItem

object (TextItem)

Mostra un titolo e una descrizione nella pagina.
imageItem

object (ImageItem)

Visualizza un'immagine sulla pagina.
videoItem

object (VideoItem)

Mostra un video nella pagina.

QuestionItem

Un elemento del modulo contenente una singola domanda.

Rappresentazione JSON 
{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}
Campi
question

object (Question)

Obbligatorio. La domanda visualizzata.
image

object (Image)

L'immagine visualizzata all'interno della domanda.

Domanda

Qualsiasi domanda. Il tipo specifico di domanda è noto dal relativo kind.

Rappresentazione JSON 
{
  "questionId": string,
  "required": boolean,
  "grading": {
    object (Grading)
  },

  // Union field kind can be only one of the following:
  "choiceQuestion": {
    object (ChoiceQuestion)
  },
  "textQuestion": {
    object (TextQuestion)
  },
  "scaleQuestion": {
    object (ScaleQuestion)
  },
  "dateQuestion": {
    object (DateQuestion)
  },
  "timeQuestion": {
    object (TimeQuestion)
  },
  "fileUploadQuestion": {
    object (FileUploadQuestion)
  },
  "rowQuestion": {
    object (RowQuestion)
  }
  // End of list of possible types for union field kind.
}
Campi
questionId

string

Sola lettura. L'ID della domanda.

Può essere fornito al momento della creazione, ma l'ID non deve essere già utilizzato nel modulo. Se non viene specificato, viene assegnato un nuovo ID.
required

boolean

Indica se è necessario rispondere alla domanda per consentire all'intervistato di inviare la sua risposta.
grading

object (Grading)

Configurazione della valutazione per la domanda.
Campo di unione kind. Obbligatorio. Il tipo di domanda offerta a un intervistato. kind può essere solo uno dei seguenti:
choiceQuestion

object (ChoiceQuestion)

L'intervistato può scegliere da un insieme predefinito di opzioni.
textQuestion

object (TextQuestion)

Chi risponde può inserire un testo di risposta libero.
scaleQuestion

object (ScaleQuestion)

Un intervistato può scegliere un numero da un intervallo.
dateQuestion

object (DateQuestion)

Chi risponde può inserire una data.
timeQuestion

object (TimeQuestion)

L'intervistato può inserire un'ora.
fileUploadQuestion

object (FileUploadQuestion)

Un intervistato può caricare uno o più file.
rowQuestion

object (RowQuestion)

Una riga di QuestionGroupItem.

ChoiceQuestion

Una domanda con opzione radio, casella di controllo o menu a discesa.

Rappresentazione JSON 
{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}
Campi
type

enum (ChoiceType)

Obbligatorio. Il tipo di domanda a scelta.
options[]

object (Option)

Obbligatorio. Elenco di opzioni tra cui l'intervistato deve scegliere.
shuffle

boolean

Indica se le opzioni devono essere visualizzate in ordine casuale per diverse istanze del quiz. Questo viene spesso utilizzato per prevenire imbrogli da parte degli intervistati che potrebbero guardare lo schermo di un altro intervistato o per risolvere i bias in un sondaggio che potrebbe essere introdotto mettendo sempre le stesse opzioni all'inizio o all'ultimo.

ChoiceType

Il tipo di scelta.

Enum
CHOICE_TYPE_UNSPECIFIED Valore predefinito. Non utilizzato.
RADIO Pulsanti di opzione: tutte le opzioni vengono mostrate all'utente, che può sceglierne solo una.
CHECKBOX Caselle di controllo: tutte le opzioni vengono mostrate all'utente, che può selezionarne un numero illimitato.
DROP_DOWN Menu a discesa: le opzioni vengono mostrate all'utente solo su richiesta, altrimenti viene mostrata solo la scelta corrente. È possibile scegliere una sola opzione.

Opzione

Un'opzione per una domanda a scelta.

Rappresentazione JSON 
{
  "value": string,
  "image": {
    object (Image)
  },
  "isOther": boolean,

  // Union field go_to_section can be only one of the following:
  "goToAction": enum (GoToAction),
  "goToSectionId": string
  // End of list of possible types for union field go_to_section.
}
Campi
value

string

Obbligatorio. La scelta presentata all'utente.
image

object (Image)

Visualizza immagine come opzione.
isOther

boolean

Indica se l'opzione è "altro". Attualmente si applica solo ai tipi di scelta RADIO e CHECKBOX, ma non è consentito in un QuestionGroupItem.
Campo di unione go_to_section. La sezione a cui andare se questa opzione è selezionata. Attualmente si applica solo al tipo di scelta RADIO e SELECT, ma non è consentita in un QuestionGroupItem. go_to_section può essere solo uno dei seguenti:
goToAction

enum (GoToAction)

Tipo di navigazione nella sezione.
goToSectionId

string

ID elemento dell'intestazione della sezione a cui andare.

GoToAction

Costanti per la navigazione delle sezioni.

Enum
GO_TO_ACTION_UNSPECIFIED Valore predefinito. Non utilizzato.
NEXT_SECTION Vai alla sezione successiva.
RESTART_FORM Torna all'inizio del modulo.
SUBMIT_FORM Invia il modulo immediatamente.

Immagine

Dati che rappresentano un'immagine.

Rappresentazione JSON 
{
  "contentUri": string,
  "altText": string,
  "properties": {
    object (MediaProperties)
  },

  // Union field image_source can be only one of the following:
  "sourceUri": string
  // End of list of possible types for union field image_source.
}
Campi
contentUri

string

Solo output. Un URI da cui è possibile scaricare l'immagine. Questo valore è valido solo per un periodo di tempo limitato.
altText

string

Una descrizione dell'immagine che viene visualizzata al passaggio del mouse e letta dagli screen reader.
properties

object (MediaProperties)

Proprietà di un'immagine.
Campo di unione image_source. Il tipo di origine dell'immagine. Quando crei nuove immagini, devi impostare esattamente un campo di origine dell'immagine. image_source può essere solo uno dei seguenti:
sourceUri

string

Solo input. L'URI di origine è l'URI utilizzato per inserire l'immagine. L'URI di origine può essere vuoto quando viene recuperato.

MediaProperties

Proprietà del supporto.

Rappresentazione JSON 
{
  "alignment": enum (Alignment),
  "width": integer
}
Campi
alignment

enum (Alignment)

Posizione dei media.
width

integer

La larghezza dell'elemento multimediale in pixel. Quando l'elemento multimediale viene visualizzato, viene ridimensionato in base al valore inferiore o alla larghezza del modulo visualizzato. Le proporzioni originali dei contenuti multimediali vengono mantenute. Se la larghezza non viene specificata quando il supporto viene aggiunto al modulo, viene impostata sulla larghezza dell'origine multimediale. La larghezza deve essere compresa tra 0 e 740 inclusi. L'impostazione della larghezza su 0 o non specificata è consentita solo quando si aggiorna l'origine multimediale.

Allineamento

Allineamento sulla pagina.

Enum
ALIGNMENT_UNSPECIFIED Valore predefinito. Non utilizzato.
LEFT Allinea a sinistra.
RIGHT Allinea a destra.
CENTER Al centro.

TextQuestion

Una domanda di tipo testuale.

Rappresentazione JSON 
{
  "paragraph": boolean
}
Campi
paragraph

boolean

Se la domanda è una domanda a paragrafo o meno. In caso contrario, la domanda è una breve domanda di testo.

ScaleQuestion

Una domanda su vasta scala. L'utente può scegliere tra un intervallo di valori numerici.

Rappresentazione JSON 
{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}
Campi
low

integer

Obbligatorio. Il valore più basso possibile per la bilancia.
high

integer

Obbligatorio. Il valore più alto possibile per la bilancia.
lowLabel

string

L'etichetta da visualizzare che descrive il punto più basso della scala.
highLabel

string

L'etichetta da visualizzare che descrive il punto più alto della bilancia.

DateQuestion

Una domanda sulla data. Per impostazione predefinita, le domande sulla data sono relative a solo mese + giorno.

Rappresentazione JSON 
{
  "includeTime": boolean,
  "includeYear": boolean
}
Campi
includeTime

boolean

Indica se includere l'ora nella domanda.
includeYear

boolean

Se includere l'anno nella domanda.

TimeQuestion

Una domanda sul tempo.

Rappresentazione JSON 
{
  "duration": boolean
}
Campi
duration

boolean

true se la domanda riguarda un tempo trascorso. Altrimenti, si tratta di un'ora del giorno.

FileUploadQuestion

Una domanda per il caricamento di un file. L'API attualmente non supporta la creazione di domande per il caricamento file.

Rappresentazione JSON 
{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}
Campi
folderId

string

Obbligatorio. L'ID della cartella di Drive in cui sono archiviati i file caricati.
types[]

enum (FileType)

Tipi di file accettati da questa domanda.
maxFiles

integer

Numero massimo di file che è possibile caricare per questa domanda in una singola risposta.
maxFileSize

string (int64 format)

Numero massimo di byte consentiti per ogni singolo file caricato in questa domanda.

FileType

Tipi di file che possono essere caricati in risposta a una domanda per il caricamento di file.

Enum
FILE_TYPE_UNSPECIFIED Valore predefinito. Non utilizzato.
ANY Nessuna limitazione sul tipo.
DOCUMENT Un documento di Documenti Google.
PRESENTATION Una presentazione di Presentazioni Google.
SPREADSHEET Un foglio di lavoro Fogli Google.
DRAWING Un disegno.
PDF Un PDF.
IMAGE Un'immagine.
VIDEO Un video.
AUDIO Un file audio.

RowQuestion

Configurazione di una domanda che fa parte di un gruppo di domande.

Rappresentazione JSON 
{
  "title": string
}
Campi
title

string

Obbligatorio. Il titolo della singola riga in QuestionGroupItem.

Valutazione

Valutazione di una singola domanda

Rappresentazione JSON 
{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}
Campi
pointValue

integer

Obbligatorio. Il numero massimo di punti che un intervistato può ottenere automaticamente per una risposta corretta. Questo valore non deve essere negativo.
correctAnswers

object (CorrectAnswers)

Obbligatorio. La chiave di risposta per la domanda. Le risposte vengono valutate automaticamente in base a questo campo.
whenRight

object (Feedback)

Il feedback visualizzato per le risposte corrette. Questo feedback può essere impostato solo per domande a scelta multipla per le quali sono state fornite risposte corrette.
whenWrong

object (Feedback)

Il feedback visualizzato per le risposte errate. Questo feedback può essere impostato solo per domande a scelta multipla per le quali sono state fornite risposte corrette.
generalFeedback

object (Feedback)

Il feedback visualizzato per tutte le risposte. Questo viene comunemente utilizzato per le domande a risposta breve quando il proprietario di un quiz vuole dare rapidamente agli intervistati un'idea di se hanno risposto correttamente alla domanda prima di avere la possibilità di valutare ufficialmente la risposta. Impossibile impostare un feedback generale per le domande a scelta multipla valutate automaticamente.

CorrectAnswers

La chiave di risposta per una domanda.

Rappresentazione JSON 
{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}
Campi
answers[]

object (CorrectAnswer)

Un elenco di risposte corrette. La risposta a un quiz può essere valutata automaticamente in base a queste risposte. Per le domande a valore singolo, una risposta viene contrassegnata come corretta se corrisponde a qualsiasi valore in questo elenco (in altre parole, sono possibili più risposte corrette). Per le domande a più valori (CHECKBOX), una risposta viene contrassegnata come corretta se contiene esattamente i valori presenti nell'elenco.

CorrectAnswer

Un'unica risposta corretta a una domanda. Per le domande a più valori (CHECKBOX), potrebbero essere necessarie più CorrectAnswer per rappresentare un'unica opzione di risposta corretta.

Rappresentazione JSON 
{
  "value": string
}
Campi
value

string

Obbligatorio. Il valore della risposta corretto. Per informazioni dettagliate sulla formattazione dei vari tipi di valore, consulta la documentazione relativa a TextAnswer.value.

QuestionGroupItem

Definisce una domanda che comprende più domande raggruppate insieme.

Rappresentazione JSON 
{
  "questions": [
    {
      object (Question)
    }
  ],
  "image": {
    object (Image)
  },

  // Union field kind can be only one of the following:
  "grid": {
    object (Grid)
  }
  // End of list of possible types for union field kind.
}
Campi
questions[]

object (Question)

Obbligatorio. Un elenco di domande che appartengono a questo gruppo di domande. Una domanda deve appartenere a un solo gruppo. I kind del gruppo possono influire sui tipi di domande consentiti.
image

object (Image)

L'immagine visualizzata all'interno del gruppo di domande sopra le domande specifiche.
Campo di unione kind. Obbligatorio. Il tipo di gruppo di domande, che determina quali tipi di domande sono consentiti e come vengono visualizzati. kind può essere solo uno dei seguenti:
grid

object (Grid)

Il gruppo di domande è una griglia con righe di domande a scelta multipla che condividono le stesse opzioni. Se il criterio grid è impostato, tutte le domande del gruppo devono essere di tipo row.

Griglia

Una griglia di opzioni (radio o caselle di controllo) in cui ogni riga costituisce una domanda separata. Ogni riga ha le stesse scelte, che sono mostrate come colonne.

Rappresentazione JSON 
{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}
Campi
columns

object (ChoiceQuestion)

Obbligatorio. Le scelte condivise da ogni domanda nella griglia. In altre parole, i valori delle colonne. Sono consentite solo CHECK_BOX e RADIO scelte.
shuffleQuestions

boolean

Se true, le domande sono in ordine casuale. In altre parole, le righe vengono visualizzate in un ordine diverso per ogni intervistato.

PageBreakItem

Un'interruzione di pagina. Il titolo e la descrizione di questo elemento vengono visualizzati nella parte superiore della nuova pagina.

TextItem

Un elemento di testo.

ImageItem

Un elemento contenente un'immagine.

Rappresentazione JSON 
{
  "image": {
    object (Image)
  }
}
Campi
image

object (Image)

Obbligatorio. L'immagine visualizzata nell'elemento.

VideoItem

Un elemento contenente un video.

Rappresentazione JSON 
{
  "video": {
    object (Video)
  },
  "caption": string
}
Campi
video

object (Video)

Obbligatorio. Il video visualizzato nell'elemento.
caption

string

Il testo visualizzato sotto il video.

Video

Dati che rappresentano un video.

Rappresentazione JSON 
{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}
Campi
youtubeUri

string

Obbligatorio. Un URI di YouTube.
properties

object (MediaProperties)

Proprietà di un video.

Metodi

batchUpdate

 Modifica il modulo con un gruppo di aggiornamenti.

create

 Crea un nuovo modulo utilizzando il titolo indicato nel messaggio del modulo fornito nella richiesta.

get

 Genera un modulo.