Class GridItem

GridItem

Um item de pergunta, apresentado como uma grade de colunas e linhas, que permite ao entrevistado selecionar uma opção por linha entre uma sequência de botões de opção. Os itens podem ser acessados ou criados com uma Form.

// Open a form by ID and add a new grid item.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addGridItem();
item.setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);

Métodos

MétodoTipo de retornoBreve descrição
clearValidation()GridItemRemove qualquer validação de dados para este item de grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para este item da grade.
duplicate()GridItemCria uma cópia desse item e a anexa ao final do formulário.
getColumns()String[]Recebe os valores de cada coluna da grade.
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.
getRows()String[]Recebe os valores de cada linha da grade.
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.
setColumns(columns)GridItemDefine as colunas da grade com base em uma matriz de valores.
setHelpText(text)GridItemDefine o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).
setRequired(enabled)GridItemDefine se o respondente precisa responder à pergunta.
setRows(rows)GridItemDefine as linhas da grade com base em uma matriz de valores.
setTitle(title)GridItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
setValidation(validation)GridItemDefine a validação de dados para este item da grade.

Documentação detalhada

clearValidation()

Remove qualquer validação de dados para este item de grade.

Retorno

GridItem: este item 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

createResponse(responses)

Cria um novo ItemResponse para este item da grade. O argumento responses precisa ser uma matriz String[] contendo tantos valores quanto o número de linhas na grade. Um elemento null para uma pergunta de grade não obrigatória indica que não há resposta para essa linha. Lança uma exceção se algum dos valores não corresponder a uma escolha válida.

Parâmetros

NomeTipoDescrição
responsesString[]uma matriz de respostas válidas para este item da grade

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

GridItem: uma cópia deste GridItem, 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

getColumns()

Recebe os valores de cada coluna da grade.

Retorno

String[]: uma matriz de valores de coluna, que os entrevistados veem como rótulos ao visualizar o formulário.

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

getRows()

Recebe os valores de cada linha da grade.

Retorno

String[]: uma matriz de valores de linha, que os entrevistados veem como rótulos ao visualizar o formulário.

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

setColumns(columns)

Define as colunas da grade com base em uma matriz de valores. Lança uma exceção se a matriz fornecida estiver vazia.

Parâmetros

NomeTipoDescrição
columnsString[]Uma matriz de valores de coluna, que os entrevistados veem como rótulos ao visualizar o formulário

Retorno

GridItem: este item para encadeamento.

Gera

Error: se a matriz fornecida for null ou estiver vazia.

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

GridItem: este GridItem, 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

GridItem: 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

setRows(rows)

Define as linhas da grade com base em uma matriz de valores. Lança uma exceção se a matriz fornecida estiver vazia.

Parâmetros

NomeTipoDescrição
rowsString[]Uma matriz de valores de linha, que os entrevistados veem como rótulos ao visualizar o formulário

Retorno

GridItem: este item para encadeamento.

Gera

Error: se a matriz fornecida for null ou estiver vazia.

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

GridItem: este GridItem, 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

setValidation(validation)

Define a validação de dados para este item da grade. Transmitir "null" ou uma validação sem nenhuma função de exigência chamada vai remover qualquer validação anterior.

Parâmetros

NomeTipoDescrição
validationGridValidationum GridValidation para aplicar a este item.

Retorno

GridItem: este GridItem, 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