Class ListItem

ListItem

Um item de pergunta que permite ao entrevistado selecionar uma opção em uma lista suspensa. Os itens podem ser acessados ou criados com base em um Form.

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
    .setChoices([
        item.createChoice('Cats'),
        item.createChoice('Dogs')
    ]);

Métodos

MétodoTipo de retornoBreve descrição
createChoice(value)ChoiceCria uma nova opção.
createChoice(value, isCorrect)ChoiceCria uma nova opção.
createChoice(value, navigationItem)ChoiceCria uma nova opção com uma opção de navegação na página que pula para um determinado item de quebra de página.
createChoice(value, navigationType)ChoiceCria uma nova opção com uma opção de navegação nas páginas.
createResponse(response)ItemResponseCria um novo ItemResponse para este item da lista.
duplicate()ListItemCria uma cópia desse item e a anexa ao final do formulário.
getChoices()Choice[]Mostra todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback que é exibido aos entrevistados quando eles respondem incorretamente a uma pergunta.
getHelpText()StringRecebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).
getId()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna a pontuação de um item com nota.
getTitle()StringRecebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
isRequired()BooleanDetermina se o entrevistado deve responder à pergunta.
setChoiceValues(values)ListItemDefine as opções para um item de uma matriz de strings.
setChoices(choices)ListItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)ListItemDefine o feedback que será mostrado aos entrevistados quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)ListItemDefine o feedback a ser mostrado aos entrevistados quando eles responderem incorretamente a uma pergunta.
setHelpText(text)ListItemDefine o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).
setPoints(points)ListItemDefine o número de pontos para um item classificável.
setRequired(enabled)ListItemDefine se o respondente precisa responder à pergunta.
setTitle(title)ListItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Documentação detalhada

createChoice(value)

Cria uma nova opção.

Parâmetros

NomeTipoDescrição
valueStringo valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário

Retorno

Choice: a nova opção

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, isCorrect)

Cria uma nova opção.

Parâmetros

NomeTipoDescrição
valueStringo valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário
isCorrectBooleanse a opção é uma resposta correta

Retorno

Choice: a nova opção

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationItem)

Cria uma nova opção com uma opção de navegação na página que pula para um determinado item de quebra de página. É equivalente a createChoice(value, navigationType) com navigationType definido como FormApp.PageNavigationType.GO_TO_PAGE. As opções que usam a navegação nas páginas não podem ser combinadas no mesmo item com aquelas que não usam a navegação.

A navegação ocorre depois que o participante conclui uma página que contém a opção e somente se ele tiver escolhido essa opção. Se o entrevistado tiver escolhido várias opções com instruções de navegação na mesma página, somente a última opção de navegação terá efeito. A navegação também não afeta a última página do formulário.

Parâmetros

NomeTipoDescrição
valueStringo valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário
navigationItemPageBreakItemo item para navegar

Retorno

Choice: a nova opção

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationType)

Cria uma nova opção com uma opção de navegação nas páginas. As opções que usam a navegação nas páginas não podem ser combinadas no mesmo item com aquelas que não a usam.

A navegação ocorre depois que o participante conclui uma página que contém a opção e somente se ele tiver escolhido essa opção. Se o entrevistado tiver escolhido várias opções com instruções de navegação na mesma página, somente a última opção de navegação terá efeito. A navegação também não afeta a última página do formulário.

Parâmetros

NomeTipoDescrição
valueStringo valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário
navigationTypePageNavigationTypeo tipo de navegação da escolha

Retorno

Choice: a nova opção

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createResponse(response)

Cria um novo ItemResponse para este item da lista. Lança uma exceção se o argumento response não corresponder a uma escolha válida para esse item.

Parâmetros

NomeTipoDescrição
responseStringuma resposta válida para este item da lista

Retorno

ItemResponse: a resposta do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

duplicate()

Cria uma cópia desse item e a anexa ao final do formulário.

Retorno

ListItem: uma cópia deste ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getChoices()

Mostra todas as opções de um item.

Retorno

Choice[]: uma matriz de opções.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForCorrect()

Retorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta.

Retorno

QuizFeedback: o feedback, se houver.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForIncorrect()

Retorna o feedback que é exibido aos entrevistados quando eles respondem incorretamente a uma pergunta.

Retorno

QuizFeedback: o feedback, se houver.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).

Retorno

String: o texto de ajuda ou de descrição do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

Recebe o identificador exclusivo do item.

Retorno

Integer: ID do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getIndex()

Recebe o índice do item entre todos os itens do formulário.

Retorno

Integer: o índice do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getPoints()

Retorna a pontuação de um item com nota.

Retorno

Integer: o número de pontos de uma pergunta.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Retorno

String: título ou texto do cabeçalho do item.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getType()

Recebe o tipo do item, representado como um ItemType.

Retorno

ItemType: o tipo do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isRequired()

Determina se o entrevistado deve responder à pergunta.

Retorno

Boolean: se o participante precisa responder à pergunta.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoiceValues(values)

Define as opções para um item de uma matriz de strings. Lança uma exceção se a matriz fornecida estiver vazia.

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Parâmetros

NomeTipoDescrição
valuesString[]a matriz de valores de escolha, que os entrevistados veem como rótulos ao visualizar o formulário

Retorno

ListItem: este ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoices(choices)

Define uma matriz de opções para um item. Lança uma exceção se a matriz fornecida estiver vazia ou contiver um elemento null.

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?')
item.setChoices([
    item.createChoice('Cats'),
    item.createChoice('Dogs')
]);

Parâmetros

NomeTipoDescrição
choicesChoice[]uma matriz de opções

Retorno

ListItem: este ListItem, para encadeamento.

Gera

Error: se a matriz fornecida for null, vazia ou contiver um elemento null.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForCorrect(feedback)

Define o feedback que será mostrado aos entrevistados quando eles responderem corretamente a uma pergunta.

// Open a form by ID and add a new list item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false)]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText("Dogs rule, cats drool.").build());

Parâmetros

NomeTipoDescrição
feedbackQuizFeedbacko novo feedback. Um valor nulo vai apagar o feedback.

Retorno

ListItem: este ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForIncorrect(feedback)

Define o feedback a ser mostrado aos entrevistados quando eles responderem incorretamente a uma pergunta.

Parâmetros

NomeTipoDescrição
feedbackQuizFeedbacko novo feedback

Retorno

ListItem: este ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setHelpText(text)

Define o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).

Parâmetros

NomeTipoDescrição
textStringo novo texto de ajuda

Retorno

ListItem: este ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setPoints(points)

Define o número de pontos para um item classificável. O padrão para novos itens é 0.

Parâmetros

NomeTipoDescrição
pointsIntegero número de pontos em que um item da pergunta vale

Retorno

ListItem: este ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRequired(enabled)

Define se o respondente precisa responder à pergunta.

Parâmetros

NomeTipoDescrição
enabledBooleanse o respondente deve responder à pergunta

Retorno

ListItem: o item atual (para encadeamento).

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

Define o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Parâmetros

NomeTipoDescrição
titleStringo novo título ou texto do cabeçalho

Retorno

ListItem: este ListItem, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms