Interface Item

Item

Um item de formulário genérico que contém propriedades comuns a todos os itens, como título e texto de ajuda. Os itens podem ser acessados ou criados em um Form.

Para operar em propriedades específicas do tipo, use getType() para verificar o ItemType do item e transmita o item para a classe adequada usando um método como asCheckboxItem(). 

// Create a new form and add a text item.
const form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
const items = form.getItems();
const item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const textItem = item.asTextItem();
  textItem.setRequired(false);
}

Implementar classes

NomeBreve descrição

Métodos

MétodoTipo de retornoBreve descrição
asCheckboxGridItem()CheckboxGridItemRetorna o item como um item de grade de caixa de seleção.
asCheckboxItem()CheckboxItemRetorna o item como uma caixa de seleção.
asDateItem()DateItemRetorna o item como um item de data.
asDateTimeItem()DateTimeItemRetorna o item como um item de data e hora.
asDurationItem()DurationItemRetorna o item como um item de duração.
asGridItem()GridItemRetorna o item como um item de grade.
asImageItem()ImageItemRetorna o item como um item de imagem.
asListItem()ListItemRetorna o item como um item de lista.
asMultipleChoiceItem()MultipleChoiceItemRetorna o item como um item de múltipla escolha.
asPageBreakItem()PageBreakItemRetorna o item como um item de quebra de página.
asParagraphTextItem()ParagraphTextItemRetorna o item como um item de texto de parágrafo.
asRatingItem()RatingItemRetorna o item como um item de classificação.
asScaleItem()ScaleItemRetorna o item como um item de escala.
asSectionHeaderItem()SectionHeaderItemRetorna o item como um item de cabeçalho de seção.
asTextItem()TextItemRetorna o item como um item de texto.
asTimeItem()TimeItemRetorna o item como um item de tempo.
asVideoItem()VideoItemRetorna o item como um item de vídeo.
duplicate()ItemCria uma cópia deste item e a anexa ao final do formulário.
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.
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.
setHelpText(text)ItemDefine o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems, PageBreakItems e SectionHeaderItems).
setTitle(title)ItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Documentação detalhada

asCheckboxGridItem()

Retorna o item como um item de grade de caixa de seleção. Gera uma exceção de script se o ItemType ainda não for CHECKBOX_GRID.

Retornar

CheckboxGridItem: o item da grade de caixa de seleção

Gera

Error: se o item não for uma grade de caixas de seleçã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

asCheckboxItem()

Retorna o item como uma caixa de seleção. Gera uma exceção de script se o ItemType ainda não for CHECKBOX.

Retornar

CheckboxItem: o item da caixa de seleção

Gera

Error: se o item não for uma caixa de seleçã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

asDateItem()

Retorna o item como um item de data. Gera uma exceção de script se o ItemType ainda não for DATE.

Retornar

DateItem: o item de data

Gera

Error: se o item não for uma data

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

asDateTimeItem()

Retorna o item como um item de data e hora. Gera uma exceção de script se o ItemType ainda não for DATETIME.

Retornar

DateTimeItem: o item de data e hora

Gera

Error: se o item não for de data e hora

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

asDurationItem()

Retorna o item como um item de duração. Gera uma exceção de script se o ItemType ainda não for DURATION.

Retornar

DurationItem: o item de duração

Gera

Error: se o item não for de duraçã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

asGridItem()

Retorna o item como um item de grade. Gera uma exceção de script se o ItemType ainda não for GRID.

Retornar

GridItem: o item da grade

Gera

Error: se o item não for um item de grade

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

asImageItem()

Retorna o item como um item de imagem. Gera uma exceção de script se o ItemType ainda não for IMAGE.

Retornar

ImageItem: o item de imagem

Gera

Error: se o item não for uma imagem

asListItem()

Retorna o item como um item de lista. Gera uma exceção de script se o ItemType ainda não for LIST.

Retornar

ListItem: o item da lista

Gera

Error: se o item não for um item de lista

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

asMultipleChoiceItem()

Retorna o item como um item de múltipla escolha. Gera uma exceção de script se o ItemType ainda não for MULTIPLE_CHOICE.

Retornar

MultipleChoiceItem: o item de múltipla escolha

Gera

Error: se o item não for de múltipla escolha

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

asPageBreakItem()

Retorna o item como um item de quebra de página. Gera uma exceção de script se o ItemType ainda não for PAGE_BREAK.

Retornar

PageBreakItem: o item de quebra de página

Gera

Error: se o item não for uma quebra de página

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

asParagraphTextItem()

Retorna o item como um item de texto de parágrafo. Gera uma exceção de script se o ItemType ainda não for PARAGRAPH_TEXT.

Retornar

ParagraphTextItem: o item de texto do parágrafo

Gera

Error: se o item não for um item de texto de parágrafo

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

asRatingItem()

Retorna o item como um item de classificação. Gera uma ScriptingException se o ItemType ainda não for RATING. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

Retornar

RatingItem: o item de classificação.

Gera

Error: se o item não for de classificaçã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

asScaleItem()

Retorna o item como um item de escala. Gera uma exceção de script se o ItemType ainda não for SCALE.

Retornar

ScaleItem: o item de escala

Gera

Error: se o item não for de escala

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

asSectionHeaderItem()

Retorna o item como um item de cabeçalho de seção. Gera uma exceção de script se o ItemType ainda não for SECTION_HEADER.

Retornar

SectionHeaderItem: o item de cabeçalho da seção

Gera

Error: se o item não for um cabeçalho de seçã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

asTextItem()

Retorna o item como um item de texto. Gera uma exceção de script se o ItemType ainda não for TEXT.

Retornar

TextItem: o item de texto

Gera

Error: se o item não for de texto

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

asTimeItem()

Retorna o item como um item de tempo. Gera uma exceção de script se o ItemType ainda não for TIME.

Retornar

TimeItem: o item de tempo

Gera

Error: se o item não for um item de tempo

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

asVideoItem()

Retorna o item como um item de vídeo. Gera uma exceção de script se o ItemType ainda não for VIDEO.

Retornar

VideoItem: o item de vídeo

Gera

Error: se o item não for um vídeo

duplicate()

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

Retornar

Item: uma duplicata de 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

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

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

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

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

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

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

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