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. Isso 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 de revisão do formulário. Usado no WriteControl em solicitações de atualização para identificar a revisão em que as mudanças foram baseadas.

O formato do ID de revisão pode mudar com o tempo. Por isso, ele deve ser tratado de forma opaca. Um código de revisão retornado só é válido por 24 horas depois de ser retornado e não pode ser compartilhado entre usuários. Se o ID de revisão não for alterado entre as chamadas, o formulário não foi 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 alterações no formato do ID.

string

Apenas saída. O URI do formulário para compartilhar com os participantes. Isso abre uma página na qual o usuário pode enviar respostas, mas não pode editar as perguntas.

string

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

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

string

Obrigatório. É o título do formulário visível para os participantes.

string

Apenas saída. O título do documento visível no Drive. Se Info.title estiver vazio, documentTitle poderá aparecer na IU do Formulários Google e ficar visível para os participantes. documentTitle pode ser definido na criação, mas não pode ser modificado por uma solicitação em lote. 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 e avaliações de testes.

{
  "isQuiz": boolean
}

boolean

Se este formulário é um teste ou não. Quando definido como verdadeiro, as respostas são avaliadas com base na pergunta Grading. Quando a política é definida como falsa, todas as perguntas Grading são excluídas.

{
  "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 código do item.

Durante a criação, ele pode ser fornecido, mas o código ainda 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 uma única solicitação importante.

object (PageBreakItem)

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

object (TextItem)

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

object (ImageItem)

Exibe uma imagem na página.

object (VideoItem)

Exibe 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)
  }
  // End of list of possible types for union field kind.
}

string

Somente leitura. O código da pergunta.

Durante a criação, ele pode ser fornecido, mas o código ainda 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 um participante envie a resposta.

object (Grading)

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

object (ChoiceQuestion)

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

object (TextQuestion)

Um participante pode digitar uma resposta de texto livre.

object (ScaleQuestion)

Um participante pode escolher um número em um intervalo.

object (DateQuestion)

Um participante pode digitar uma data.

object (TimeQuestion)

Um participante pode digitar um horário.

object (FileUploadQuestion)

Um participante pode fazer upload de um ou mais arquivos.

object (RowQuestion)

Uma linha de QuestionGroupItem.

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

enum (ChoiceType)

Obrigatório. É o tipo de pergunta de escolha.

object (Option)

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

boolean

Se as opções devem ser exibidas em ordem aleatória para diferentes instâncias do teste. Isso geralmente é usado para evitar trapaças com participantes que podem estar olhando para a tela de outro participante ou para lidar com vieses em uma pesquisa que pode ser apresentada colocando sempre as mesmas opções em primeiro ou último lugar.

{
  "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 opção apresentada ao usuário.

object (Image)

Exibir imagem como uma opção.

boolean

Se a opção é "outro". No momento, só se aplica aos tipos de escolha RADIO e CHECKBOX, mas não é permitido em QuestionGroupItem.

enum (GoToAction)

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

string

ID do item do cabeçalho da seção que será acessado.

{
  "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 a partir do qual é possível fazer o download da imagem. Isso é válido somente por tempo limitado.

string

Uma descrição da imagem exibida ao passar o cursor e ler os leitores de tela.

object (MediaProperties)

Propriedades de uma imagem.

string

Apenas entrada. O URI de origem é o URI usado para inserir a imagem. O URI de origem pode ficar vazio quando 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 é exibida, ela é dimensionada para o menor valor ou a largura do formulário exibido. A proporção original da mídia é preservada. Se uma largura não for especificada quando a mídia for adicionada ao formulário, ela será definida como a largura da fonte de mídia. A largura precisa estar entre 0 e 740 (valores inclusivos). Só é permitido definir a largura como 0 ou não especificada ao atualizar a fonte de mídia.

{
  "paragraph": boolean
}

boolean

Se a pergunta é de parágrafo ou não. Caso contrário, é uma pergunta de texto curta.

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

integer

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

integer

Obrigatório. O maior valor possível da escala.

string

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

string

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

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

boolean

Indica se a hora deve ser incluída como parte da pergunta.

boolean

Indica se o ano deve ser incluído na pergunta.

{
  "duration": boolean
}

boolean

true se a pergunta for sobre um tempo decorrido. Caso contrário, será uma hora do dia.

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

string

Obrigatório. O código da pasta do Drive onde os arquivos enviados estão armazenados.

enum (FileType)

Tipos de arquivos aceitos pela pergunta.

integer

É o número máximo de arquivos que podem ser enviados para esta 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 linha única no QuestionGroupItem.

{
  "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 para uma resposta correta. Não pode ser negativo.

object (CorrectAnswers)

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

object (Feedback)

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

object (Feedback)

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

object (Feedback)

O feedback exibido para todas as respostas. Geralmente, esse recurso é usado para perguntas de resposta curta quando o proprietário de um questionário quer dar rapidamente aos participantes a opção de responder corretamente à pergunta antes de eles avaliarem a resposta de forma oficial. 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 pode ser avaliada automaticamente com base nessas respostas. Para perguntas de valor único, uma resposta será marcada como correta se corresponder a qualquer valor nesta lista. Em outras palavras, várias respostas corretas são possíveis. Para perguntas de vários valores (CHECKBOX), uma resposta será marcada como correta se contiver exatamente os valores dessa lista.

{
  "value": string
}

string

Obrigatório. O valor correto da resposta. Consulte a documentação de TextAnswer.value para ver detalhes sobre 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 este grupo de perguntas. Uma pergunta só pode pertencer a 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 for definido, todas as perguntas do grupo precisarão 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. Somente as opções CHECK_BOX e RADIO são permitidas.

boolean

Se for true, as perguntas serã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.