Requests

Solicitud

Es una sola actualización que se aplica a un documento.

Representación JSON
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
Campos
Campo de unión request. Es la solicitud específica que se debe aplicar. Se requiere exactamente un campo. request puede ser solo una de las siguientes opciones:
replaceAllText

object (ReplaceAllTextRequest)

Reemplaza todas las instancias del texto especificado.

insertText

object (InsertTextRequest)

Inserta texto en la ubicación especificada.

updateTextStyle

object (UpdateTextStyleRequest)

Actualiza el estilo de texto del rango especificado.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Crea viñetas para los párrafos.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Borra las viñetas de los párrafos.

createNamedRange

object (CreateNamedRangeRequest)

Crea un rango con nombre.

deleteNamedRange

object (DeleteNamedRangeRequest)

Borra un rango con nombre.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Actualiza el estilo de párrafo en el rango especificado.

deleteContentRange

object (DeleteContentRangeRequest)

Borra el contenido del documento.

insertInlineImage

object (InsertInlineImageRequest)

Inserta una imagen intercalada en la ubicación especificada.

insertTable

object (InsertTableRequest)

Inserta una tabla en la ubicación especificada.

insertTableRow

object (InsertTableRowRequest)

Inserta una fila vacía en una tabla.

insertTableColumn

object (InsertTableColumnRequest)

Inserta una columna vacía en una tabla.

deleteTableRow

object (DeleteTableRowRequest)

Borra una fila de una tabla.

deleteTableColumn

object (DeleteTableColumnRequest)

Borra una columna de una tabla.

insertPageBreak

object (InsertPageBreakRequest)

Inserta un salto de página en la ubicación especificada.

deletePositionedObject

object (DeletePositionedObjectRequest)

Borra un objeto posicionado del documento.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Actualiza las propiedades de las columnas en una tabla.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Actualiza el estilo de las celdas de la tabla.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Actualiza el estilo de la fila en una tabla.

replaceImage

object (ReplaceImageRequest)

Reemplaza una imagen en el documento.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Actualiza el estilo del documento.

mergeTableCells

object (MergeTableCellsRequest)

Combina celdas en una tabla.

unmergeTableCells

object (UnmergeTableCellsRequest)

Separa las celdas de una tabla.

createHeader

object (CreateHeaderRequest)

Crea un encabezado.

createFootnote

object (CreateFootnoteRequest)

Crea una nota al pie.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Reemplaza el contenido en un rango con nombre.

updateSectionStyle

object (UpdateSectionStyleRequest)

Actualiza el estilo de la sección del rango especificado.

insertSectionBreak

object (InsertSectionBreakRequest)

Inserta un salto de sección en la ubicación especificada.

deleteHeader

object (DeleteHeaderRequest)

Borra un encabezado del documento.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Actualiza la cantidad de filas de encabezado fijadas en una tabla.

ReemplazarAllRequestRequest

Reemplaza todas las instancias de texto que coincidan con un criterio por replace text.

Representación JSON
{
  "replaceText": string,

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Campos
replaceText

string

El texto que reemplazará al texto coincidente.

Campo de unión criteria. Los criterios que se usan para hacer coincidir el texto que se reemplazará. criteria puede ser solo una de las siguientes opciones:
containsText

object (SubstringMatchCriteria)

Busca texto en el documento que coincida con esta substring.

SubstringMatchCriterios

Es un criterio que coincide con una string de texto específica del documento.

Representación JSON
{
  "text": string,
  "matchCase": boolean
}
Campos
text

string

El texto que se debe buscar en el documento.

matchCase

boolean

Indica si la búsqueda debe respetar el uso de mayúsculas y minúsculas:

  • True: La búsqueda distingue mayúsculas de minúsculas.
  • False: La búsqueda no distingue mayúsculas de minúsculas.

InsertTextRequest

Inserta texto en la ubicación especificada.

Representación JSON
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
text

string

El texto que se insertará.

La inserción de un carácter de nueva línea creará implícitamente una Paragraph nueva en ese índice. El estilo de párrafo del párrafo nuevo se copiará del párrafo del índice de inserción actual, incluidas listas y viñetas.

Los estilos de texto insertado se determinarán automáticamente y, por lo general, se preservará 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 de la zona de uso privado del plano multilingüe Unicode básico (U+E000-U+F8FF) se quitarán del texto insertado.

Campo de unión insertion_location. La ubicación donde se insertará el texto. insertion_location puede ser solo una de las siguientes opciones:
location

object (Location)

Inserta el texto en un índice específico del documento.

El texto debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar texto en el índice de inicio de una tabla (es decir, entre la tabla y su párrafo anterior). El texto debe insertarse en el párrafo anterior.

endOfSegmentLocation

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

Es una ubicación específica del documento.

Representación JSON
{
  "segmentId": string,
  "index": integer
}
Campos
segmentId

string

El ID del encabezado, del pie de página o del pie de página de la ubicación. Un ID de segmento vacío indica el cuerpo del documento.

index

integer

El índice basado en cero, en unidades de código UTF-16.

El índice está relacionado con el comienzo del segmento especificado por segmentId.

Ubicación de finalización del segmento

Ubicación al final de un cuerpo, un encabezado, un pie de página o una nota al pie. La ubicación se encuentra inmediatamente antes de la última línea nueva del segmento del documento.

Representación JSON
{
  "segmentId": string
}
Campos
segmentId

string

El ID del encabezado, del pie de página o del pie de página de la ubicación. Un ID de segmento vacío indica el cuerpo del documento.

UpdateTextStyleRequest

Actualiza el estilo del texto.

Representación JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
textStyle

object (TextStyle)

Los estilos que se establecerán en el texto.

Si el valor de un estilo en particular coincide con el del estilo superior, se configurará ese estilo para heredarlo.

Algunos cambios de estilo de texto pueden hacer que se produzcan otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de TextStyle para obtener más información.

fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz textStyle está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar el estilo de texto a negrita, establece fields en "bold".

Para restablecer una propiedad a su valor predeterminado, incluya el nombre del campo en la máscara de campo, pero déjelo sin configurar.

Campo de unión insertion_location. Es el tipo de rango que se usa en el que se actualizará el estilo de texto. insertion_location puede ser solo una de las siguientes opciones:
range

object (Range)

El rango de texto al estilo.

El rango se puede extender para incluir saltos de línea adyacentes.

Si el rango contiene completamente 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.

Solicitud CreateBugraphBullets

Crea viñetas para todos los párrafos que se superponen con el rango especificado.

Para determinar el nivel de anidamiento de cada párrafo, se contarán las pestañas iniciales que estén delante de cada uno. Para evitar el exceso de espacio entre la viñeta y el párrafo correspondiente, se quitan estas pestañas principales de esta solicitud. Esto puede cambiar los índices de las partes del texto.

Si el párrafo inmediatamente anterior a los párrafos que se actualizan está en una lista con un ajuste predeterminado coincidente, los párrafos que se actualizan se agregan a esa lista.

Representación JSON
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Campos
range

object (Range)

Rango en el que se aplicará el ajuste predeterminado de viñeta.

bulletPreset

enum (BulletGlyphPreset)

Los tipos de glifos de viñetas que se usarán.

Ajuste predeterminado de viñetas de viñetas

Patrones predeterminados de glifos de viñetas para listas

Estos patrones usan estos tipos de viñetas:

  • ARROW : Una flecha, que corresponde a un punto de código Unicode U+2794
  • ARROW3D : Una flecha con sombreado 3D, que corresponde a un punto de código Unicode U+27a2
  • CHECKBOX: Un cuadrado vacío, que corresponde a un punto de código U+274f de Unicode
  • CIRCLE: Un círculo hueco, que corresponde a un punto de código U+25cb de Unicode
  • DIAMOND: Un 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: Un diamante vacío, que corresponde a un punto de código U+25c7 de Unicode.
  • DISC: Un círculo sólido que corresponde a un punto de código U+25cf de Unicode
  • SQUARE: Es un cuadrado sólido, que corresponde a un punto de código Unicode U+25a0.
  • STAR: Una estrella, 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: Un número en el que los números de un solo dígito tienen el prefijo cero, como “01”, “02” o “03”. Los números que tengan más de un dígito no tendrán 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 U+25c4 de Unicode
Enumeradores
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 glifo de viñeta de DISC, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de listas.
BULLET_DIAMONDX_ARROW3D_SQUARE Una lista con viñetas con un glifo de viñeta de DIAMONDX, ARROW3D y SQUARE para los primeros 3 niveles de anidamiento de listas.
BULLET_CHECKBOX Una lista con viñetas con CHECKBOX glifos de viñetas para todos los niveles de anidación de la lista.
BULLET_ARROW_DIAMOND_DISC Una lista con viñetas con un glifo de viñeta de ARROW, DIAMOND y DISC para los primeros 3 niveles de anidamiento de listas.
BULLET_STAR_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta de STAR, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de listas.
BULLET_ARROW3D_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta de ARROW3D, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de listas.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Una lista con viñetas con un glifo de viñeta de LEFTTRIANGLE, DIAMOND y DISC para los primeros 3 niveles de anidamiento de listas.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Una lista con viñetas con un glifo de viñeta de DIAMONDX, HOLLOWDIAMOND y SQUARE para los primeros 3 niveles de anidamiento de listas.
BULLET_DIAMOND_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta de DIAMOND, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de listas.
NUMBERED_DECIMAL_ALPHA_ROMAN Una lista numerada con DECIMAL, ALPHA y ROMAN glifos numéricos para los primeros 3 niveles de anidamiento, seguidos de puntos.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Una lista numerada con glifos numéricos DECIMAL, ALPHA y ROMAN para los primeros 3 niveles de anidamiento, seguidos de paréntesis.
NUMBERED_DECIMAL_NESTED Una lista numerada con glifos numéricos DECIMAL separados por puntos, en la 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, 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, 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, seguidos de puntos.

DeleteParagraphBulletsRequest

Borra las viñetas de todos los párrafos que se superponen con el rango dado.

El nivel de anidamiento de cada párrafo se conservará visualmente agregando sangría al comienzo del párrafo correspondiente.

Representación JSON
{
  "range": {
    object (Range)
  }
}
Campos
range

object (Range)

El rango del que se borrarán las viñetas.

CreateNamedRangeRequest

Crea un NamedRange que hace referencia al rango dado.

Representación JSON
{
  "name": string,
  "range": {
    object (Range)
  }
}
Campos
name

string

El nombre de 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

object (Range)

El rango al que se aplica el nombre.

DeleteNamedRangeRequest

Borra un NamedRange.

Representación JSON
{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Campos
Campo de unión named_range_reference. El valor que determina el rango o los rangos que se borrarán. Se debe establecer exactamente uno. named_range_reference puede ser solo una de las siguientes opciones:
namedRangeId

string

El ID del rango con nombre que se borrará.

name

string

El nombre de los rangos que se borrarán. Se borrarán todos los rangos con nombre asignado.

UpdateParagraphStyleRequest

Actualizar el estilo de todos los párrafos que se superpongan con el rango especificado

Representación JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
paragraphStyle

object (ParagraphStyle)

Los estilos que se establecerán en los párrafos.

Es posible que ciertos cambios en el estilo de párrafo provoquen otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de ParagraphStyle para obtener más información.

fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz paragraphStyle está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar la propiedad de alineación del estilo de párrafo, establece fields en "alignment".

Para restablecer una propiedad a su valor predeterminado, incluya el nombre del campo en la máscara de campo, pero déjelo sin configurar.

Campo de unión insertion_location. Es el tipo de rango que se usa para la actualización del estilo de párrafo. insertion_location puede ser solo una de las siguientes opciones:
range

object (Range)

Rango que superpone los párrafos al estilo.

DeleteContentRangeRequest

Borra el contenido del documento.

Representación JSON
{
  "range": {
    object (Range)
  }
}
Campos
range

object (Range)

Es la variedad de contenido que se borrará.

Si borras texto que cruza el límite de un párrafo, podrían producirse cambios en los estilos, las listas, los objetos posicionados y los favoritos de los párrafos a medida que se combinen los dos.

Si intentas borrar ciertos rangos, es posible que la estructura del documento no sea válida, en cuyo caso se mostrará un error 400 de solicitud incorrecta.

Estos son algunos ejemplos de solicitudes de eliminación no válidas:

InsertInLineImageRequest

Inserta un InlineObject que contiene una imagen en la ubicación determinada.

Representación JSON
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
uri

string

El URI de la imagen.

La imagen se recupera una vez en el momento de la inserción y se almacena una copia para mostrar dentro del documento. Las imágenes deben tener un tamaño inferior a 50 MB, no pueden superar los 25 megapíxeles y estar en formato PNG, JPEG o GIF.

El URI proporcionado debe ser de acceso público y no superar los 2 KB. El URI se guarda con la imagen y se expone a través del campo ImageProperties.content_uri.

objectSize

object (Size)

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 se determina según las siguientes reglas: * Si no se especifica el ancho y la altura, el tamaño predeterminado de la imagen se calcula en función de su resolución. * Si se especifica una dimensión, se calcula la otra para conservar la relación de aspecto de la imagen. * Si se especifican tanto el ancho como la altura, la imagen se ajusta para que se ajuste a las dimensiones proporcionadas y, a la vez, mantener su relación de aspecto.

Campo de unión insertion_location. La ubicación en la que se insertará la imagen. insertion_location puede ser solo una de las siguientes opciones:
location

object (Location)

Inserta la imagen en un índice específico del documento.

La imagen debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y su párrafo anterior).

Las imágenes intercaladas no se pueden insertar dentro de una nota al pie ni de ecuación.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta el texto al final de un encabezado, un pie de página o el cuerpo del documento.

Las imágenes intercaladas no se pueden insertar dentro de una nota al pie.

InsertarTablaRequest

Inserta una tabla en la ubicación especificada.

Se insertará un carácter de salto de línea antes de la tabla insertada.

Representación JSON
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
rows

integer

La cantidad de filas en la tabla.

columns

integer

La cantidad de columnas en la tabla.

Campo de unión insertion_location. La ubicación en la que se insertará la tabla. insertion_location puede ser solo una de las siguientes opciones:
location

object (Location)

Inserta la tabla en un índice del modelo específico.

Se insertará un carácter de nueva línea 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 una Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre una tabla existente y su párrafo anterior).

No se pueden insertar tablas dentro de una nota al pie o de una ecuación.

endOfSegmentLocation

object (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 salto de línea antes de la tabla insertada.

No se pueden insertar tablas dentro de una nota al pie.

InsertarFilaRequestRequest

Inserta una fila vacía en una tabla.

Representación JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Campos
tableCellLocation

object (TableCellLocation)

La ubicación de celda de la tabla de referencia desde la que se insertarán las filas.

Se insertará una fila nueva arriba (o debajo) de la fila en la que se encuentra la celda de referencia. Si la celda de referencia es una celda combinada, se insertará una fila nueva arriba (o debajo) de la celda combinada.

insertBelow

boolean

Indica si se debe insertar una fila nueva debajo de la ubicación de la celda de referencia.

  • True : Inserte debajo de la celda.
  • False: Inserte arriba de la celda.

Ubicación de la celda de la tabla

Ubicación de una sola celda dentro de una tabla.

Representación JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Campos
tableStartLocation

object (Location)

La ubicación en la que comienza la tabla en el documento.

rowIndex

integer

El índice de fila basado en cero. Por ejemplo, la segunda fila de la tabla tiene un índice de fila de 1.

columnIndex

integer

El índice de columna basado en cero. Por ejemplo, la segunda columna de la tabla tiene un índice de columna de 1.

InsertarTablaColumnaRequest

Inserta una columna vacía en una tabla.

Representación JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Campos
tableCellLocation

object (TableCellLocation)

La ubicación de celda de la tabla de referencia desde la que se insertarán las columnas.

Se insertará una columna nueva a la izquierda (o derecha) en la que se encuentra la celda de referencia. Si la celda de referencia es una celda combinada, se insertará una columna nueva a la izquierda (o a la derecha) de la celda combinada.

insertRight

boolean

Indica si se debe insertar una columna nueva a la derecha de la ubicación de la celda de referencia.

  • True : Inserte a la derecha.
  • False: Inserte a la izquierda.

DeleteTableRowRequest

Borra una fila de una tabla.

Representación JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableCellLocation

object (TableCellLocation)

La ubicación de celda de la tabla de referencia de la que se borrará la fila.

Se borrará la fila que abarca esta celda. Si esta es una celda combinada que abarca varias filas, se borrarán todas las filas de ese intervalo. 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 (TableCellLocation)
  }
}
Campos
tableCellLocation

object (TableCellLocation)

La ubicación de celda de la tabla de referencia de la que se borrará la columna.

Se borrará la columna que abarca esta celda. Si esta es una celda combinada que abarca varias columnas, se borrarán todas las columnas que abarca. 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 un salto de línea en la ubicación especificada.

Representación JSON
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
Campo de unión insertion_location. Es la ubicación donde se insertará el salto de página. insertion_location puede ser solo una de las siguientes opciones:
location

object (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 Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y su párrafo anterior).

Los saltos de página no se pueden insertar dentro de una tabla, una ecuación, una nota al pie, un encabezado o un pie de página. Como los saltos de página solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta el salto de página al final del cuerpo del documento.

No se pueden insertar saltos de página dentro de una nota al pie, un encabezado ni un pie de página. Como los saltos de página solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

DeletePositionedObjectRequest

Borra un PositionedObject del documento.

Representación JSON
{
  "objectId": string
}
Campos
objectId

string

El ID del objeto posicionado que se borrará.

UpdateTableColumnPropertiesRequest

Actualiza el TableColumnProperties de las columnas de una tabla.

Representación JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Campos
tableStartLocation

object (Location)

La ubicación en la que comienza la tabla en el documento.

columnIndices[]

integer

La lista de índices de columna basados en cero cuya propiedad debe actualizarse. Si no se especifican índices, se actualizarán todas las columnas.

tableColumnProperties

object (TableColumnProperties)

Las propiedades de la columna de la tabla que se actualizarán.

Si el valor de tableColumnProperties#width es inferior a 5 puntos (5/72 pulgadas), se muestra un error de solicitud incorrecta 400.

fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tableColumnProperties está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar el ancho de la columna, establece fields en "width".

UpdateTableCellStyleRequest

Actualiza el estilo de un rango de celdas de la tabla.

Representación JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Campos
tableCellStyle

object (TableCellStyle)

El estilo que se establece en las celdas de la tabla.

Cuando se actualizan los bordes, si una celda comparte un borde con una celda adyacente, también se actualiza la propiedad de borde correspondiente de la celda adyacente. No se actualizan los bordes que se combinan y que son invisibles.

Dado que actualizar un borde compartido por celdas adyacentes en la misma solicitud puede provocar actualizaciones conflictivas en el borde, estas se aplican en el siguiente orden:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tableCellStyle está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar el color de fondo de las celdas de la tabla, establece fields en "backgroundColor".

Para restablecer una propiedad a su valor predeterminado, incluya el nombre del campo en la máscara de campo, pero déjelo sin configurar.

Campo de unión cells. Las celdas que se actualizarán. cells puede ser solo una de las siguientes opciones:
tableRange

object (TableRange)

El rango de la tabla que representa el subconjunto de la tabla a la que se aplican las actualizaciones.

tableStartLocation

object (Location)

La ubicación en la que comienza la tabla en el documento. Cuando se especifica, se aplican las actualizaciones a todas las celdas de la tabla.

Rango de la tabla

Un rango de 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, supongamos que tenemos una tabla de 3 x 3 en la que se combinan todas las celdas de la última fila. La tabla se ve de la siguiente manera:

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Un rango de tabla con la ubicación de celda de la tabla = (tableStartLocation, row = 0, column = 0), el intervalo de filas = 3 y el intervalo de columnas = 2 especifican las siguientes celdas:

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Representación JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Campos
tableCellLocation

object (TableCellLocation)

La ubicación de la celda donde comienza el rango de la tabla.

rowSpan

integer

El intervalo de filas del rango de tablas

columnSpan

integer

El intervalo de columnas del rango de la tabla

UpdateTableRowStyleRequest

Actualiza el TableRowStyle de las filas de una tabla.

Representación JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Campos
tableStartLocation

object (Location)

La ubicación en la que comienza la tabla en el documento.

rowIndices[]

integer

Es la 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

object (TableRowStyle)

Los estilos que se establecerán en las filas.

fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tableRowStyle está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar la altura mínima de la fila, establece fields en "minRowHeight".

Reemplazar imagen de solicitud

Reemplaza una imagen existente por una nueva.

Reemplazar una imagen quita algunos image effects de la imagen existente para que refleje el comportamiento del editor de Documentos.

Representación JSON
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}
Campos
imageObjectId

string

El ID de la imagen existente que se reemplazará. El ID se puede recuperar a partir de la respuesta de una solicitud get.

uri

string

Es 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 mostrar dentro del documento. Las imágenes deben ser inferiores a 50 MB, no pueden superar los 25 megapíxeles y deben estar en formato PNG, JPEG o GIF.

El URI que se proporcionó no puede superar los 2 KB de longitud. El URI se guarda con la imagen y se expone a través del campo ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Es el método de reemplazo.

Método de imagen de reemplazo

Método de reemplazo de imagen.

Enumeradores
IMAGE_REPLACE_METHOD_UNSPECIFIED Método de reemplazo de imagen no especificado. No se debe usar este valor.
CENTER_CROP Ajusta y centra la imagen para completar los límites de la imagen original. Es posible que la imagen se recorte para completar 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 archivo DocumentStyle.

Representación JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}
Campos
documentStyle

object (DocumentStyle)

Los estilos que se establecerán en el documento.

Es posible que ciertos cambios en el estilo de documento provoquen otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de DocumentStyle para obtener más información.

fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz documentStyle está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar el fondo, establece fields en "background".

Solicitud de MergeTableCells

Combina celdas en un objeto Table.

Representación JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Campos
tableRange

object (TableRange)

El rango de la tabla que especifica qué celdas de la tabla se combinan.

El texto de las celdas que se combinen se concatenará y se almacenará en la celda "head" del rango. Esta es la celda superior izquierda del rango cuando la dirección del contenido es de izquierda a derecha y, de lo contrario, la celda superior derecha del rango.

Si el rango no es rectangular (lo que puede suceder en algunos casos en los que cubre celdas que ya están combinadas o en las que la tabla no es rectangular), se muestra un error 400 de solicitud incorrecta.

Solicitud de combinación de celdas

Separa las celdas de Table.

Representación JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Campos
tableRange

object (TableRange)

El rango de la tabla que especifica qué celdas de la tabla se separarán.

Se separarán todas las celdas combinadas de este rango, y las celdas que ya estén combinadas 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, este permanecerá en la celda "principal" del bloque resultante de celdas separadas. La celda "principal" es la celda superior izquierda cuando la dirección del contenido es de izquierda a derecha y, de lo contrario, la superior derecha.

CreateHeaderRequest

Crea un Header. El encabezado nuevo se aplica a SectionStyle en la ubicación de SectionBreak si se especifica; de lo contrario, se aplica a DocumentStyle.

Si ya existe un encabezado del tipo especificado, se muestra un error de solicitud incorrecta 400.

Representación JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

Es el tipo de encabezado que se creará.

sectionBreakLocation

object (Location)

Es la ubicación de SectionBreak, que comienza a la sección a la que debe pertenecer este encabezado. Si no se configura `sectionBreakLocation' o si hace referencia al primer salto de sección en el cuerpo del documento, el encabezado se aplica al DocumentStyle

Tipo de pie de página del encabezado

Los tipos de encabezados y pies de página que se pueden crear.

Enumeradores
DEFAULT Un encabezado o pie de página predeterminado

CreatefooterRequest

Crea un Footer. El nuevo pie de página se aplica a SectionStyle en la ubicación de SectionBreak, si se especifica; de lo contrario, se aplica a DocumentStyle.

Si ya existe un pie de página del tipo especificado, se muestra un error 400 de solicitud incorrecta.

Representación JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

Es el tipo de pie de página que se creará.

sectionBreakLocation

object (Location)

La ubicación del SectionBreak inmediatamente anterior a la sección a la que debe pertenecer SectionStyle este pie de página. Si no está configurado o se refiere al primer salto de sección del documento, el pie de página se aplica al estilo de documento.

CreateFootnoteRequest

Crea un segmento Footnote y le inserta un nuevo FootnoteReference en la ubicación determinada.

El nuevo segmento Footnote contendrá un espacio seguido de un carácter de salto de línea.

Representación JSON
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Campos
Campo de unión footnote_reference_location. La ubicación en la que se insertará la referencia de la nota al pie. footnote_reference_location puede ser solo una de las siguientes opciones:
location

object (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 Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y su párrafo anterior).

Las referencias al pie de página no se pueden insertar dentro de una ecuación, un encabezado, un pie de página o una nota al pie. Como las referencias de pie de página solo se pueden insertar en el cuerpo, el campo segment ID debe estar vacío.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta la referencia de la nota al pie al final del cuerpo del documento.

No se pueden insertar referencias al pie de página dentro de un encabezado, un pie de página ni una nota al pie. Como las referencias de pie de página solo se pueden insertar en el cuerpo, el campo segment ID debe estar vacío.

Reemplazar NombreDRangeContentRequest

Reemplaza el contenido del NamedRange o NamedRanges especificado con el contenido de reemplazo determinado.

Ten en cuenta que un NamedRange individual puede consistir en varios ranges no continuos. 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 el reemplazo o la eliminación de cualquier rango generaría una estructura de documento no válida, se muestra un error de solicitud incorrecta 400.

Representación JSON
{

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Campos
Campo de unión replacement_content. El contenido por el que se reemplazará el contenido existente por el rango con nombre. replacement_content puede ser solo una de las siguientes opciones:
text

string

Reemplaza el contenido de los rangos con nombre especificados con el texto dado.

Campo de unión named_range_reference. Una referencia a los rangos con nombre cuyo contenido se reemplazará. named_range_reference puede ser solo una de las siguientes opciones:
namedRangeId

string

El ID del rango con nombre cuyo contenido se reemplazará.

Si no hay un rango con nombre con el ID determinado, se muestra un error de solicitud incorrecta 400.

namedRangeName

string

El nombre del NamedRanges cuyo contenido se reemplazará.

Si hay varios named ranges con el nombre determinado, se reemplazará el contenido de cada uno. Si no hay rangos con nombre con el nombre determinado, la solicitud será no-op.

UpdateSectionStyleRequest

Actualiza el archivo SectionStyle.

Representación JSON
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Campos
range

object (Range)

Rango que superpone las secciones al estilo.

Debido a que los saltos de sección solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

sectionStyle

object (SectionStyle)

Los estilos que se establecerán en la sección.

Algunos cambios de estilo de la sección pueden provocar otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de SectionStyle para obtener más información.

fields

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz sectionStyle está implícita y no se debe especificar. Se puede usar una sola "*" como versión abreviada para enumerar cada campo.

Por ejemplo, para actualizar el margen izquierdo, establece fields en "marginLeft".

InsertSectionBreakRequest

Inserta un salto de sección en la ubicación determinada.

Se insertará un carácter de salto de línea antes del salto de sección.

Representación JSON
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
sectionType

enum (SectionType)

El tipo de sección que se insertará.

Campo de unión insertion_location. La ubicación en la que se insertará la pausa. insertion_location puede ser solo una de las siguientes opciones:
location

object (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 Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y su párrafo anterior).

Los saltos de sección no se pueden insertar dentro de una tabla, una ecuación, una nota al pie, un encabezado o un pie de página. Como los saltos de sección solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

endOfSegmentLocation

object (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 dentro de una nota al pie, un encabezado ni un pie de página. Debido a que los saltos de sección solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

DeleteHeaderRequest

Borra un Header del documento.

Representación JSON
{
  "headerId": string
}
Campos
headerId

string

Es el ID del encabezado que se borrará. Si este encabezado se define en DocumentStyle, se quita su referencia y, como resultado, no se genera ningún encabezado de ese tipo en la primera sección del documento. Si este encabezado se define en un SectionStyle, se quita su referencia y el encabezado de ese tipo continúa de la sección anterior.

DeletepieRequest

Borra un Footer del documento.

Representación JSON
{
  "footerId": string
}
Campos
footerId

string

El ID del pie de página que se borrará. Si este pie de página se define en DocumentStyle, se quitará la referencia a este y no habrá un pie de página de ese tipo para la primera sección del documento. Si este pie de página se define en un SectionStyle, se quita la referencia a este y el pie de página de ese tipo continúa desde la sección anterior.

Solicitud de tablaPinHeaderRows

Actualiza la cantidad de filas fijadas del encabezado de tabla en una tabla.

Representación JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Campos
tableStartLocation

object (Location)

La ubicación en la que comienza la tabla en el documento.

pinnedHeaderRowsCount

integer

La cantidad de filas de la tabla que se fijarán, donde 0 implica que todas las filas no están fijadas.