A API Google Formulários é uma interface RESTful que permite criar e modificar formulários e testes, recuperar respostas e notas de formulários, configurar chaves de respostas de testes com feedback automático e receber notificações push. Os usos mais comuns dessa API incluem as tarefas abaixo:
- Criar um formulário ou teste
- Atualizar um teste ou formulário
- Recuperar respostas de um formulário ou teste
- Ler conteúdo e metadados de formulários
- Configurar e receber notificações push
Veja abaixo uma lista de termos comuns usados na API de formulários:
- Formulário
Um arquivo do Formulários Google, criado e armazenado no Drive. Cada forma é representada por um recurso
Form
e tem um valorformId
exclusivo, contendo letras, números, hifens ou sublinhados. Você pode encontrar o ID do formulário em um URL do app Formulários Google:https://docs.google.com/forms/d/FORM_ID/edit
- Teste
Um tipo específico de arquivo do Formulários Google que permite avaliar as respostas do formulário em relação a uma chave de resposta. Um teste só pode ser criado usando o método
batchUpdate()
para atualizar a configuraçãoisQuiz
de um formulário existente paratrue
.- Item
Um único elemento em um formulário, representado pelo recurso Item.
Item
é um elemento recorrente que pode conter uma seção, um grupo de perguntas, uma pergunta, um texto, uma imagem ou um vídeo.- Pergunta
Uma única pergunta no formulário, representada pelo recurso
Question
.- Grupo de perguntas
Um grupo de perguntas que compartilham o mesmo conjunto de respostas possíveis (por exemplo, uma grade de classificações de 1 a 5). Representado pelo recurso
QuestionGroupItem
.- Section
Uma seção é uma maneira de dividir um formulário em várias páginas e adicionar lógica condicional, como mostrar apenas determinadas perguntas com base nas respostas do usuário. As seções correspondem ao recurso
PageBreakItem
.- Resposta
A resposta do usuário final a uma pergunta, representada pelo recurso
Answer
. Inclui informações sobre as notas (se houver), metadados e o conteúdo da resposta.- Resposta
O envio de um formulário pelo usuário final, representado pelo recurso
FormResponse
.- Assista
Um acionador que rastreia alterações em alterações de esquema de formulário (como edições em perguntas) ou envios de respostas de formulário e envia uma notificação push quando ocorre uma alteração. Representado pelo recurso
Watch
.
Estrutura do formulário
Ao gerenciar formulários e testes, entender como especificar campos diferentes pode ser complicado, já que muitos dos objetos de formulário podem ser aninhados uns nos outros de várias maneiras. Para ver como a representação visual de um formulário
é mapeada para os campos, recomendamos usar a IU para criar alguns exemplos de
formulários que o app pode gerar. Em seguida, recupere o JSON correspondente
usando o método forms.get()
para comparar. Por exemplo,
este exemplo de teste corresponde ao seguinte JSON:
{
"formId": "FORM_ID",
"info": {
"title": "Famous Black Women",
"description": "Please complete this quiz based off of this week's readings for class.",
"documentTitle": "API Example Quiz"
},
"settings": {
"quizSettings": {
"isQuiz": true
}
},
"revisionId": "00000021",
"responderUri": "https://docs.google.com/forms/d/e/1FAIpQLSd0iBLPh4suZoGW938EU1WIxzObQv_jXto0nT2U8HH2KsI5dg/viewform",
"items": [
{
"itemId": "5d9f9786",
"imageItem": {
"image": {
"contentUri": "DIRECT_URL",
"properties": {
"alignment": "LEFT"
}
}
}
},
{
"itemId": "72b30353",
"title": "Which African American woman authored \"I Know Why the Caged Bird Sings\"?",
"questionItem": {
"question": {
"questionId": "25405d4e",
"required": true,
"grading": {
"pointValue": 2,
"correctAnswers": {
"answers": [
{
"value": "Maya Angelou"
}
]
}
},
"choiceQuestion": {
"type": "RADIO",
"options": [
{
"value": "Maya Angelou"
},
{
"value": "bell hooks"
},
{
"value": "Alice Walker"
},
{
"value": "Roxane Gay"
}
]
}
}
}
},
{
"itemId": "0a4859c8",
"title": "Who was the first Dominican-American woman elected to state office?",
"questionItem": {
"question": {
"questionId": "37fff47a",
"grading": {
"pointValue": 2,
"correctAnswers": {
"answers": [
{
"value": "Grace Diaz"
}
]
}
},
"choiceQuestion": {
"type": "RADIO",
"options": [
{
"value": "Rosa Clemente"
},
{
"value": "Grace Diaz"
},
{
"value": "Juana Matias"
},
{
"value": "Sabrina Matos"
}
]
}
}
}
}
]
}
Próximas etapas
- Para saber mais sobre o desenvolvimento com as APIs do Google Workspace, incluindo o processamento de autenticação e autorização, consulte Como começar como desenvolvedor do Workspace.
- Para saber como configurar e executar um app simples da API Formulários, leia a Visão geral dos guias de início rápido.