Solicitud
Una sola actualización que se aplica a un documento.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
request Es la solicitud específica que se debe aplicar. Se requiere exactamente un campo.
request
solo puede ser una de las siguientes opciones:
|
|
replaceAllText
|
Reemplaza todas las instancias del texto especificado. |
insertText
|
Inserta texto en la ubicación especificada. |
updateTextStyle
|
Actualiza el estilo de texto en el rango especificado. |
createParagraphBullets
|
Crea viñetas para los párrafos. |
deleteParagraphBullets
|
Borra las viñetas de los párrafos. |
createNamedRange
|
Crea un rango con nombre. |
deleteNamedRange
|
Borra un rango con nombre. |
updateParagraphStyle
|
Actualiza el estilo de párrafo en el rango especificado. |
deleteContentRange
|
Borra el contenido del documento. |
insertInlineImage
|
Inserta una imagen intercalada en la ubicación especificada. |
insertTable
|
Inserta una tabla en la ubicación especificada. |
insertTableRow
|
Inserta una fila vacía en una tabla. |
insertTableColumn
|
Inserta una columna vacía en una tabla. |
deleteTableRow
|
Borra una fila de una tabla. |
deleteTableColumn
|
Borra una columna de una tabla. |
insertPageBreak
|
Inserta un salto de página en la ubicación especificada. |
deletePositionedObject
|
Borra un objeto posicionado del documento. |
updateTableColumnProperties
|
Actualiza las propiedades de las columnas de una tabla. |
updateTableCellStyle
|
Actualiza el estilo de las celdas de la tabla. |
updateTableRowStyle
|
Actualiza el estilo de fila en una tabla. |
replaceImage
|
Reemplaza una imagen en el documento. |
updateDocumentStyle
|
Actualiza el estilo del documento. |
mergeTableCells
|
Combina celdas en una tabla. |
unmergeTableCells
|
Separa celdas en una tabla. |
createHeader
|
Crea un encabezado. |
createFooter
|
Crea un pie de página. |
createFootnote
|
Crea una nota al pie. |
replaceNamedRangeContent
|
Reemplaza el contenido en un rango con nombre. |
updateSectionStyle
|
Actualiza el estilo de la sección del rango especificado. |
insertSectionBreak
|
Inserta un salto de sección en la ubicación especificada. |
deleteHeader
|
Borra un encabezado del documento. |
deleteFooter
|
Borra un pie de página del documento. |
pinTableHeaderRows
|
Actualiza la cantidad de filas de encabezado fijadas en una tabla. |
ReplaceAllTextRequest
Reemplaza todas las instancias de texto que coinciden con un criterio por
replace text
Representación JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Campos | |
---|---|
replaceText
|
El texto que reemplazará el texto coincidente. |
tabsCriteria
|
Opcional. Los criterios que se usan para especificar en qué pestañas se realiza el reemplazo. Si se omite, el reemplazo se aplica a todas las pestañas. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
Campo de unión
criteria Los criterios utilizados para hacer coincidir el texto que se reemplazará.
criteria
solo puede ser una de las siguientes opciones:
|
|
containsText
|
Busca texto en el documento que coincida con esta subcadena. |
SubstringMatchCriteria
Es un criterio que coincide con una cadena específica de texto del documento.
Representación JSON |
---|
{ "text": string, "matchCase": boolean } |
Campos | |
---|---|
text
|
Es el texto que se buscará en el documento. |
matchCase
|
Indica si la búsqueda debe respetar las mayúsculas y minúsculas:
|
TabsCriteria
Un criterio que especifica en qué pestañas se ejecuta una solicitud.
Representación JSON |
---|
{ "tabIds": [ string ] } |
Campos | |
---|---|
tabIds[]
|
La lista de IDs de pestañas en los que se ejecuta la solicitud. |
InsertTextRequest
Inserta texto en la ubicación especificada.
Representación JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text
|
Texto que se va a insertar
Si insertas un carácter de línea nueva, se crea implícitamente un nuevo carácter
Los estilos de texto del texto insertado se determinarán automáticamente y, por lo general, conservarán el estilo del texto cercano. En la mayoría de los casos, el estilo de texto del texto insertado coincidirá con el texto inmediatamente anterior al índice de inserción. Algunos caracteres de control (U+0000-U+0008, U+000C-U+001F) y caracteres del Área de uso privado del plano multilingüe básico de Unicode (U+E000-U+F8FF) se quitarán del texto insertado. |
Campo de unión
insertion_location La ubicación en la que se insertará el texto.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
location
|
Inserta el texto en un índice específico del documento.
El texto debe insertarse dentro de los límites de un
|
endOfSegmentLocation
|
Inserta el texto al final de un encabezado, un pie de página, una nota al pie o el cuerpo del documento. |
Ubicación
Una ubicación particular en el documento.
Representación JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
Campos | |
---|---|
segmentId
|
Es el ID del encabezado, el pie de página o la nota al pie en el que se encuentra la ubicación. Un ID de segmento vacío hace referencia al cuerpo del documento. |
index
|
Es el índice basado en cero, en unidades de código UTF-16.
El índice es relativo al comienzo del segmento especificado por
|
tabId
|
La pestaña en la que se encuentra la ubicación. Cuando se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
EndOfSegmentLocation
Ubicación al final de un cuerpo, un encabezado, un pie de página o una nota al pie La ubicación es inmediatamente anterior a la última línea nueva del segmento del documento.
Representación JSON |
---|
{ "segmentId": string, "tabId": string } |
Campos | |
---|---|
segmentId
|
Es el ID del encabezado, el pie de página o la nota al pie en el que se encuentra la ubicación. Un ID de segmento vacío hace referencia al cuerpo del documento. |
tabId
|
La pestaña en la que se encuentra la ubicación. Cuando se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
UpdateTextStyleRequest
Actualiza el estilo del texto.
Representación JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle
|
Los estilos que se establecerán en el texto. Si el valor de un estilo particular coincide con el del elemento superior, se configurará ese estilo como heredado.
Algunos cambios en el estilo de texto pueden provocar otras modificaciones para imitar el comportamiento del editor de Documentos. Consulta la documentación de
|
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar el estilo de texto a negrita, establece
Para restablecer una propiedad a su valor predeterminado, incluye el nombre de su campo en la máscara de campo, pero no configures el campo. |
Campo de unión
insertion_location El tipo de rango utilizado en el que se actualizará el estilo de texto.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
range
|
Es el rango de texto al que se le aplicará estilo. El rango se puede extender para incluir líneas nuevas adyacentes. Si el rango contiene por completo un párrafo que pertenece a una lista, la viñeta del párrafo también se actualiza con el estilo de texto coincidente. No se pueden insertar rangos dentro de una UpdateTextStyleRequest relativa. |
CreateParagraphBulletsRequest
Crea viñetas para todos los párrafos que se superponen con el rango dado.
El nivel de anidamiento de cada párrafo se determinará mediante el recuento de las pestañas iniciales delante de cada párrafo. Para evitar el exceso de espacio entre la viñeta y el párrafo correspondiente, esta solicitud quita las pestañas iniciales. Esto puede cambiar los índices de partes del texto.
Si el párrafo que se encuentra justo antes de que se actualicen está en una lista con un ajuste predeterminado correspondiente, los párrafos que se actualizan se agregan a la lista anterior.
Representación JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
Rango en el que se aplicará el ajuste predeterminado de viñetas. |
bulletPreset
|
Los tipos de glifos de viñetas que se usarán. |
BulletGlyphPreset
Patrones predeterminados de glifos de viñetas para las listas
Estos patrones usan los siguientes tipos de viñetas:
-
ARROW
: Una flecha que corresponde a un punto de código Unicode U+2794 -
ARROW3D
: Flecha con sombreado 3D, que corresponde a un punto de código Unicode U+27a2 -
CHECKBOX
: Cuadrado hueco, que corresponde a un punto de código Unicode U+274f -
CIRCLE
: Un círculo hueco, que corresponde a un punto de código Unicode U+25cb -
DIAMOND
: Diamante sólido, que corresponde a un punto de código Unicode U+25c6 -
DIAMONDX
: Un diamante con una "x", que corresponde a un punto de código Unicode U+2756 -
HOLLOWDIAMOND
: Diamante hueco, que corresponde a un punto de código Unicode U+25c7 -
DISC
: Un círculo sólido que corresponde a un punto de código Unicode U+25cf -
SQUARE
: Un cuadrado sólido, que corresponde a un punto de código Unicode U+25a0 -
STAR
: Un asterisco, que corresponde a un punto de código Unicode U+2605 -
ALPHA
: Una letra minúscula, como “a”, “b” o “c”. -
UPPERALPHA
: Una letra mayúscula, como “A”, “B” o “C”. -
DECIMAL
: Un número, como “1”, “2” o “3”. -
ZERODECIMAL
: Número en el que los números de un solo dígito tienen el prefijo de cero, como “01”, “02” o “03”. Los números con más de un dígito no tienen el prefijo cero. -
ROMAN
: Un número romano en minúscula, como "i", "ii" o "iii". -
UPPERROMAN
: Un número romano en mayúsculas, como "I", "II" o "III". -
LEFTTRIANGLE
: Un triángulo que apunta a la izquierda, que corresponde a un punto de código Unicode U+25c4
Enumeraciones | |
---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED
|
El ajuste predeterminado de glifos de viñetas no está especificado. |
BULLET_DISC_CIRCLE_SQUARE
|
Una lista con viñetas con un
DISC ,
CIRCLE
y
SQUARE
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Una lista con viñetas
DIAMONDX ,
ARROW3D
y
SQUARE
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_CHECKBOX
|
Una lista con viñetas con
CHECKBOX
glifos de viñetas para todos los niveles de anidamiento de listas.
|
BULLET_ARROW_DIAMOND_DISC
|
Una lista con viñetas
ARROW ,
DIAMOND
y
DISC
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_STAR_CIRCLE_SQUARE
|
Una lista con viñetas con un
STAR ,
CIRCLE
y
SQUARE
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Una lista con viñetas con un
ARROW3D ,
CIRCLE
y
SQUARE
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Una lista con viñetas con un
LEFTTRIANGLE ,
DIAMOND
y
DISC
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Una lista con viñetas con un
DIAMONDX ,
HOLLOWDIAMOND
y
SQUARE
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Una lista con viñetas con un
DIAMOND ,
CIRCLE
y
SQUARE
glifo de viñetas para los primeros 3 niveles de anidación de listas.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Una lista numerada con
DECIMAL ,
ALPHA
y
ROMAN
glifos numéricos para los primeros 3 niveles de anidamiento de listas, seguidos de puntos.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Una lista numerada con
DECIMAL ,
ALPHA
y
ROMAN
glifos numéricos para los primeros 3 niveles de anidamiento de listas, seguidos de paréntesis.
|
NUMBERED_DECIMAL_NESTED
|
Una lista numerada con
DECIMAL
glifos numéricos separados por puntos, en los que cada nivel de anidamiento usa el glifo del nivel de anidamiento anterior como prefijo Por ejemplo: “1.”, '1.1.', '2.', '2.2.'
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Una lista numerada con
UPPERALPHA ,
ALPHA
y
ROMAN
glifos numéricos para los primeros 3 niveles de anidamiento de listas, seguidos de puntos.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Una lista numerada con
UPPERROMAN ,
UPPERALPHA
y
DECIMAL
glifos numéricos para los primeros 3 niveles de anidamiento de listas, seguidos de puntos.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Una lista numerada con
ZERODECIMAL ,
ALPHA
y
ROMAN
glifos numéricos para los primeros 3 niveles de anidamiento de listas, seguidos de puntos.
|
DeleteParagraphBulletsRequest
Elimina las viñetas de todos los párrafos que se superponen con el rango dado.
El nivel de anidamiento de cada párrafo se preservará visualmente agregando sangría al comienzo del párrafo correspondiente.
Representación JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
El rango en el que se borrarán las viñetas. |
CreateNamedRangeRequest
Crea un
NamedRange
que hacen referencia al rango dado.
Representación JSON |
---|
{
"name": string,
"range": {
object (
|
Campos | |
---|---|
name
|
Es el nombre del NamedRange. No es necesario que los nombres sean únicos. Los nombres deben tener al menos 1 carácter y no más de 256 caracteres, medidos en unidades de código UTF-16. |
range
|
El rango al que se le aplicará el nombre. |
DeleteNamedRangeRequest
Borra un
NamedRange
Representación JSON |
---|
{ "tabsCriteria": { object ( |
Campos | |
---|---|
tabsCriteria
|
Opcional. Los criterios que se usan para especificar en qué pestañas debe ocurrir la eliminación del rango. Cuando se omite, la eliminación del rango se aplica a todas las pestañas. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
Campo de unión
named_range_reference El valor que determina qué rango o rangos se borrarán. Se debe establecer exactamente uno.
named_range_reference
solo puede ser una de las siguientes opciones:
|
|
namedRangeId
|
El ID del rango con nombre que se borrará. |
name
|
El nombre de los rangos que se borrarán. Se borrarán todos los rangos con ese nombre. |
UpdateParagraphStyleRequest
Se actualizó el estilo de todos los párrafos que se superponen con el rango especificado.
Representación JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle
|
Los estilos que se establecerán en los párrafos.
Algunos cambios en el estilo de párrafo pueden provocar otras modificaciones para reflejar el comportamiento del editor de Documentos. Consulta la documentación de
|
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar la propiedad de alineación del estilo de párrafo, establece
Para restablecer una propiedad a su valor predeterminado, incluye el nombre de su campo en la máscara de campo, pero no configures el campo. |
Campo de unión
insertion_location El tipo de rango utilizado en el que se actualizará el estilo de párrafo.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
range
|
El rango que se superpone a los párrafos al que se le quiere aplicar diseño. |
DeleteContentRangeRequest
Borra el contenido del documento.
Representación JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
El rango de contenido que se borrará. Si eliminas texto que excede el límite de un párrafo, es posible que se produzcan cambios en los estilos de párrafo, las listas, los objetos de posición y los marcadores, ya que se combinan los dos párrafos. Si intentas borrar ciertos rangos, es posible que se genere una estructura de documento no válida, en cuyo caso se muestra un error 400 de solicitud incorrecta. Estos son algunos ejemplos de solicitudes de eliminación no válidas:
|
InsertInlineImageRequest
Inserta un
InlineObject
que contengan una imagen en una ubicación determinada.
Representación JSON |
---|
{ "uri": string, "objectSize": { object ( |
Campos | |
---|---|
uri
|
El URI de la imagen. La imagen se recupera una vez en el momento de la inserción y se almacena una copia para mostrarla dentro del documento. Las imágenes deben tener un tamaño inferior a 50 MB, no pueden superar los 25 megapíxeles y deben estar en formato PNG, JPEG o GIF.
El URI proporcionado debe ser de acceso público y tener una longitud máxima de 2 KB. El URI se guarda con la imagen y se expone a través del
|
objectSize
|
Es el tamaño en el que debe aparecer la imagen en el documento. Esta propiedad es opcional y el tamaño final de la imagen en el documento se determina con las siguientes reglas: * Si no se especifica el ancho ni la altura, se calcula un tamaño predeterminado de la imagen en función de su resolución. * Si se especifica una dimensión, la otra se calcula para conservar la relación de aspecto de la imagen. * Si se especifican el ancho y la altura, la imagen se ajusta para ajustarse a las dimensiones proporcionadas y se mantiene su relación de aspecto. |
Campo de unión
insertion_location La ubicación en la que se insertará la imagen.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
location
|
Inserta la imagen en un índice específico del documento.
La imagen debe insertarse dentro de los límites de un
No se pueden insertar imágenes intercaladas dentro de una nota al pie o una ecuación. |
endOfSegmentLocation
|
Inserta el texto al final de un encabezado, un pie de página o el cuerpo del documento. No se pueden insertar imágenes intercaladas dentro de una nota al pie. |
InsertTableRequest
Inserta una tabla en la ubicación especificada.
Se insertará un carácter de línea nueva antes de la tabla insertada.
Representación JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
Campos | |
---|---|
rows
|
La cantidad de filas en la tabla. |
columns
|
La cantidad de columnas de la tabla. |
Campo de unión
insertion_location La ubicación en la que se insertará la tabla.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
location
|
Inserta la tabla en un índice de modelo específico. Se insertará un carácter de línea nueva antes de la tabla insertada, por lo que el índice de inicio de la tabla estará en el índice de ubicación especificado + 1.
La tabla debe insertarse dentro de los límites de un
No se pueden insertar tablas en una nota al pie ni en una ecuación. |
endOfSegmentLocation
|
Inserta la tabla al final del encabezado, el pie de página o el cuerpo del documento especificados. Se insertará un carácter de línea nueva antes de la tabla insertada. No se pueden insertar tablas en una nota al pie. |
InsertTableRowRequest
Inserta una fila vacía en una tabla.
Representación JSON |
---|
{
"tableCellLocation": {
object (
|
Campos | |
---|---|
tableCellLocation
|
La ubicación de la celda de la tabla de referencia desde la que se insertarán las filas. Se insertará una fila nueva encima (o debajo) de la fila donde se encuentra la celda de referencia. Si la celda de referencia es una celda combinada, se insertará una fila nueva encima (o debajo) de la celda combinada. |
insertBelow
|
Establece si se debe insertar una fila nueva debajo de la ubicación de la celda de referencia.
|
TableCellLocation
Ubicación de una sola celda dentro de una tabla.
Representación JSON |
---|
{
"tableStartLocation": {
object (
|
Campos | |
---|---|
tableStartLocation
|
La ubicación donde comienza la tabla en el documento. |
rowIndex
|
Es el índice de filas basado en cero. Por ejemplo, la segunda fila de la tabla tiene un índice de filas de 1. |
columnIndex
|
Índice de columna basado en cero. Por ejemplo, la segunda columna de la tabla tiene un índice de columna de 1. |
InsertTableColumnRequest
Inserta una columna vacía en una tabla.
Representación JSON |
---|
{
"tableCellLocation": {
object (
|
Campos | |
---|---|
tableCellLocation
|
La ubicación de la celda de la tabla de referencia desde la que se insertarán las columnas. Se insertará una nueva columna a la izquierda (o derecha) de la columna donde se encuentra la celda de referencia. Si la celda de referencia es una celda combinada, se insertará una columna nueva a la izquierda (o derecha) de la celda combinada. |
insertRight
|
Establece si se debe insertar una columna nueva a la derecha de la ubicación de la celda de referencia.
|
DeleteTableRowRequest
Borra una fila de una tabla.
Representación JSON |
---|
{
"tableCellLocation": {
object (
|
Campos | |
---|---|
tableCellLocation
|
La ubicación de la celda de la tabla de referencia de la que se borrará la fila. Se borrará la fila que abarca esta celda. Si se trata de una celda combinada que abarca varias filas, se borrarán todas las filas que abarca la celda. Si no quedan filas en la tabla después de esta eliminación, se borra toda la tabla. |
DeleteTableColumnRequest
Borra una columna de una tabla.
Representación JSON |
---|
{
"tableCellLocation": {
object (
|
Campos | |
---|---|
tableCellLocation
|
La ubicación de la celda de la tabla de referencia de la que se borrará la columna. Se borrará la columna que abarca esta celda. Si se trata de una celda combinada que abarca varias columnas, se borrarán todas las columnas que abarca la celda. Si no quedan columnas en la tabla después de esta eliminación, se borra toda la tabla. |
InsertPageBreakRequest
Inserta un salto de página seguido de una línea nueva en la ubicación especificada.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
insertion_location La ubicación en la que se insertará el salto de página.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
location
|
Inserta el salto de página en un índice específico del documento.
El salto de página debe insertarse dentro de los límites de un
No se pueden insertar saltos de página en una tabla, ecuación, nota al pie, encabezado ni pie de página. Como los saltos de página solo pueden insertarse dentro del cuerpo,
|
endOfSegmentLocation
|
Inserta el salto de página al final del cuerpo del documento.
No se pueden insertar saltos de página en una nota al pie, un encabezado ni un pie de página. Como los saltos de página solo pueden insertarse dentro del cuerpo,
|
DeletePositionedObjectRequest
Borra un
PositionedObject
del documento.
Representación JSON |
---|
{ "objectId": string, "tabId": string } |
Campos | |
---|---|
objectId
|
El ID del objeto posicionado que se borrará. |
tabId
|
La pestaña en la que se encuentra el objeto posicionado que se borrará. Cuando se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
UpdateTableColumnPropertiesRequest
Actualiza el
TableColumnProperties
de columnas en una tabla.
Representación JSON |
---|
{ "tableStartLocation": { object ( |
Campos | |
---|---|
tableStartLocation
|
La ubicación donde comienza la tabla en el documento. |
columnIndices[]
|
La lista de índices de columna basados en cero cuya propiedad se debe actualizar. Si no se especifican índices, se actualizarán todas las columnas. |
tableColumnProperties
|
Las propiedades de la columna de la tabla que se actualizarán.
Si el valor de
|
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar el ancho de columna, establece
|
UpdateTableCellStyleRequest
Actualiza el estilo de un rango de celdas de la tabla.
Representación JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle
|
El estilo que se establecerá en las celdas de la tabla. Al actualizar bordes, si una celda comparte un borde con una celda adyacente, también se actualiza la propiedad del borde correspondiente de la celda adyacente. Los bordes invisibles y combinados no se actualizan. Dado que actualizar un borde compartido por celdas adyacentes en la misma solicitud puede generar actualizaciones de bordes en conflicto, estas actualizaciones se aplican en el siguiente orden:
|
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar el color de fondo de la celda de la tabla, establece
Para restablecer una propiedad a su valor predeterminado, incluye el nombre de su campo en la máscara de campo, pero no configures el campo. |
Campo de unión
cells Celdas que se actualizarán.
cells
solo puede ser una de las siguientes opciones:
|
|
tableRange
|
El rango de la tabla que representa el subconjunto de la tabla a la que se aplican las actualizaciones. |
tableStartLocation
|
La ubicación donde comienza la tabla en el documento. Cuando se especifica, las actualizaciones se aplican a todas las celdas de la tabla. |
TableRange
El rango de una tabla representa una referencia a un subconjunto de una tabla.
Es importante tener en cuenta que las celdas especificadas por un rango de tabla no necesariamente forman un rectángulo. Por ejemplo, digamos que tenemos una tabla de 3 x 3 en la que todas las celdas de la última fila están fusionadas. La tabla tiene el siguiente aspecto:
[ ][ ][ ]
[ ][ ][ ]
[ ]
En un rango de la tabla con ubicación de celda de tabla = (tableStartLocation, fila = 0, columna = 0), intervalo de fila = 3 y intervalo de columna = 2, especifica las siguientes celdas:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
Representación JSON |
---|
{
"tableCellLocation": {
object (
|
Campos | |
---|---|
tableCellLocation
|
La ubicación de la celda donde comienza el rango de la tabla. |
rowSpan
|
El intervalo de filas del rango de la tabla. |
columnSpan
|
El intervalo de columnas del rango de la tabla. |
UpdateTableRowStyleRequest
Actualiza el
TableRowStyle
de filas en una tabla.
Representación JSON |
---|
{ "tableStartLocation": { object ( |
Campos | |
---|---|
tableStartLocation
|
La ubicación donde comienza la tabla en el documento. |
rowIndices[]
|
Lista de índices de fila basados en cero cuyo estilo se debe actualizar. Si no se especifican índices, se actualizarán todas las filas. |
tableRowStyle
|
Los estilos que se configurarán en las filas. |
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar la altura mínima de la fila, establece
|
ReplaceImageRequest
Reemplaza una imagen existente por una nueva.
Cuando se reemplaza una imagen, se quitan algunas
image effects
a partir de la imagen existente para replicar el comportamiento del editor de Documentos.
Representación JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
Campos | |
---|---|
imageObjectId
|
El ID de la imagen existente que se reemplazará. El ID se puede recuperar a partir de la respuesta de una solicitud get. |
uri
|
El URI de la imagen nueva. La imagen se recupera una vez en el momento de la inserción y se almacena una copia para mostrarla dentro del documento. Las imágenes deben tener un tamaño inferior a 50 MB, no superar los 25 megapíxeles y estar en formato PNG, JPEG o GIF.
El URI proporcionado no puede superar los 2 KB de longitud. El URI se guarda con la imagen y se expone a través del
|
imageReplaceMethod
|
Es el método de reemplazo. |
tabId
|
La pestaña en la que se encuentra la imagen que se reemplazará. Cuando se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
ImageReplaceMethod
El método de reemplazo de imagen.
Enumeraciones | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
Método de reemplazo de imagen no especificado. No se debe usar este valor. |
CENTER_CROP
|
Escala y centra la imagen para llenar los límites de la imagen original. Es posible que se recorte la imagen para llenar los límites de la imagen original. El tamaño renderizado de la imagen será el mismo que el de la imagen original. |
UpdateDocumentStyleRequest
Actualiza el
DocumentStyle
Representación JSON |
---|
{
"documentStyle": {
object (
|
Campos | |
---|---|
documentStyle
|
Son los estilos que se configurarán en el documento.
Algunos cambios en el estilo del documento pueden provocar otras modificaciones para reflejar el comportamiento del editor de Documentos. Consulta la documentación de
|
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar el fondo, establece
|
tabId
|
La pestaña que contiene el diseño que se actualizará. Cuando se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
MergeTableCellsRequest
Combina las celdas en una
Table
Representación JSON |
---|
{
"tableRange": {
object (
|
Campos | |
---|---|
tableRange
|
El rango de la tabla que especifica qué celdas de la tabla se combinarán. Cualquier texto en las celdas que se combinen se concatenará y se almacenará en el encabezado celda del rango. Es la celda superior izquierda del rango cuando la dirección del contenido es de izquierda a derecha; de lo contrario, es la celda superior derecha del rango. Si el rango no es rectangular (lo que puede ocurrir en algunos casos en los que el rango abarca celdas que ya están combinadas o la tabla no es rectangular), se muestra un error de solicitud incorrecta 400. |
UnmergeTableCellsRequest
Separa las celdas en una
Table
Representación JSON |
---|
{
"tableRange": {
object (
|
Campos | |
---|---|
tableRange
|
El rango de la tabla que especifica qué celdas de la tabla se separarán. Se separarán todas las celdas combinadas en este rango, pero las celdas que ya no se combinaron no se verán afectadas. Si el rango no tiene celdas combinadas, la solicitud no hará nada. Si hay texto en alguna de las celdas combinadas, el texto permanecerá en el encabezado. del bloque resultante de celdas separadas. La "cabeza" es la celda superior izquierda cuando la dirección del contenido es de izquierda a derecha; de lo contrario, la esquina superior derecha. |
CreateHeaderRequest
Crea un
Header
El nuevo encabezado se aplica al
SectionStyle
en la ubicación del
SectionBreak
si se especifica; de lo contrario, se aplica
DocumentStyle
Si ya existe un encabezado del tipo especificado, se muestra un error 400 de solicitud incorrecta.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type
|
El tipo de encabezado que se creará. |
sectionBreakLocation
|
La ubicación de la
|
CreateFootnoteRequest
Crea un
Footnote
segmento e inserta un nuevo
FootnoteReference
hacia él en la ubicación dada.
La nueva herramienta
Footnote
segmento contendrá un espacio seguido de un carácter de línea nueva.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
footnote_reference_location Es la ubicación en la que se insertará la referencia de la nota al pie.
footnote_reference_location
solo puede ser una de las siguientes opciones:
|
|
location
|
Inserta la referencia de la nota al pie en un índice específico del documento.
La referencia de la nota al pie debe insertarse dentro de los límites de un
Las referencias de notas al pie no se pueden insertar dentro de una ecuación, un encabezado, un pie de página o una nota al pie. Dado que las referencias de notas al pie solo se pueden insertar en el cuerpo,
|
endOfSegmentLocation
|
Inserta la referencia de la nota al pie al final del cuerpo del documento.
Las referencias de nota al pie no se pueden insertar dentro de un encabezado, un pie de página ni una nota al pie. Dado que las referencias de notas al pie solo se pueden insertar en el cuerpo,
|
ReplaceNamedRangeContentRequest
Reemplaza el contenido del elemento especificado
NamedRange
o
NamedRanges
con el contenido de reemplazo proporcionado.
Ten en cuenta que una persona
NamedRange
puede consistir de varias disconformidad
ranges
En este caso, solo se reemplazará el contenido del primer rango. Se borrarán los otros rangos y su contenido.
En los casos en que reemplazar o borrar cualquier rango da como resultado una estructura de documento no válida, se devuelve un error 400 de solicitud incorrecta.
Representación JSON |
---|
{ "tabsCriteria": { object ( |
Campos | |
---|---|
tabsCriteria
|
Opcional. Los criterios que se usan para especificar en qué pestañas se realiza el reemplazo. Si se omite, el reemplazo se aplica a todas las pestañas. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
Campo de unión
replacement_content El contenido con el que se reemplazará el contenido existente del rango con nombre.
replacement_content
solo puede ser una de las siguientes opciones:
|
|
text
|
Reemplaza el contenido de los rangos con nombre especificados por el texto dado. |
Campo de unión
named_range_reference Una referencia a los rangos con nombre cuyo contenido se reemplazará.
named_range_reference
solo puede ser una de las siguientes opciones:
|
|
namedRangeId
|
El ID del rango con nombre cuyo contenido se reemplazará. Si no hay un rango con nombre con el ID proporcionado, se muestra un error 400 de solicitud incorrecta. |
namedRangeName
|
El nombre del
Si hay varios
|
UpdateSectionStyleRequest
Actualiza el
SectionStyle
Representación JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
El rango que se superpone a las secciones para aplicar diseño.
Como los saltos de sección solo se pueden insertar dentro del cuerpo,
|
sectionStyle
|
Los estilos que se configurarán en la sección.
Algunos cambios en el estilo de la sección pueden provocar otras modificaciones para reflejar el comportamiento del editor de Documentos. Consulta la documentación de
|
fields
|
Los campos que se deben actualizar.
Se debe especificar al menos un campo. La raíz
Por ejemplo, para actualizar el margen izquierdo, establece
|
InsertSectionBreakRequest
Inserta un salto de sección en la ubicación determinada.
Se insertará un carácter de línea nueva antes del salto de sección.
Representación JSON |
---|
{ "sectionType": enum ( |
Campos | |
---|---|
sectionType
|
El tipo de sección a insertar. |
Campo de unión
insertion_location La ubicación en la que se insertará la pausa.
insertion_location
solo puede ser una de las siguientes opciones:
|
|
location
|
Inserta un salto de línea y un salto de sección en un índice específico del documento.
El salto de sección debe insertarse dentro de los límites de un
No se pueden insertar saltos de sección en una tabla, ecuación, nota al pie, encabezado ni pie de página. Como los saltos de sección solo se pueden insertar dentro del cuerpo,
|
endOfSegmentLocation
|
Inserta un salto de línea y un salto de sección al final del cuerpo del documento.
No se pueden insertar saltos de sección en una nota al pie, un encabezado ni un pie de página. Como los saltos de sección solo se pueden insertar dentro del cuerpo,
|
DeleteHeaderRequest
Borra un
Header
del documento.
Representación JSON |
---|
{ "headerId": string, "tabId": string } |
Campos | |
---|---|
headerId
|
El ID del encabezado que se borrará. Si este encabezado se define en
|
tabId
|
La pestaña que contiene el encabezado que se borrará. Cuando se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
PinTableHeaderRowsRequest
Actualiza la cantidad de filas de encabezado fijadas en una tabla.
Representación JSON |
---|
{
"tableStartLocation": {
object (
|
Campos | |
---|---|
tableStartLocation
|
La ubicación donde comienza la tabla en el documento. |
pinnedHeaderRowsCount
|
La cantidad de filas de la tabla que se fijarán, donde 0 implica que todas las filas no están fijadas. |