Class ListItem

ListItem

Uma pergunta que permite ao participante selecionar uma opção em uma lista suspensa. Os itens podem ser acessados ou criados em um Form. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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 de 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 de página.
createResponse(response)ItemResponseCria um novo ItemResponse para este item da lista.
duplicate()ListItemCria uma cópia deste item e a anexa ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedback|nullRetorna o feedback mostrado aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedback|nullRetorna o feedback mostrado aos participantes 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 o valor de um item avaliável.
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 participante precisa responder à pergunta.
setChoiceValues(values)ListItemDefine as opções de um item em uma matriz de strings.
setChoices(choices)ListItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)ListItemDefine o feedback que será mostrado aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)ListItemDefine o feedback que será mostrado aos participantes 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 que um item avaliável vale.
setRequired(enabled)ListItemDefine se o participante 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 opção, que os participantes veem como um rótulo ao acessar o formulário

Retornar

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 opção, que os participantes veem como um rótulo ao acessar o formulário
isCorrectBooleanse a escolha é uma resposta correta

Retornar

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 de página que pula para um determinado item de quebra de página. Isso é equivalente a createChoice(value, navigationType) com navigationType definido como FormApp.PageNavigationType.GO_TO_PAGE. As opções que usam a navegação de página não podem ser combinadas no mesmo item com as que não usam.

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

Parâmetros

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

Retornar

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 de página. As opções que usam a navegação na página não podem ser combinadas no mesmo item com as que não usam.

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

Parâmetros

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

Retornar

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. Gera uma exceção se o argumento response não corresponder a uma opção válida para esse item.

Parâmetros

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

Retornar

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 deste item e a anexa ao final do formulário.

Retornar

ListItem: uma duplicata de 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()

Recebe todas as opções de um item.

Retornar

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 mostrado aos participantes quando eles respondem corretamente a uma pergunta.

Retornar

QuizFeedback|null: 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 mostrado aos participantes quando eles respondem incorretamente a uma pergunta.

Retornar

QuizFeedback|null: 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).

Retornar

String: o texto de ajuda ou a 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.

Retornar

Integer: o 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.

Retornar

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 o valor de um item avaliável.

Retornar

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

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).

Retornar

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

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.

Retornar

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 participante precisa responder à pergunta.

Retornar

Boolean: indica se o entrevistado 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 de um item em uma matriz de strings. Gera uma exceção se a matriz fornecida estiver vazia. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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 participantes veem como rótulos ao visualizar o formulário

Retornar

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. Gera 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.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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 variedade de opções

Retornar

ListItem: este ListItem, para encadeamento

Gera

Error: se a matriz especificada for null, estiver 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 participantes quando eles responderem corretamente a uma pergunta. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const 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 limpar o feedback.

Retornar

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 que será mostrado aos participantes quando eles responderem incorretamente a uma pergunta.

Parâmetros

NomeTipoDescrição
feedbackQuizFeedbacko novo feedback

Retornar

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

Retornar

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 que um item avaliável vale. O padrão para novos itens é 0.

Parâmetros

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

Retornar

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 participante precisa responder à pergunta.

Parâmetros

NomeTipoDescrição
enabledBooleanse o entrevistado precisa responder à pergunta

Retornar

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

Retornar

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