- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Solicitud
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Ubicación
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Respuesta
- CreateItemResponse
- Pruébalo
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 | |
---|---|
form |
Es 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 | |
---|---|
include |
Indica si se debe mostrar una versión actualizada del modelo en la respuesta. |
requests[] |
Es obligatorio. Las solicitudes de actualización de este lote |
write |
Proporciona control sobre cómo se ejecutan las solicitudes de escritura. |
Cuerpo de la respuesta
Es la respuesta a una BatchUpdateFormRequest.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "form": { object ( |
Campos | |
---|---|
form |
En función del campo de solicitud booleana |
replies[] |
La respuesta de las actualizaciones. Esto se asigna 1:1 con las solicitudes de actualización, aunque las respuestas a algunas solicitudes pueden estar vacías. |
write |
El control de escritura actualizado después de aplicar la solicitud |
Permisos de autorización
Se necesita uno de los siguientes permisos 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 Guía de autorización.
Solicitud
Los tipos de solicitudes de actualización que se pueden realizar.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . Es el tipo de solicitud. Las direcciones (kind ) solo pueden ser una de las siguientes opciones: |
|
update |
Actualiza la información del formulario. |
update |
Actualiza la configuración del formulario. |
create |
Crear un elemento nuevo |
move |
Mover un elemento a una ubicación especificada |
delete |
Borrar un elemento |
update |
Actualiza un elemento. |
UpdateFormInfoRequest
Actualiza la información del formulario.
Representación JSON |
---|
{
"info": {
object ( |
Campos | |
---|---|
info |
Es la información que se actualizará. |
update |
Es obligatorio. Solo se modifican los valores nombrados en esta máscara. Se debe especificar al menos un campo. El Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: |
UpdateSettingsRequest
Actualiza el FormSettings
del formulario.
Representación JSON |
---|
{
"settings": {
object ( |
Campos | |
---|---|
settings |
Es obligatorio. Es la configuración con la que se actualizará. |
update |
Es obligatorio. Solo se modifican los valores nombrados en esta máscara. Se debe especificar al menos un campo. El Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: |
CreateItemRequest
Crear un elemento en un formulario
Representación JSON |
---|
{ "item": { object ( |
Campos | |
---|---|
item |
Es obligatorio. El elemento que se creará. |
location |
Es obligatorio. Dónde colocar el elemento nuevo |
Ubicación
Es una ubicación específica en un formulario.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión where . Es obligatorio. Especifica una ubicación en el formulario. Las direcciones (where ) solo pueden ser una de las siguientes opciones: |
|
index |
Es el índice de un elemento en el formulario. Debe estar en el rango
, donde N es la cantidad de elementos del formulario. |
MoveItemRequest
Mover un elemento en un formulario
Representación JSON |
---|
{ "originalLocation": { object ( |
Campos | |
---|---|
original |
Es obligatorio. Es la ubicación del elemento que se moverá. |
new |
Es obligatorio. Es la nueva ubicación del artículo. |
DeleteItemRequest
Borrar un elemento de un formulario
Representación JSON |
---|
{
"location": {
object ( |
Campos | |
---|---|
location |
Es obligatorio. Es la ubicación del elemento que se borrará. |
UpdateItemRequest
Actualiza un elemento en un formulario.
Representación JSON |
---|
{ "item": { object ( |
Campos | |
---|---|
item |
Es obligatorio. Son los valores nuevos del artículo. Ten en cuenta que los IDs de artículo y pregunta se usan si se proporcionan (y están en la máscara de campo). Si un ID está en blanco (y en la máscara de campo), se genera uno nuevo. Esto significa que puedes modificar un elemento obteniendo el formulario a través de |
location |
Es obligatorio. Es la ubicación que identifica el elemento que se actualizará. |
update |
Es obligatorio. Solo se modifican los valores nombrados en esta máscara. Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: |
WriteControl
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 a partir de la cual se deben aplicar los cambios y cómo debe comportarse la solicitud si esa revisión no es la actual del formulario. Las direcciones (control ) solo pueden ser una de las siguientes opciones: |
|
required |
El ID de revisión del formulario al que se aplica la solicitud de escritura. Si esta no es la revisión más reciente del formulario, la solicitud no se procesará y se mostrará un error de solicitud incorrecta 400. |
target |
El ID de revisión objetivo del formulario al que se aplica la solicitud de escritura. Si se produjeron cambios después de esta revisión, los cambios de esta solicitud de actualización se transforman en función de esos cambios. Esto genera una nueva revisión del formulario que incorpora los cambios de la solicitud y los cambios intermedios, y el servidor resuelve los cambios en conflicto. El ID de revisión de destino solo se puede usar para escribir en versiones recientes de un formulario. Si la revisión objetivo está muy atrasada con respecto a la más reciente, no se procesará la solicitud y se mostrará un error 400 (error de solicitud incorrecta). Se puede volver a intentar 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 objetivo permanece válido durante varios minutos después de que se lee, pero para los formularios que se editan con frecuencia, esta ventana puede ser más corta. |
Respuesta
Una sola respuesta de una actualización.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . El tipo de respuesta. Las direcciones (kind ) solo pueden ser una de las siguientes opciones: |
|
create |
Es el resultado de crear un elemento. |
CreateItemResponse
Es el resultado de crear un elemento.
Representación JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
Campos | |
---|---|
item |
Es el ID del artículo creado. |
question |
Es el ID de la pregunta creada como parte de este elemento. En el caso de un grupo de preguntas, se enumeran los IDs de todas las preguntas creadas para este elemento. |