Class RatingItem

Itemde classificação

Uma pergunta que permite ao participante dar uma classificação. Os itens podem ser acessados ou criados em um Form. Quando usados em um teste, esses itens são avaliados. 

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and access its properties.
const existingRatingItem = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingScaleLevel = existingRatingItem.getRatingScaleLevel();
const ratingIcon = existingRatingItem.getRatingIcon();

// Create a new rating item.
const ratingItem = form.addRatingItem();

// Update the rating item's properties via chaining.
ratingItem.setRatingScaleLevel(7).setRatingIcon(FormApp.RatingIconType.HEART);

Métodos

MétodoTipo de retornoBreve descrição
createResponse(response)ItemResponseCria um novo ItemResponse para este item de classificação.
duplicate()RatingItemCria uma cópia deste item e a anexa ao final do formulário.
getGeneralFeedback()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.
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 pontos de um item avaliável.
getRatingIcon()RatingIconTypeRecebe o ícone escolhido para a classificação.
getRatingScaleLevel()IntegerRecebe o nível da escala da classificação.
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.
setGeneralFeedback(feedback)RatingItemDefine o feedback que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (ou seja, perguntas que exigem avaliação manual).
setHelpText(text)RatingItemDefine 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)RatingItemDefine o número de pontos que um item avaliável vale.
setRatingIcon(ratingIcon)RatingItemDefine o ícone da classificação.
setRatingScaleLevel(ratingScaleLevel)RatingItemDefine o nível máximo da escala de classificação.
setRequired(enabled)RatingItemDefine se o participante precisa responder à pergunta.
setTitle(title)RatingItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Documentação detalhada

createResponse(response)

Cria um novo ItemResponse para este item de classificação.

Gera uma exceção de script se o response fornecido for menor que 1 ou maior que o valor retornado por getRatingScaleLevel(). 

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and create a response for it.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const response =item.createResponse(5);

Parâmetros

NomeTipoDescrição
responseIntegerUma resposta de valor para este item de classificação.

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

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

getGeneralFeedback()

Retorna o feedback mostrado aos participantes quando eles respondem a uma pergunta avaliável.

Retornar

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

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

getRatingIcon()

Recebe o ícone escolhido para a classificação. 

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and get its rating icon.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingIcon = item.getRatingIcon();

Retornar

RatingIconType: o tipo de ícone 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

getRatingScaleLevel()

Recebe o nível da escala da classificação. 

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and get its rating scale level.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
const ratingScaleLevel = item.getRatingScaleLevel();

Retornar

Integer: o nível da escala 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

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

isRequired()

Determina se o participante precisa responder à pergunta.

Retornar

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

setGeneralFeedback(feedback)

Define o feedback que será mostrado aos participantes quando eles responderem a uma pergunta avaliável que não tem uma resposta certa ou errada (ou seja, perguntas que exigem avaliação manual).

Parâmetros

NomeTipoDescrição
feedbackQuizFeedbacko novo feedback

Retornar

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

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

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

setRatingIcon(ratingIcon)

Define o ícone da classificação.

Gera uma exceção de script se o tipo de ícone de classificação for inválido. 

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and set its rating icon.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
item.setRatingIcon(FormApp.RatingIconType.THUMB_UP);

Parâmetros

NomeTipoDescrição
ratingIconRatingIconTypeO tipo de ícone de classificação.

Retornar

RatingItem: este RatingItem, para encadeamento.

Gera

Error: se o tipo de ícone de classificação for inválido

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

setRatingScaleLevel(ratingScaleLevel)

Define o nível máximo da escala de classificação. O nível máximo da escala de classificação precisa estar entre 3 e 10, incluindo esses dois valores. Uma nova classificação tem como padrão o nível 3 em uma escala de classificação.

Gera uma exceção de script se os valores fornecidos estiverem fora dos limites permitidos. 

// Open a form by ID
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Get an existing rating item and set its rating scale level.
const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();
item.setRatingScaleLevel(7);

Parâmetros

NomeTipoDescrição
ratingScaleLevelIntegerO nível da escala de classificação.

Retornar

RatingItem: este RatingItem, para encadeamento.

Gera

Error: se o nível da escala de classificação for inválido

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

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

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