REST Resource: forms

{
  "formId": string,
  "info": {
    object (Info)
  },
  "settings": {
    object (FormSettings)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "revisionId": string,
  "responderUri": string,
  "linkedSheetId": string
}

string

Apenas saída. O ID do formulário.

object (Info)

Obrigatório. O título e a descrição do formulário.

object (FormSettings)

As configurações do formulário. Ele precisa ser atualizado com UpdateSettingsRequest. Ele é ignorado durante forms.create e UpdateFormInfoRequest.

object (Item)

Obrigatório. Uma lista dos itens do formulário, que pode incluir cabeçalhos de seção, perguntas, mídia incorporada etc.

string

Apenas saída. O ID da revisão do formulário. Usado em WriteControl em solicitações de atualização para identificar a revisão em que as mudanças se baseiam.

O formato do ID da revisão pode mudar com o tempo, então ele precisa ser tratado de forma opaca. O ID de revisão retornado só é válido por 24 horas após o retorno e não pode ser compartilhado entre usuários. Se o ID da revisão não mudar entre as chamadas, o formulário não terá sido alterado. Por outro lado, um ID alterado (para o mesmo formulário e usuário) geralmente significa que o formulário foi atualizado. No entanto, um ID alterado também pode ser devido a fatores internos, como mudanças no formato do ID.

string

Apenas saída. O URI do formulário a ser compartilhado com os participantes. Isso abre uma página que permite que o usuário envie respostas, mas não edite as perguntas.

string

Apenas saída. O ID da planilha Google vinculada que está acumulando respostas deste formulário (se ela existir).

{
  "title": string,
  "documentTitle": string,
  "description": string
}

string

Obrigatório. O título do formulário que fica visível para os participantes.

string

Apenas saída. O título do documento que aparece no Drive. Se Info.title estiver vazio, documentTitle poderá aparecer no lugar dele na interface dos Formulários Google e ficar visível para os participantes. O documentTitle pode ser definido na criação, mas não pode ser modificado por uma solicitação batchUpdate. Use a API Google Drive se você precisar atualizar documentTitle de forma programática.

string

A descrição do formulário.

{
  "quizSettings": {
    object (QuizSettings)
  }
}

object (QuizSettings)

Configurações relacionadas a formulários de teste e avaliação.

{
  "isQuiz": boolean
}

boolean

Se o formulário é um teste ou não. Quando verdadeiro, as respostas são avaliadas com base na pergunta Grading. Se definido como falso, toda a pergunta Grading será excluída.

{
  "itemId": string,
  "title": string,
  "description": string,

  // Union field kind can be only one of the following:
  "questionItem": {
    object (QuestionItem)
  },
  "questionGroupItem": {
    object (QuestionGroupItem)
  },
  "pageBreakItem": {
    object (PageBreakItem)
  },
  "textItem": {
    object (TextItem)
  },
  "imageItem": {
    object (ImageItem)
  },
  "videoItem": {
    object (VideoItem)
  }
  // End of list of possible types for union field kind.
}

string

O ID do item.

Na criação, ele pode ser fornecido, mas não pode ser usado no formulário. Se não for fornecido, um novo ID será atribuído.

string

O título do item.

string

A descrição do item.

object (QuestionItem)

Faz uma pergunta ao usuário.

object (QuestionGroupItem)

Faz uma ou mais perguntas ao usuário com um único comando principal.

object (PageBreakItem)

Inicia uma nova página com um título.

object (TextItem)

Mostra um título e uma descrição na página.

object (ImageItem)

Mostra uma imagem na página.

object (VideoItem)

Mostra um vídeo na página.

{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}

object (Question)

Obrigatório. A pergunta exibida.

object (Image)

A imagem exibida na pergunta.

{
  "questionId": string,
  "required": boolean,
  "grading": {
    object (Grading)
  },

  // Union field kind can be only one of the following:
  "choiceQuestion": {
    object (ChoiceQuestion)
  },
  "textQuestion": {
    object (TextQuestion)
  },
  "scaleQuestion": {
    object (ScaleQuestion)
  },
  "dateQuestion": {
    object (DateQuestion)
  },
  "timeQuestion": {
    object (TimeQuestion)
  },
  "fileUploadQuestion": {
    object (FileUploadQuestion)
  },
  "rowQuestion": {
    object (RowQuestion)
  },
  "ratingQuestion": {
    object (RatingQuestion)
  }
  // End of list of possible types for union field kind.
}

string

Somente leitura. O ID da pergunta.

Na criação, ele pode ser fornecido, mas não pode ser usado no formulário. Se não for fornecido, um novo ID será atribuído.

boolean

Se a pergunta precisa ser respondida para que o participante envie a resposta.

object (Grading)

Configuração de avaliação da pergunta.

object (ChoiceQuestion)

O participante pode escolher entre um conjunto predefinido de opções.

object (TextQuestion)

O participante pode inserir uma resposta de texto livre.

object (ScaleQuestion)

O participante pode escolher um número dentro de um intervalo.

object (DateQuestion)

Um participante pode inserir uma data.

object (TimeQuestion)

Um participante pode inserir um horário.

object (FileUploadQuestion)

Um participante pode fazer upload de um ou mais arquivos.

object (RowQuestion)

Uma linha de um QuestionGroupItem.

object (RatingQuestion)

O participante pode escolher uma nota em um conjunto predefinido de ícones.

{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}

enum (ChoiceType)

Obrigatório. O tipo de pergunta de múltipla escolha.

object (Option)

Obrigatório. Lista de opções que um participante precisa escolher.

boolean

Se as opções precisam ser mostradas em ordem aleatória para diferentes instâncias do teste. Isso é usado com frequência para evitar trapaças por parte de participantes que podem estar olhando a tela de outro participante ou para resolver a viés em uma pesquisa que pode ser introduzida ao colocar sempre as mesmas opções primeiro ou por último.

{
  "value": string,
  "image": {
    object (Image)
  },
  "isOther": boolean,

  // Union field go_to_section can be only one of the following:
  "goToAction": enum (GoToAction),
  "goToSectionId": string
  // End of list of possible types for union field go_to_section.
}

string

Obrigatório. A escolha apresentada ao usuário.

object (Image)

Mostrar a imagem como uma opção.

boolean

Se a opção é "Outros". Atualmente, isso só se aplica aos tipos de escolha RADIO e CHECKBOX, mas não é permitido em um QuestionGroupItem.

enum (GoToAction)

Tipo de navegação de seção.

string

ID do item do cabeçalho da seção para acessar.

{
  "contentUri": string,
  "altText": string,
  "properties": {
    object (MediaProperties)
  },

  // Union field image_source can be only one of the following:
  "sourceUri": string
  // End of list of possible types for union field image_source.
}

string

Apenas saída. Um URI para fazer o download da imagem. Ele é válido apenas por um tempo limitado.

string

Uma descrição da imagem que aparece ao passar o cursor e é lida por leitores de tela.

object (MediaProperties)

Propriedades de uma imagem.

string

Somente entrada. O URI de origem é o URI usado para inserir a imagem. O URI da origem pode ficar vazio quando for buscado.

{
  "alignment": enum (Alignment),
  "width": integer
}

enum (Alignment)

Posição da mídia.

integer

A largura da mídia em pixels. Quando a mídia é mostrada, ela é dimensionada para o menor valor ou a largura do formulário exibido. A proporção original da mídia é preservada. Se a largura não for especificada quando a mídia for adicionada ao formulário, ela será definida como a largura da origem da mídia. A largura precisa estar entre 0 e 740, inclusive. A definição de largura como 0 ou não especificada só é permitida ao atualizar a origem da mídia.

{
  "paragraph": boolean
}

boolean

Se a pergunta é do tipo parágrafo ou não. Caso contrário, a pergunta é de texto curto.

{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}

integer

Obrigatório. O menor valor possível para a escala.

integer

Obrigatório. O valor mais alto possível para a escala.

string

O rótulo a ser mostrado descrevendo o ponto mais baixo da escala.

string

O rótulo a ser mostrado descrevendo o ponto mais alto da escala.

{
  "includeTime": boolean,
  "includeYear": boolean
}

boolean

Se o horário deve ser incluído como parte da pergunta.

boolean

Se o ano deve ser incluído como parte da pergunta.

{
  "duration": boolean
}

boolean

true se a pergunta for sobre um tempo decorrido. Caso contrário, é sobre um horário do dia.

{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}

string

Obrigatório. O ID da pasta do Drive em que os arquivos enviados são armazenados.

enum (FileType)

Tipos de arquivos aceitos por esta pergunta.

integer

Número máximo de arquivos que podem ser enviados para essa pergunta em uma única resposta.

string (int64 format)

Número máximo de bytes permitidos para qualquer arquivo enviado para esta pergunta.

{
  "title": string
}

string

Obrigatório. O título da única linha no QuestionGroupItem.

{
  "ratingScaleLevel": integer,
  "iconType": enum (RatingIconType)
}

integer

Obrigatório. O nível da escala de classificação da pergunta.

enum (RatingIconType)

Obrigatório. O tipo de ícone a ser usado para a classificação.

{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}

integer

Obrigatório. O número máximo de pontos que um participante pode receber automaticamente por uma resposta correta. Não pode ser negativo.

object (CorrectAnswers)

Obrigatório. A chave de respostas da pergunta. As respostas são avaliadas automaticamente com base nesse campo.

object (Feedback)

O feedback mostrado para respostas corretas. Esse feedback só pode ser definido para perguntas de múltipla escolha com respostas corretas.

object (Feedback)

O feedback mostrado para respostas incorretas. Esse feedback só pode ser definido para perguntas de múltipla escolha com respostas corretas.

object (Feedback)

O feedback mostrado para todas as respostas. Isso é comum em perguntas de resposta curta quando o proprietário do teste quer dar aos participantes uma ideia rápida de se eles responderam corretamente à pergunta antes de ter a chance de avaliar a resposta oficialmente. Não é possível definir feedback geral para perguntas de múltipla escolha com nota automática.

{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}

object (CorrectAnswer)

Uma lista de respostas corretas. Uma resposta do teste pode ser pontuada automaticamente com base nessas respostas. Para perguntas de valor único, uma resposta é marcada como correta se corresponder a qualquer valor na lista. Em outras palavras, várias respostas corretas são possíveis. Para perguntas com vários valores (CHECKBOX), uma resposta é marcada como correta se ela contém exatamente os valores desta lista.

{
  "value": string
}

string

Obrigatório. O valor da resposta correta. Consulte a documentação de TextAnswer.value para saber como os vários tipos de valor são formatados.

{
  "questions": [
    {
      object (Question)
    }
  ],
  "image": {
    object (Image)
  },

  // Union field kind can be only one of the following:
  "grid": {
    object (Grid)
  }
  // End of list of possible types for union field kind.
}

object (Question)

Obrigatório. Uma lista de perguntas que pertencem a esse grupo. Uma pergunta precisa pertencer a apenas um grupo. A kind do grupo pode afetar os tipos de perguntas permitidos.

object (Image)

A imagem exibida no grupo de perguntas acima das perguntas específicas.

object (Grid)

O grupo de perguntas é uma grade com linhas de perguntas de múltipla escolha que compartilham as mesmas opções. Quando grid é definido, todas as perguntas no grupo precisam ser do tipo row.

{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}

object (ChoiceQuestion)

Obrigatório. As opções compartilhadas por cada pergunta na grade. Em outras palavras, os valores das colunas. Apenas as opções CHECK_BOX e RADIO são permitidas.

boolean

Se true, as perguntas são ordenadas aleatoriamente. Em outras palavras, as linhas aparecem em uma ordem diferente para cada participante.

{
  "image": {
    object (Image)
  }
}

object (Image)

Obrigatório. A imagem exibida no item.

{
  "video": {
    object (Video)
  },
  "caption": string
}

object (Video)

Obrigatório. O vídeo exibido no item.

string

O texto exibido abaixo do vídeo.

{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}

string

Obrigatório. Um URI do YouTube.

object (MediaProperties)

Propriedades de um vídeo.