- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Solicitar
- ReplaceAllTextRequest
- SubstringMatchCriteria
- TabsCriteria
- InsertTextRequest
- Ubicación
- EndOfSegmentLocation
- UpdateTextStyleRequest
- CreateParagraphBulletsRequest
- BulletGlyphPreset
- DeleteParagraphBulletsRequest
- CreateNamedRangeRequest
- DeleteNamedRangeRequest
- UpdateParagraphStyleRequest
- DeleteContentRangeRequest
- InsertInlineImageRequest
- InsertTableRequest
- InsertTableRowRequest
- TableCellLocation
- InsertTableColumnRequest
- DeleteTableRowRequest
- DeleteTableColumnRequest
- InsertPageBreakRequest
- DeletePositionedObjectRequest
- UpdateTableColumnPropertiesRequest
- UpdateTableCellStyleRequest
- TableRange
- UpdateTableRowStyleRequest
- ReplaceImageRequest
- ImageReplaceMethod
- UpdateDocumentStyleRequest
- MergeTableCellsRequest
- UnmergeTableCellsRequest
- CreateHeaderRequest
- HeaderFooterType
- CreateFooterRequest
- CreateFootnoteRequest
- ReplaceNamedRangeContentRequest
- UpdateSectionStyleRequest
- InsertSectionBreakRequest
- DeleteHeaderRequest
- DeleteFooterRequest
- PinTableHeaderRowsRequest
- WriteControl
- Respuesta
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetsChartResponse
- CreateHeaderResponse
- CreateFooterResponse
- CreateFootnoteResponse
- Pruébalo
Aplica una o más actualizaciones al documento.
Cada request
se valida antes de aplicarse. Si alguna solicitud no es válida, fallará la solicitud completa y no se aplicará nada.
Algunas solicitudes tienen replies
para brindarte información sobre cómo se aplican. Otras solicitudes no necesitan devolver información. y cada una devolverá una respuesta vacía. El orden de las respuestas coincide con el de las solicitudes.
Por ejemplo, supongamos que llamas a AndroidManifest 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.
Como es posible que otros usuarios estén editando el documento, este podría no reflejar exactamente tus cambios: tus cambios pueden alterarse con respecto a los cambios de los colaboradores. Si no hay colaboradores, el documento debe reflejar tus cambios. En cualquier caso, se garantiza que las actualizaciones en tu solicitud se aplicarán juntas 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 |
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 ( |
Campos | |
---|---|
requests[] |
Una lista de actualizaciones que se aplicarán al documento. |
writeControl |
Proporciona control sobre cómo se ejecutan las solicitudes de escritura. |
Cuerpo de la respuesta
Mensaje de respuesta de una solicitud documents.batchUpdate
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "documentId": string, "replies": [ { object ( |
Campos | |
---|---|
documentId |
El ID del documento al que se aplicaron las actualizaciones. |
replies[] |
La respuesta de las actualizaciones. Este mapa se asigna 1:1 con las actualizaciones, aunque las respuestas a algunas solicitudes pueden estar vacías. |
writeControl |
El control de escritura actualizado después de aplicar la solicitud. |
Alcances de autorización
Se necesita uno de los siguientes permisos 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 Guía de autorización.
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 documento en la que se escribirá y el comportamiento que debería tener la solicitud si esa revisión no es la revisión actual del documento. Si no se especifica ninguno de los campos, se aplicarán las actualizaciones a la revisión más reciente. Las direcciones (control ) solo pueden ser una de las siguientes opciones: |
|
requiredRevisionId |
El Cuando se muestra un ID de revisión requerido en una respuesta, este indica el ID de revisión del documento después de que se aplicó la solicitud. |
targetRevisionId |
El destino opcional Si se realizaron cambios de colaborador después de leer el documento con la API, los cambios producidos por esta solicitud de escritura se aplicarán a los cambios del colaborador. Esto da como resultado una nueva revisión del documento que incorpora los cambios del colaborador y 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 revisión objetivo durante varios minutos después de su lectura, pero para los documentos editados con frecuencia, este período puede ser más corto. |