Class GridItem

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
GridItem.

É um item de pergunta, apresentado como uma grade de colunas e linhas, permitindo que o participante selecione uma opção por linha em uma sequência de botões de opção. Os itens podem ser acessados ou criados a partir de um 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 deste item da grade.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item da grade.
duplicate()GridItemCria uma cópia desse item e a anexa ao final do formulário.
getColumns()String[]Acessa os valores para cada coluna na 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()IntegerAcessa o índice do item entre todos os itens no formulário.
getRows()String[]Acessa os valores para cada linha na grade.
getTitle()StringRecebe o título do item (às vezes chamado de texto de cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como ItemType.
isRequired()BooleanDetermina se o participante precisa 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 participante 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 de 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 deste item da grade.

Retornar

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 esse item da grade. O argumento responses precisa ser uma matriz String[] que contenha 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. Emite 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

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

Retornar

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

Acessa os valores para cada coluna na grade.

Retornar

String[]: uma matriz de valores de coluna, que os participantes veem como marcadores 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).

Retornar

String: o texto de ajuda ou 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()

Acessa o índice do item entre todos os itens no 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

getRows()

Acessa os valores para cada linha na grade.

Retornar

String[]: uma matriz de valores de linha, que os participantes veem como marcadores 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 de cabeçalho, no caso de um SectionHeaderItem).

Retornar

String: o 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 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: 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 especificada estiver vazia.

Parâmetros

NomeTipoDescrição
columnsString[]uma matriz de valores de coluna que os participantes veem como marcadores ao visualizar o formulário

Retornar

GridItem: este item para encadeamento

Gera

Error: se a matriz especificada 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

Retornar

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

Parâmetros

NomeTipoDescrição
enabledBooleanse o participante precisa responder à pergunta

Retornar

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 especificada estiver vazia.

Parâmetros

NomeTipoDescrição
rowsString[]uma matriz de valores de linha que os participantes veem como marcadores ao visualizar o formulário

Retornar

GridItem: este item para encadeamento

Gera

Error: se a matriz especificada 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 de cabeçalho, no caso de um SectionHeaderItem).

Parâmetros

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

Retornar

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 nulo ou uma validação sem nenhuma função de chamada chamada removerá qualquer validação anterior.

Parâmetros

NomeTipoDescrição
validationGridValidationuma GridValidation para aplicar ao item.

Retornar

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