REST Resource: forms

Risorsa: modulo

Un documento di Moduli Google. Un modulo viene creato in Drive ed eliminato o modificato tramite 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 del 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 degli elementi del modulo, che può 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 trattato in modo opaco. L'ID revisione restituito è garantito come valido solo per 24 ore dopo la restituzione e non può essere condiviso tra utenti. Se l'ID revisione rimane invariato tra una chiamata e l'altra, significa che il modulo non è stato modificato. Al contrario, un ID modificato (per lo stesso modulo e utente) di solito indica che il modulo è stato aggiornato. Tuttavia, un ID modificato può essere dovuto anche a fattori interni, come le modifiche al formato dell'ID.
responderUri

string

Solo output. L'URI del modulo da condividere con chi risponde. 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 accumula le risposte di questo modulo (se esiste un foglio di questo tipo).

Informazioni

Le informazioni generali di 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, al suo posto nell'interfaccia utente di Moduli Google potrebbe essere visualizzato documentTitle, che sarà visibile a chi risponde. documentTitle può essere impostato al momento della creazione, ma non può essere modificato da una richiesta batchUpdate. Utilizza l'API Google Drive se devi aggiornare documentTitle tramite programmazione.
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 e alla valutazione dei quiz.

QuizSettings

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

Rappresentazione JSON 
{
  "isQuiz": boolean
}
Campi
isQuiz

boolean

Indica se il modulo è un quiz o meno. Se è true, le risposte vengono valutate in base alla domanda Grading. Se l'impostazione è false, tutte le domande Grading vengono eliminate.

Elemento

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

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.

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

string

Il titolo dell'articolo.
description

string

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

object (QuestionItem)

Pone una domanda all'utente.
questionGroupItem

object (QuestionGroupItem)

Pone all'utente una o più domande con un unico prompt principale.
pageBreakItem

object (PageBreakItem)

Avvia una nuova pagina con un titolo.
textItem

object (TextItem)

Mostra un titolo e una descrizione nella pagina.
imageItem

object (ImageItem)

Mostra un'immagine nella 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 come 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)
  },
  "ratingQuestion": {
    object (RatingQuestion)
  }
  // End of list of possible types for union field kind.
}
Campi
questionId

string

Di sola lettura. L'ID domanda.

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

boolean

Indica se è necessario rispondere alla domanda affinché un partecipante possa inviare la propria risposta.
grading

object (Grading)

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

object (ChoiceQuestion)

Un rispondente può scegliere tra un insieme di opzioni predefinite.
textQuestion

object (TextQuestion)

Un rispondente può inserire una risposta di testo libera.
scaleQuestion

object (ScaleQuestion)

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

object (DateQuestion)

Un rispondente può inserire una data.
timeQuestion

object (TimeQuestion)

Un rispondente può inserire un'ora.
fileUploadQuestion

object (FileUploadQuestion)

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

object (RowQuestion)

Una riga di un QuestionGroupItem.
ratingQuestion

object (RatingQuestion)

Un rispondente può scegliere una valutazione da un insieme predefinito di icone.

ChoiceQuestion

Una domanda con pulsante di opzione/casella di controllo/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 un rispondente deve scegliere.
shuffle

boolean

Indica se le opzioni devono essere visualizzate in ordine casuale per diverse istanze del quiz. Questo metodo viene spesso utilizzato per impedire i comportamenti fraudolenti dei partecipanti che potrebbero guardare lo schermo di un altro partecipante o per correggere i bias in un sondaggio che potrebbero essere introdotti mettendo sempre le stesse opzioni per prime o per ultime.

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 una sola.
CHECKBOX Caselle di controllo: tutte le opzioni vengono mostrate all'utente, che può sceglierne un numero qualsiasi.
DROP_DOWN Menu a discesa: le scelte 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)

Mostra l'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 unione go_to_section. La sezione da aprire se questa opzione è selezionata. Attualmente si applica solo al tipo di scelta RADIO e SELECT, ma non è consentito in un QuestionGroupItem. go_to_section può essere solo uno dei seguenti:
goToAction

enum (GoToAction)

Tipo di navigazione della sezione.
goToSectionId

string

ID articolo dell'intestazione della sezione a cui passare.

GoToAction

Costanti per la navigazione tra le 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 immediatamente il modulo.

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 puoi 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 unione image_source. Il tipo di origine dell'immagine. Quando crei nuove immagini, devi impostare esattamente un campo di origine 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 al momento del recupero.

MediaProperties

Proprietà dei contenuti multimediali.

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

enum (Alignment)

Posizione dei contenuti multimediali.
width

integer

La larghezza dei contenuti multimediali in pixel. Quando i contenuti multimediali vengono visualizzati, vengono ridimensionati in base al valore più piccolo o alla larghezza del modulo visualizzato. Le proporzioni originali dei contenuti multimediali vengono conservate. Se non viene specificata una larghezza quando i contenuti multimediali vengono aggiunti al modulo, viene impostata la 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 durante l'aggiornamento dell'origine media.

Allineamento

Allineamento sulla pagina.

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

TextQuestion

Una domanda basata sul testo.

Rappresentazione JSON 
{
  "paragraph": boolean
}
Campi
paragraph

boolean

Indica se la domanda è del tipo paragrafo o meno. In caso contrario, si tratta di una domanda con testo breve.

ScaleQuestion

Una domanda con una scala. L'utente ha a disposizione un intervallo di valori numerici tra cui scegliere.

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

integer

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

integer

Obbligatorio. Il valore più alto possibile per la scala.
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 scala.

DateQuestion

Una domanda sulla data. Per impostazione predefinita, le domande relative alla data includono solo mese e giorno.

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

boolean

Indica se includere l'ora nella domanda.
includeYear

boolean

Indica se includere l'anno nella domanda.

TimeQuestion

Una domanda sull'ora.

Rappresentazione JSON 
{
  "duration": boolean
}
Campi
duration

boolean

true se la domanda riguarda un periodo di tempo trascorso. In caso contrario, si tratta di un'ora del giorno.

FileUploadQuestion

Una domanda per il caricamento di file. Al momento l'API non supporta la creazione di domande per il caricamento di 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 possono essere caricati 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 una domanda con 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 di Fogli Google.
DRAWING Un disegno.
PDF Un file 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.

RatingQuestion

Una domanda sulla classificazione. L'utente ha a disposizione una serie di icone tra cui scegliere.

Rappresentazione JSON 
{
  "ratingScaleLevel": integer,
  "iconType": enum (RatingIconType)
}
Campi
ratingScaleLevel

integer

Obbligatorio. Il livello della scala di valutazione della domanda di valutazione.
iconType

enum (RatingIconType)

Obbligatorio. Il tipo di icona da utilizzare per la classificazione.

RatingIconType

Il tipo di icona da utilizzare per la classificazione.

Enum
RATING_ICON_TYPE_UNSPECIFIED Valore predefinito. Non utilizzato.
STAR Un'icona a forma di stella.
HEART Un'icona a forma di cuore.
THUMB_UP Un'icona con il pollice verso il basso.

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 rispondente può ottenere automaticamente per una risposta corretta. Non deve essere un valore 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 le 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 le domande a scelta multipla per le quali sono state fornite risposte corrette.
generalFeedback

object (Feedback)

Il feedback visualizzato per tutte le risposte. Questo tipo di feedback viene utilizzato di solito per le domande a risposta breve quando il proprietario di un quiz vuole dare rapidamente ai partecipanti un'idea se hanno risposto correttamente alla domanda prima che abbiano la possibilità di valutare ufficialmente la risposta. Il feedback generale non può essere impostato 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 con un solo valore, una risposta viene contrassegnata come corretta se corrisponde a un valore in questo elenco (in altre parole, sono possibili più risposte corrette). Per le domande con più valori (CHECKBOX), una risposta viene contrassegnata come corretta se contiene esattamente i valori in questo elenco.

CorrectAnswer

Una singola risposta corretta per una domanda. Per le domande con più valori (CHECKBOX), potrebbero essere necessari più CHECKBOX per rappresentare una singola opzione di risposta corretta.CorrectAnswer

Rappresentazione JSON 
{
  "value": string
}
Campi
value

string

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

QuestionGroupItem

Definisce una domanda composta da più domande raggruppate.

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. Il kind del gruppo può influire sui tipi di domande consentite.
image

object (Image)

L'immagine visualizzata all'interno del gruppo di domande sopra le domande specifiche.
Campo unione kind. Obbligatorio. Il tipo di gruppo di domande, che determina i tipi di domande consentiti e il modo in cui vengono visualizzate. 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. Quando è impostato grid, tutte le domande del gruppo devono essere di tipo row.

Griglia

Una griglia di opzioni (caselle di controllo o radio) con ogni riga che costituisce una domanda separata. Ogni riga ha le stesse opzioni, che vengono visualizzate come colonne.

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

object (ChoiceQuestion)

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

boolean

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

PageBreakItem

Questo tipo non contiene campi.

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

TextItem

Questo tipo non contiene campi.

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

 Modificare il modulo con un batch di aggiornamenti.

create

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

get

 Ricevi un modulo.