REST Resource: forms

Recurso: Form

Un documento de Formularios de Google Se crea un formulario en Drive y se puede borrar un formulario o cambiar sus protecciones de acceso mediante la API de Drive.

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

string

Solo salida. El ID del formulario.

info

object (Info)

Obligatorio. Corresponde al título y a la descripción del formulario.

settings

object (FormSettings)

La configuración del formulario Se debe actualizar con UpdateSettingsRequest; se ignora durante forms.create y UpdateFormInfoRequest.

items[]

object (Item)

Obligatorio. Una lista de los elementos del formulario, que puede incluir encabezados de sección, preguntas, contenido multimedia incorporado, etcétera

revisionId

string

Solo salida. El ID de revisión del formulario. Se usa en el WriteControl en las solicitudes de actualización para identificar la revisión en la que se basan los cambios.

El formato del ID de revisión puede cambiar con el tiempo, por lo que debe tratarse de manera opaca. El ID de revisión que se muestra solo puede ser válido por 24 horas después de que se muestra y no puede compartirse entre usuarios. Si el ID de revisión no se modifica entre llamadas, el formulario no se modifica. Por el contrario, un ID modificado (para el mismo formulario y usuario) suele significar que el formulario se actualizó; sin embargo, un ID modificado también puede deberse a factores internos, como cambios de formato de ID.

responderUri

string

Solo salida. El URI del formulario para compartir con las personas que respondan. Se abrirá una página que le permite al usuario enviar respuestas, pero no editar las preguntas.

linkedSheetId

string

Solo salida. Es el ID de la Hoja de cálculo de Google vinculada que acumula respuestas desde este Formulario (si la Hoja existe).

Información

La información general de un formulario.

Representación JSON
{
  "title": string,
  "documentTitle": string,
  "description": string
}
Campos
title

string

Obligatorio. Es el título del formulario visible para las personas que responden.

documentTitle

string

Solo salida. Es el título del documento que se puede ver en Drive. Si Info.title está vacío, es posible que documentTitle aparezca en su lugar, en la IU de Formularios de Google, y los encuestados puedan verlo. documentTitle se puede establecer en la creación, pero no se puede modificar con una solicitud TFRecord. Usa la API de Google Drive si necesitas actualizar documentTitle de manera programática.

description

string

Es la descripción del formulario.

Configuración del formulario

La configuración de un formulario.

Representación JSON
{
  "quizSettings": {
    object (QuizSettings)
  }
}
Campos
quizSettings

object (QuizSettings)

Configuración relacionada con los formularios y las calificaciones de los cuestionarios.

Configuración del cuestionario

Configuración relacionada con los formularios y las calificaciones de los cuestionarios. Se deben actualizar con UpdateSettingsRequest.

Representación JSON
{
  "isQuiz": boolean
}
Campos
isQuiz

boolean

Si el formulario es un cuestionario o no. Cuando es verdadero, las respuestas se califican según la pregunta Grading. Si la estableces como falsa, se borrarán todas las preguntas Grading.

Elemento

Corresponde a un elemento del formulario. kind: Define qué tipo de elemento es.

Representación JSON
{
  "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.
}
Campos
itemId

string

Es el ID de artículo.

En el momento de la creación, se puede proporcionar, pero no se debe usar el ID en el formulario. Si no se proporciona, se asigna un ID nuevo.

title

string

Es el título del artículo.

description

string

Es la descripción del artículo.

Campo de unión kind. Obligatorio. Este es el tipo de elemento. kind puede ser solo una de las siguientes opciones:
questionItem

object (QuestionItem)

Le hace una pregunta al usuario.

questionGroupItem

object (QuestionGroupItem)

Le hace una o más preguntas al usuario con un solo mensaje importante.

pageBreakItem

object (PageBreakItem)

Inicia una página nueva con un título.

textItem

object (TextItem)

Muestra un título y una descripción en la página.

imageItem

object (ImageItem)

Muestra una imagen en la página.

videoItem

object (VideoItem)

Muestra un video en la página.

Pregunta

Un elemento de formulario que contiene una sola pregunta.

Representación JSON
{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}
Campos
question

object (Question)

Obligatorio. Es la pregunta que se muestra.

image

object (Image)

Es la imagen que se muestra en la pregunta.

Pregunta

Cualquier pregunta. El tipo específico de pregunta se conoce por su kind.

Representación JSON
{
  "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.
}
Campos
questionId

string

Solo lectura. Es el ID de la pregunta.

En el momento de la creación, se puede proporcionar, pero no se debe usar el ID en el formulario. Si no se proporciona, se asigna un ID nuevo.

required

boolean

Si la pregunta debe responderse para que el encuestado envíe su respuesta

grading

object (Grading)

Configuración de la calificación para la pregunta

Campo de unión kind. Obligatorio. Es el tipo de pregunta que se ofrece a los encuestados. Las direcciones (kind) solo pueden ser una de las siguientes opciones:
choiceQuestion

object (ChoiceQuestion)

Las personas pueden elegir entre un conjunto predefinido de opciones.

textQuestion

object (TextQuestion)

Las personas pueden ingresar una respuesta de texto libre.

scaleQuestion

object (ScaleQuestion)

Las personas pueden elegir un número de un rango.

dateQuestion

object (DateQuestion)

El encuestado puede ingresar una fecha.

timeQuestion

object (TimeQuestion)

Las personas pueden ingresar una hora.

fileUploadQuestion

object (FileUploadQuestion)

Las personas que responden pueden subir uno o más archivos.

rowQuestion

object (RowQuestion)

Es una fila de QuestionGroupItem.

Pregunta

Una pregunta de selección, radio o casilla de verificación

Representación JSON
{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}
Campos
type

enum (ChoiceType)

Obligatorio. Es el tipo de pregunta de opción.

options[]

object (Option)

Obligatorio. Lista de opciones que deben elegir los encuestados.

shuffle

boolean

Si las opciones se deben mostrar en orden aleatorio para diferentes instancias del cuestionario Por lo general, se usa para evitar que los encuestados hagan trampa en la pantalla de otro encuestado o para abordar el sesgo en una encuesta que se introduzca siempre al principio o al final en las mismas opciones.

Tipo de opción

El tipo de elección

Enumeradores
CHOICE_TYPE_UNSPECIFIED Valor predeterminado. No se utiliza.
RADIO Botones de selección: Todas las opciones se muestran al usuario, quien solo puede elegir una de ellas.
CHECKBOX Casillas de verificación: El usuario puede elegir todas las opciones que desee.
DROP_DOWN Menú desplegable: Las opciones solo se muestran al usuario a pedido; de lo contrario, solo se muestra la opción actual. Solo se puede elegir una opción.

Opción

Es una opción para una pregunta de opción.

Representación JSON
{
  "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.
}
Campos
value

string

Obligatorio. La opción que se le presenta al usuario.

image

object (Image)

Mostrar imagen como una opción.

isOther

boolean

Si la opción es “other” Actualmente, solo se aplica a los tipos de opciones RADIO y CHECKBOX, pero no se permite en un QuestionGroupItem.

Campo de unión go_to_section. La sección a la que se irá si se selecciona esta opción. Actualmente, solo se aplica a RADIO y SELECT, pero no se permite en QuestionGroupItem. go_to_section puede ser solo una de las siguientes opciones:
goToAction

enum (GoToAction)

Tipo de navegación de secciones.

goToSectionId

string

ID de artículo del encabezado de la sección a la que se va.

Ir a la acción

Constantes para la navegación de secciones.

Enumeradores
GO_TO_ACTION_UNSPECIFIED Valor predeterminado. No se utiliza.
NEXT_SECTION Ve a la siguiente sección.
RESTART_FORM Regresa al principio del formulario.
SUBMIT_FORM Envía el formulario de inmediato.

Imagen

Datos que representan una imagen.

Representación JSON
{
  "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.
}
Campos
contentUri

string

Solo salida. Un URI desde el que puedes descargar la imagen; es válido solo por un tiempo limitado.

altText

string

Es una descripción de la imagen que los lectores de pantalla muestran cuando se desplazan sobre ella.

properties

object (MediaProperties)

Propiedades de una imagen

Campo de unión image_source. Es el tipo de fuente de imagen. Se debe establecer exactamente un campo de fuente de la imagen cuando se crean imágenes nuevas. Las direcciones (image_source) solo pueden ser una de las siguientes opciones:
sourceUri

string

Solo entrada. El URI de origen es el que se usa para insertar la imagen. El URI de origen puede estar vacío cuando se recupera.

Propiedades multimedia

Propiedades del contenido multimedia.

Representación JSON
{
  "alignment": enum (Alignment),
  "width": integer
}
Campos
alignment

enum (Alignment)

Posición del contenido multimedia.

width

integer

Es el ancho del contenido multimedia en píxeles. Cuando se muestran los elementos multimedia, estos se ajustan al tamaño más pequeño o al ancho del formulario que se muestra. Se conserva la relación de aspecto original del contenido multimedia. Si no se especifica un ancho cuando se agrega el contenido multimedia al formulario, se establece como el ancho de la fuente multimedia. El ancho debe ser entre 0 y 740, inclusive. Solo se permite establecer el ancho en 0 o sin especificar cuando se actualiza la fuente multimedia.

Alineación

Alineación en la página

Enumeradores
ALIGNMENT_UNSPECIFIED Valor predeterminado. No se utiliza.
LEFT Alinear a la izquierda
RIGHT Alinear a la derecha
CENTER Centro.

Pregunta de texto

Una pregunta basada en texto.

Representación JSON
{
  "paragraph": boolean
}
Campos
paragraph

boolean

Si la pregunta es de párrafo o no De lo contrario, es una pregunta de texto breve.

Pregunta de escala

Una pregunta de escala. El usuario tiene un rango de valores numéricos para elegir.

Representación JSON
{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}
Campos
low

integer

Obligatorio. El valor más bajo posible para la escala.

high

integer

Obligatorio. El valor más alto posible para la escala.

lowLabel

string

Etiqueta que muestra el punto más bajo de la escala.

highLabel

string

La etiqueta que se muestra que describe el punto más alto de la escala.

Pregunta de fecha

Una pregunta de fecha. De forma predeterminada, las preguntas sobre la fecha solo se muestran el mes y el día.

Representación JSON
{
  "includeTime": boolean,
  "includeYear": boolean
}
Campos
includeTime

boolean

Indica si se debe incluir el tiempo como parte de la pregunta.

includeYear

boolean

Indica si se debe incluir el año como parte de la pregunta.

Pregunta de tiempo

Una pregunta de hora.

Representación JSON
{
  "duration": boolean
}
Campos
duration

boolean

true si la pregunta trata sobre un tiempo transcurrido. De lo contrario, se trata de una hora del día.

Pregunta de carga de archivos

Una pregunta de carga de archivos. Por el momento, la API no admite la creación de preguntas con carga de archivos.

Representación JSON
{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}
Campos
folderId

string

Obligatorio. El ID de la carpeta de Drive en la que se almacenan los archivos subidos

types[]

enum (FileType)

Tipos de archivos que acepta esta pregunta.

maxFiles

integer

Cantidad máxima de archivos que se pueden subir para esta pregunta en una sola respuesta.

maxFileSize

string (int64 format)

Cantidad máxima de bytes permitidos para cualquier archivo que se suba a esta pregunta.

Tipo de archivo

Tipos de archivos que se pueden subir a una pregunta de carga de archivos.

Enumeradores
FILE_TYPE_UNSPECIFIED Valor predeterminado. No se utiliza.
ANY No hay restricciones de tipo.
DOCUMENT Un archivo de Documentos de Google
PRESENTATION Un archivo de Presentaciones de Google
SPREADSHEET Un archivo de Hojas de cálculo de Google.
DRAWING Un dibujo.
PDF Un archivo PDF
IMAGE Una imagen
VIDEO Un video
AUDIO Un archivo de audio

Pregunta de fila

Configuración de una pregunta que forma parte de un grupo de preguntas.

Representación JSON
{
  "title": string
}
Campos
title

string

Obligatorio. El título de la fila única en el QuestionGroupItem.

Calificaciones

Cómo calificar una pregunta

Representación JSON
{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}
Campos
pointValue

integer

Obligatorio. Es la cantidad máxima de puntos que un encuestado puede obtener automáticamente para obtener una respuesta correcta. No debe ser un valor negativo.

correctAnswers

object (CorrectAnswers)

Obligatorio. La clave de respuesta para la pregunta Las respuestas se califican automáticamente en función de este campo.

whenRight

object (Feedback)

Los comentarios se muestran para las respuestas correctas. Estos comentarios solo se pueden configurar para preguntas de opción múltiple que tengan respuestas correctas.

whenWrong

object (Feedback)

Los comentarios se muestran en las respuestas incorrectas. Estos comentarios solo se pueden configurar para preguntas de opción múltiple que tengan respuestas correctas.

generalFeedback

object (Feedback)

Se muestran los comentarios de todas las respuestas. Por lo general, se usa para preguntas de respuesta corta cuando el propietario del cuestionario desea darles rápidamente a los encuestados una idea de si respondieron correctamente la pregunta antes de haber tenido la oportunidad de calificarla oficialmente. No se pueden establecer comentarios generales para las preguntas de opción múltiple con calificación automática.

Respuestas correctas

La clave de respuesta para una pregunta

Representación JSON
{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}
Campos
answers[]

object (CorrectAnswer)

Una lista de respuestas correctas. Las respuestas a un cuestionario se pueden calificar automáticamente en función de ellas. En el caso de las preguntas de un solo valor, una respuesta se marca como correcta si coincide con cualquier valor de esta lista (es decir, se pueden aplicar varias respuestas correctas). En el caso de las preguntas con valores múltiples (CHECKBOX), una respuesta se marca como correcta si contiene exactamente los valores de esta lista.

Respuesta correcta

Es la respuesta única a una pregunta. En las preguntas con valores múltiples (CHECKBOX), es posible que se necesiten varios CorrectAnswer para representar una sola opción de respuesta correcta.

Representación JSON
{
  "value": string
}
Campos
value

string

Obligatorio. El valor de respuesta correcto. Consulta la documentación de TextAnswer.value para obtener detalles sobre cómo se les da formato a varios tipos de valores.

Artículo del grupo de preguntas

Define una pregunta que consta de varias preguntas agrupadas.

Representación JSON
{
  "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.
}
Campos
questions[]

object (Question)

Obligatorio. Es una lista de preguntas que pertenecen a este grupo de preguntas. Cada pregunta debe pertenecer a un solo grupo. Los kind del grupo pueden afectar los tipos de preguntas que se permiten.

image

object (Image)

La imagen que se muestra dentro del grupo de preguntas, arriba de las preguntas específicas

Campo de unión kind. Obligatorio. El tipo de grupo de preguntas, que determina qué tipos de preguntas están permitidas y cómo se muestran. Las direcciones (kind) solo pueden ser una de las siguientes opciones:
grid

object (Grid)

El grupo de preguntas es una cuadrícula con filas de preguntas de opción múltiple que comparten las mismas opciones. Cuando se establece grid, todas las preguntas del grupo deben ser del tipo row.

Cuadrícula

Una cuadrícula de opciones (radio o casillas de verificación) con cada fila que constituye una pregunta separada. Cada fila tiene las mismas opciones, que se muestran como columnas.

Representación JSON
{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}
Campos
columns

object (ChoiceQuestion)

Obligatorio. Son las opciones que comparte cada pregunta de la cuadrícula. En otras palabras, los valores de las columnas. Solo se permiten opciones CHECK_BOX y RADIO.

shuffleQuestions

boolean

Si es true, las preguntas se ordenan de forma aleatoria. En otras palabras, las filas aparecen en un orden diferente para cada encuestado.

Salto de página

Un salto de página. El título y la descripción de este elemento se muestran en la parte superior de la página nueva.

Elemento de texto

Un elemento de texto

Elemento de imagen

Un elemento que contiene una imagen.

Representación JSON
{
  "image": {
    object (Image)
  }
}
Campos
image

object (Image)

Obligatorio. Es la imagen que se muestra en el artículo.

Elemento de video

Un elemento que contiene un video.

Representación JSON
{
  "video": {
    object (Video)
  },
  "caption": string
}
Campos
video

object (Video)

Obligatorio. Corresponde al video que se muestra en el elemento.

caption

string

Es el texto que se muestra debajo del video.

Para videos

Datos que representan un video.

Representación JSON
{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}
Campos
youtubeUri

string

Obligatorio. Un URI de YouTube.

properties

object (MediaProperties)

Propiedades de un video

Métodos

batchUpdate

Cambia el formulario con un lote de actualizaciones.

create

Cree un formulario nuevo con el título que se indica en el mensaje de formulario proporcionado en la solicitud.

get

Obtener un formulario