Method: forms.batchUpdate

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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

string

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 (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campos
includeFormInResponse

boolean

Indica si se debe mostrar una versión actualizada del modelo en la respuesta.
requests[]

object (Request)

Obligatorio. Las solicitudes de actualización de este lote
writeControl

object (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 (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campos
form

object (Form)

Según el campo includeFormInResponse de la solicitud booleano, se muestra un formulario con todas las mutaciones o actualizaciones aplicadas. Es posible que sea posterior al ID de revisión creado por estos cambios.
replies[]

object (Response)

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

object (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 kind can be only one of the following:
  "updateFormInfo": {
    object (UpdateFormInfoRequest)
  },
  "updateSettings": {
    object (UpdateSettingsRequest)
  },
  "createItem": {
    object (CreateItemRequest)
  },
  "moveItem": {
    object (MoveItemRequest)
  },
  "deleteItem": {
    object (DeleteItemRequest)
  },
  "updateItem": {
    object (UpdateItemRequest)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. El tipo de solicitud. Las direcciones (kind) solo pueden ser una de las siguientes opciones:
updateFormInfo

object (UpdateFormInfoRequest)

Actualizar la información del formulario.
updateSettings

object (UpdateSettingsRequest)

Actualiza la configuración del formulario.
createItem

object (CreateItemRequest)

Crear un elemento nuevo
moveItem

object (MoveItemRequest)

Mueve un elemento a una ubicación específica.
deleteItem

object (DeleteItemRequest)

Borrar un elemento.
updateItem

object (UpdateItemRequest)

Actualiza un elemento.

ActualizarFormularioDeInformación

Actualizar la información del formulario.

Representación JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Campos
info

object (Info)

La información que se actualizará.
updateMask

string (FieldMask format)

Obligatorio. Solo se cambian los valores nombrados en esta máscara. Se debe especificar al menos un campo. La raíz info está implícita y no se debe especificar. Se puede usar una sola abreviatura como "*" para actualizar todos los campos.

Esta es una lista separada por comas de los nombres completamente calificados de los campos. Ejemplo: "user.displayName,photo".

UpdateSettingsRequest

Actualizar FormSettings del formulario

Representación JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Campos
settings

object (FormSettings)

Obligatorio. La configuración con la que se actualizará.
updateMask

string (FieldMask format)

Obligatorio. Solo se cambian los valores nombrados en esta máscara. Se debe especificar al menos un campo. La raíz settings está implícita y no se debe especificar. Se puede usar una sola abreviatura como "*" para actualizar todos los campos.

Esta es una lista separada por comas de los nombres completamente calificados de los campos. Ejemplo: "user.displayName,photo".

CreateItemRequest

Crea un elemento en un formulario.

Representación JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Campos
item

object (Item)

Obligatorio. El elemento que se creará.
location

object (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

integer

El índice de un elemento en el formulario. Debe estar dentro del rango

[0..N)

, donde N es la cantidad de elementos del formulario.

Solicitud de MoveItem

Mueve un elemento en un formulario.

Representación JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Campos
originalLocation

object (Location)

Obligatorio. La ubicación del elemento que se moverá.
newLocation

object (Location)

Obligatorio. La nueva ubicación del elemento.

DeleteItemRequest

Borrar un elemento de un formulario

Representación JSON 
{
  "location": {
    object (Location)
  }
}
Campos
location

object (Location)

Obligatorio. La ubicación del elemento que se borrará.

Solicitud de UpdateUpdate

Actualiza un elemento de un formulario.

Representación JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Campos
item

object (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 forms.get, modifica tu copia local de ese elemento para que sea como deseas y usa UpdateItemRequest para volver a escribirlo, sin que los ID tengan el mismo resultado (o no estén en la máscara del campo).
location

object (Location)

Obligatorio. La ubicación que identifica el elemento que se actualizará.
updateMask

string (FieldMask format)

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: "user.displayName,photo".

Escribir control

Proporciona control sobre cómo se ejecutan las solicitudes de escritura.

Representación JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
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

string

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

string

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 (CreateItemResponse)
  }
}
Campos
createItem

object (CreateItemResponse)

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

string

El ID del elemento creado.
questionId[]

string

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.