La API de Formularios de Google es una interfaz RESTful que te permite crear y modificar formularios y cuestionarios, obtener respuestas de formularios y calificaciones, configurar claves de respuesta con comentarios automáticos y recibir notificaciones push. Los usos más comunes de esta API incluyen las siguientes tareas:
- Crear un formulario o cuestionario
- Actualizar un formulario o cuestionario
- Cómo recuperar las respuestas de un formulario o cuestionario
- Leer metadatos y contenido de formularios
- Configura y recibe notificaciones push
A continuación, se muestra una lista de los términos comunes que se usan en la API de Formularios:
- Form
Un documento de Formularios de Google que se haya creado y almacenado en Drive. Cada formulario está representado por un recurso
Form
y tiene un valorformId
único que contiene letras, números, guiones o guiones bajos. Puedes encontrar el ID del formulario en una URL de Formularios de Google:https://docs.google.com/forms/d/FORM_ID/edit
- Cuestionario
Un tipo específico de documento de Formularios de Google que permite calificar las respuestas del formulario con una clave de respuesta. Solo se puede crear un cuestionario con el método
batchUpdate()
para actualizar la configuraciónisQuiz
de un formulario existente atrue
.- Elemento
Un solo elemento en un formulario, representado por el recurso Item.
Item
es un elemento repetido que puede contener una sección, un grupo de preguntas, una pregunta, un texto, una imagen o un video.- Pregunta
Una sola pregunta sobre el formulario, representada por el recurso
Question
.- Grupo de preguntas
Un grupo de preguntas que comparten el mismo conjunto de respuestas posibles (por ejemplo, una cuadrícula de calificaciones del 1 al 5). Representado por el recurso
QuestionGroupItem
.- Sección
Una sección es una forma de dividir un formulario en varias páginas y agregar una lógica condicional (como mostrar solo ciertas preguntas según la respuesta del usuario). Las secciones corresponden al recurso
PageBreakItem
.- Respuesta
La respuesta del usuario final a una pregunta, representada por el recurso
Answer
. Incluye información de calificación (si está presente), metadatos y el contenido de la respuesta.- Respuesta
El envío de un formulario por parte del usuario final, representado por el recurso
FormResponse
- Mira
Un activador que realiza un seguimiento de los cambios en los cambios del esquema del formulario (como ediciones de las preguntas) o en los envíos de respuestas de formularios y envía una notificación push cuando se produce un cambio. Representado por el recurso
Watch
.
Estructura del formulario
Cuando se administran formularios y cuestionarios, comprender cómo especificar diferentes campos puede ser complicado, ya que muchos de los objetos del formulario se pueden anidar entre sí de varias maneras. Para ver cómo se representa la representación visual de un formulario con los campos, recomendamos usar la IU a fin de crear algunos ejemplos de formularios que podría generar tu aplicación. Luego, recupera el JSON correspondiente con el método forms.get()
para que puedas compararlo. Por ejemplo, este cuestionario de ejemplo corresponde al siguiente 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óximos pasos
- Para obtener información sobre el desarrollo con las API de Google Workspace, incluido el manejo de la autenticación y la autorización, consulta Primeros pasos como desarrollador de Workspace.
- Para obtener más información sobre cómo configurar y ejecutar una app simple de la API de Formularios, consulta la Descripción general de las guías de inicio rápido.