Descripción general

La API de Formularios de Google es una interfaz RESTful que te permite crear y modificar formularios y cuestionarios, recuperar respuestas y calificaciones de cuestionarios, configurar claves de respuesta con comentarios automáticos y recibir notificaciones push. Los usos más comunes de esta API incluyen las siguientes tareas:

  • Cómo crear un formulario o cuestionario
  • Cómo actualizar un formulario o un cuestionario
  • Recuperar respuestas de un formulario o un cuestionario
  • Leer metadatos y contenido de formularios
  • Configura y recibe notificaciones push

A continuación, se incluye una lista de los términos comunes que se usan en la API de Formularios:

Form

Un documento de Formularios de Google creado y almacenado en Drive Cada formulario está representado por un recurso Form y tiene un valor formId ú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 en función de una clave de respuesta. Solo se puede crear un cuestionario con el método batchUpdate() para actualizar la configuración isQuiz de un formulario existente a true.

Calificaciones
Una puntuación, una clave de respuesta y los comentarios de una pregunta, que se aplican cuando isQuiz es true. Representado por el recurso Grading.
Comentarios
Es la respuesta que se proporciona al usuario final cuando se responde a una pregunta en un cuestionario, representada por el recurso Feedback.
Elemento

Corresponde a un único elemento de un formulario, representado por el recurso Item. Item es un elemento repetitivo que puede contener una sección, un grupo de preguntas, una pregunta, un texto, una imagen o un video.

Pregunta

Una sola pregunta en el formulario, representada por el recurso Question.

Grupo de preguntas

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

Section

Una sección es una forma de dividir un formulario en varias páginas y agregar lógica condicional (por ejemplo, mostrar solo ciertas preguntas según cómo responde el usuario). Las secciones corresponden al recurso PageBreakItem.

Respuesta

Es la respuesta del usuario final a una pregunta, representada por el recurso Answer. Incluye la información de calificación (si está presente), los metadatos y el contenido de la respuesta.

Respuesta

Cuando el usuario final envía un formulario, representado por el recurso FormResponse.

Mira

Un activador que rastrea los cambios en los cambios de esquema del formulario (como las ediciones de las preguntas) o los envíos de respuestas del formulario y envía una notificación push cuando se produce un cambio. Representado por el recurso Watch.

Estructura del formulario

Cuando administras formularios y cuestionarios, comprender cómo especificar diferentes campos puede ser complicado, ya que muchos de los objetos del formulario pueden anidarse entre sí de varias maneras. Si deseas ver cómo se asigna la representación visual de un formulario a los campos, te recomendamos que uses la IU para crear algunos ejemplos de los formularios que podría generar tu aplicación. Luego, recupera el JSON correspondiente con el método forms.get() para poder 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