Method: documents.batchUpdate

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

Aplica una o más actualizaciones al documento.

Cada request se valida antes de aplicarlos. Si alguna solicitud no es válida, fallará toda la solicitud y no se aplicará nada.

Algunas solicitudes tienen replies para darte información sobre cómo se aplican. Otras solicitudes no necesitan mostrar información; cada una muestra una respuesta vacía. El orden de las respuestas coincide con el de las solicitudes.

Por ejemplo, supongamos que llamas a batchUpdate con cuatro actualizaciones, y solo la tercera muestra información. La respuesta tendría dos respuestas vacías, la respuesta a la tercera solicitud y otra respuesta vacía, en ese orden.

Debido a que otros usuarios pueden estar editando el documento, es posible que este no refleje exactamente tus cambios: es posible que los cambios se modifiquen con respecto a los cambios de los colaboradores. Si no hay colaboradores, el documento debería reflejar tus cambios. En cualquier caso, se garantiza que las actualizaciones de tu solicitud se apliquen de forma atómica.

Solicitud HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
documentId

string

El ID del documento que se actualizará.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campos
requests[]

object (Request)

Lista de actualizaciones que se aplican al documento.

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:

Mensaje de respuesta de una solicitud documents.batchUpdate.

Representación JSON
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campos
documentId

string

El ID del documento al que se aplicaron las actualizaciones.

replies[]

object (Response)

La respuesta de las actualizaciones. Esto se asigna de forma individual con las actualizaciones, 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/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Para obtener más información, consulta la descripción general de OAuth 2.0.

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 documento en el que se debe escribir y cómo debe comportarse la solicitud si esa revisión no es la actual. Si no se especifica ninguno de los campos, las actualizaciones se aplican a la última revisión. Las direcciones (control) solo pueden ser una de las siguientes opciones:
requiredRevisionId

string

El revision ID opcional del documento al que se aplica la solicitud de escritura. Si esta no es la última revisión del documento, la solicitud no se procesa y muestra un error 400 de solicitud incorrecta.

Cuando se muestra un ID de revisión obligatorio en una respuesta, este indica el ID de revisión del documento después de aplicar la solicitud.

targetRevisionId

string

El destino opcional revision ID del documento al que se aplica la solicitud de escritura.

Si se realizaron cambios de colaboradores después de la lectura del documento con la API, los cambios que generó esta solicitud de escritura se aplican a los cambios de colaborador. Esto da como resultado una nueva revisión del documento que incorpora tanto los cambios del colaborador como los cambios en la solicitud, y el servidor de Documentos resuelve los cambios conflictivos. Cuando se usa el ID de revisión de destino, se puede considerar al cliente de la API como otro colaborador del documento.

El ID de revisión de destino solo se puede usar para escribir en versiones recientes de un documento. 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 de solicitud incorrecta. La solicitud se debe volver a intentar después de recuperar la versión más reciente del documento. Por lo general, un ID de revisión sigue siendo válido para usarse como una revisión de destino durante varios minutos después de su lectura. Sin embargo, para los documentos editados con frecuencia, esta ventana puede ser más corta.