- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- Solicitud
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Ubicación
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Respuesta
- CreateItemResponse
- Pruébala
Cambia el formulario con un lote de actualizaciones.
Solicitud HTTP
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
formId |
Obligatorio. El ID del formulario. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
Campos | |
---|---|
includeFormInResponse |
Indica si se debe mostrar una versión actualizada del modelo en la respuesta. |
requests[] |
Obligatorio. Las solicitudes de actualización de este lote |
writeControl |
Proporciona control sobre cómo se ejecutan las solicitudes de escritura. |
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Respuesta a una BatchUpdateFormRequest.
Representación JSON |
---|
{ "form": { object ( |
Campos | |
---|---|
form |
Según el campo |
replies[] |
La respuesta de las actualizaciones. Esto asigna 1:1 con las solicitudes de actualización, aunque las respuestas a algunas solicitudes pueden estar vacías. |
writeControl |
El control de escritura actualizado después de aplicar la solicitud. |
Alcances de la autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/forms.body
Para obtener más información, consulta la descripción general de OAuth 2.0.
Solicitud
Los tipos de solicitudes de actualización que se pueden realizar.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . El tipo de solicitud. Las direcciones (kind ) solo pueden ser una de las siguientes opciones: |
|
updateFormInfo |
Actualizar la información del formulario. |
updateSettings |
Actualiza la configuración del formulario. |
createItem |
Crear un elemento nuevo |
moveItem |
Mueve un elemento a una ubicación específica. |
deleteItem |
Borrar un elemento. |
updateItem |
Actualiza un elemento. |
ActualizarFormularioDeInformación
Actualizar la información del formulario.
Representación JSON |
---|
{
"info": {
object ( |
Campos | |
---|---|
info |
La información que se actualizará. |
updateMask |
Obligatorio. Solo se cambian los valores nombrados en esta máscara. Se debe especificar al menos un campo. La raíz Esta es una lista separada por comas de los nombres completamente calificados de los campos. Ejemplo: |
UpdateSettingsRequest
Actualizar FormSettings
del formulario
Representación JSON |
---|
{
"settings": {
object ( |
Campos | |
---|---|
settings |
Obligatorio. La configuración con la que se actualizará. |
updateMask |
Obligatorio. Solo se cambian los valores nombrados en esta máscara. Se debe especificar al menos un campo. La raíz Esta es una lista separada por comas de los nombres completamente calificados de los campos. Ejemplo: |
CreateItemRequest
Crea un elemento en un formulario.
Representación JSON |
---|
{ "item": { object ( |
Campos | |
---|---|
item |
Obligatorio. El elemento que se creará. |
location |
Obligatorio. Dónde colocar el elemento nuevo |
Ubicación
Corresponde a una ubicación específica en un formulario.
Representación JSON |
---|
{ "index": integer } |
Campos | |
---|---|
index |
El índice de un elemento en el formulario. Debe estar dentro del rango
, donde N es la cantidad de elementos del formulario. |
Solicitud de MoveItem
Mueve un elemento en un formulario.
Representación JSON |
---|
{ "originalLocation": { object ( |
Campos | |
---|---|
originalLocation |
Obligatorio. La ubicación del elemento que se moverá. |
newLocation |
Obligatorio. La nueva ubicación del elemento. |
DeleteItemRequest
Borrar un elemento de un formulario
Representación JSON |
---|
{
"location": {
object ( |
Campos | |
---|---|
location |
Obligatorio. La ubicación del elemento que se borrará. |
Solicitud de UpdateUpdate
Actualiza un elemento de un formulario.
Representación JSON |
---|
{ "item": { object ( |
Campos | |
---|---|
item |
Obligatorio. Nuevos valores para el elemento. Tenga en cuenta que los ID de artículo y pregunta se utilizan si se proporcionan (y se encuentran en la máscara de campo). Si un ID está en blanco (y en la máscara de campo), se generará uno nuevo. Esto significa que puedes modificar un elemento. Para ello, obtén el formulario a través de |
location |
Obligatorio. La ubicación que identifica el elemento que se actualizará. |
updateMask |
Obligatorio. Solo se cambian los valores nombrados en esta máscara. Esta es una lista separada por comas de los nombres completamente calificados de los campos. Ejemplo: |
Escribir control
Proporciona control sobre cómo se ejecutan las solicitudes de escritura.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión control . Determina la revisión del formulario desde el que se aplicarán los cambios y cómo debe comportarse la solicitud si esa revisión no es la revisión actual del formulario. Las direcciones (control ) solo pueden ser una de las siguientes opciones: |
|
requiredRevisionId |
El ID de revisión del formulario al que se aplica la solicitud de escritura. Si esta no es la última revisión del formulario, la solicitud no se procesa y muestra un error 400 de solicitud incorrecta. |
targetRevisionId |
El ID de revisión de destino del formulario al que se aplica la solicitud de escritura. Si se realizaron cambios después de esta revisión, los cambios en esta solicitud de actualización se transforman en esos cambios. Esto da como resultado una nueva revisión del formulario que incorpora los cambios en la solicitud y los cambios intermedios, y el servidor resuelve los cambios conflictivos. El ID de revisión de destino solo se puede usar para escribir en versiones recientes de un formulario. Si la revisión de destino está demasiado retrasada con respecto a la última revisión, la solicitud no se procesa y muestra un error 400 (Error de solicitud incorrecta). Se puede reintentar la solicitud después de leer la versión más reciente del formulario. En la mayoría de los casos, un ID de revisión de destino permanece válido durante varios minutos después de su lectura, pero para los formularios que se editan con frecuencia, esta ventana puede ser más corta. |
Respuesta
Una sola respuesta a partir de una actualización
Representación JSON |
---|
{
"createItem": {
object ( |
Campos | |
---|---|
createItem |
El resultado de la creación de un elemento. |
CreateItemResponse;
El resultado de la creación de un elemento.
Representación JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
Campos | |
---|---|
itemId |
El ID del elemento creado. |
questionId[] |
El ID de la pregunta creada como parte de este elemento. Para un grupo de preguntas, enumera los ID de todas las preguntas creadas para este elemento. |