- Recurso: Documento
- Tabulación
- TabProperties
- DocumentTab
- Cuerpo
- StructuralElement
- Párrafo
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Color
- RgbColor
- Dimensión
- Unidad
- WeightedFontFamily
- BaselineOffset
- Vínculo
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Tipo
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Ecuación
- InlineObjectElement
- Persona
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- Alineación
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- Sombreado
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Viñeta
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Tabla
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- Encabezado
- Pie de página
- Nota al pie
- DocumentStyle
- Información general
- Tamaño
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Lista
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Rango
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- Propiedades de imágenes
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- Métodos
Recurso: Documento
Un documento de Documentos de Google.
Representación JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
Campos | |
---|---|
documentId |
Solo salida. Es el ID del documento. |
title |
Es el título del documento. |
tabs[] |
Pestañas que forman parte de un documento. Las pestañas pueden contener pestañas secundarias, una pestaña anidada dentro de otra pestaña. Las pestañas secundarias se representan con el campo |
revisionId |
Solo salida. Es el ID de revisión del documento. Se puede utilizar en solicitudes de actualización para especificar a qué revisión de un documento se deben aplicar las actualizaciones y cómo debe comportarse la solicitud si el documento se editó desde esa revisión. Solo se completa si el usuario tiene acceso de edición al documento. El ID de revisión no es un número secuencial, sino una cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Si se muestra un ID de revisión, solo se garantiza su validez durante 24 horas, y no se puede compartir con los usuarios. Si el ID de revisión no se cambia entre llamadas, el documento no cambió. En cambio, un ID modificado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un ID modificado también puede deberse a factores internos, como modificaciones en el formato del ID. |
suggestionsViewMode |
Solo salida. Es el modo de vista de sugerencias que se aplica al documento. Nota: Cuando edites un documento, los cambios deben basarse en un documento con |
body |
Solo salida. Es el cuerpo principal del documento. Campo heredado: En su lugar, usa |
headers |
Solo salida. Los encabezados del documento, con el ID de encabezado de clave. Campo heredado: En su lugar, usa |
footers |
Solo salida. Los pies de página del documento, escritos por ID de pie de página Campo heredado: En su lugar, usa |
footnotes |
Solo salida. Las notas al pie del documento, escritas por el ID de la nota al pie Campo heredado: En su lugar, usa |
documentStyle |
Solo salida. Es el estilo del documento. Campo heredado: En su lugar, usa |
suggestedDocumentStyleChanges |
Solo salida. Los cambios sugeridos para el estilo del documento, codificados por ID de sugerencia. Campo heredado: En su lugar, usa |
namedStyles |
Solo salida. Son los estilos con nombre del documento. Campo heredado: En su lugar, usa |
suggestedNamedStylesChanges |
Solo salida. Los cambios sugeridos para los estilos con nombre del documento, vinculados por ID de sugerencia. Campo heredado: En su lugar, usa |
lists |
Solo salida. Las listas del documento, con el ID de lista como clave. Campo heredado: En su lugar, usa |
namedRanges |
Solo salida. Los rangos con nombre en el documento, con clave por nombre. Campo heredado: En su lugar, usa |
inlineObjects |
Solo salida. Los objetos intercalados en el documento, con clave por ID de objeto. Campo heredado: En su lugar, usa |
positionedObjects |
Solo salida. Los objetos posicionados en el documento, con clave por ID de objeto. Campo heredado: En su lugar, usa |
Tab
Una pestaña en un documento.
Representación JSON |
---|
{ "tabProperties": { object ( |
Campos | |
---|---|
tabProperties |
Las propiedades de la pestaña, como el ID y el título |
childTabs[] |
Las pestañas secundarias anidadas dentro de esta pestaña. |
Campo de unión content . El contenido de la pestaña Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
documentTab |
Una pestaña con contenido de documentos, como imágenes y texto |
TabProperties
Propiedades de una pestaña
Representación JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
Campos | |
---|---|
tabId |
Solo salida. El ID de la pestaña. No se puede modificar este campo. |
title |
Es el nombre de la pestaña que se muestra al usuario. |
parentTabId |
Opcional. El ID de la pestaña superior. Está vacía cuando la pestaña actual es una pestaña de nivel raíz, lo que significa que no tiene ninguna superior. |
index |
El índice basado en cero de la pestaña dentro del elemento superior. |
nestingLevel |
Solo salida. La profundidad de la pestaña dentro del documento. Las pestañas de nivel de raíz comienzan en 0. |
DocumentTab
Una pestaña con el contenido del documento.
Representación JSON |
---|
{ "body": { object ( |
Campos | |
---|---|
body |
Cuerpo principal de la pestaña del documento. |
headers |
Los encabezados de la pestaña del documento, con el ID del encabezado como clave. |
footers |
Los pies de página en la pestaña del documento, escritos por el ID del pie de página. |
footnotes |
Las notas al pie en la pestaña del documento, codificadas por el ID de la nota al pie |
documentStyle |
El estilo de la pestaña del documento. |
suggestedDocumentStyleChanges |
Los cambios sugeridos para el estilo de la pestaña del documento, codificados por ID de sugerencia. |
namedStyles |
Los estilos con nombre de la pestaña del documento. |
suggestedNamedStylesChanges |
Los cambios sugeridos para los estilos con nombre de la pestaña del documento, codificados por ID de sugerencia. |
lists |
Las listas de la pestaña del documento, con el ID de lista como claves. |
namedRanges |
Los rangos con nombre en la pestaña del documento, con clave por nombre. |
inlineObjects |
Los objetos intercalados en la pestaña del documento, con clave por ID de objeto. |
positionedObjects |
Los objetos posicionados en la pestaña del documento, con clave por ID de objeto. |
Cuerpo
El cuerpo del documento.
Por lo general, el cuerpo contiene todo el contenido del documento, excepto headers
, footers
y footnotes
.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
El contenido del cuerpo. Los índices para el contenido del cuerpo comienzan en cero. |
StructuralElement
Un StructuralElement describe el contenido que le proporciona estructura al documento.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
Es el índice de inicio basado en cero de este elemento estructural, en unidades de código UTF-16. |
endIndex |
Es el índice final basado en cero de este elemento estructural, exclusivo, en unidades de código UTF-16. |
Campo de unión content . Es el contenido del elemento estructural. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
paragraph |
Es un tipo de párrafo de elemento estructural. |
sectionBreak |
Es un tipo de salto de sección de elemento estructural. |
table |
Es un tipo de tabla de elemento estructural. |
tableOfContents |
Es un tipo de índice de elemento estructural. |
Párrafo
Es una StructuralElement
que representa un párrafo. Un párrafo es un rango de contenido que termina con un carácter de línea nueva.
Representación JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
El contenido del párrafo, desglosado en sus componentes. |
paragraphStyle |
El estilo de este párrafo. |
suggestedParagraphStyleChanges |
El estilo de párrafo sugerido cambia a este párrafo, codificado por ID de sugerencia. |
bullet |
Es la viñeta de este párrafo. Si no está presente, el párrafo no pertenece a una lista. |
suggestedBulletChanges |
Los cambios sugeridos para la viñeta de este párrafo. |
positionedObjectIds[] |
Son los ID de los objetos posicionados conectados a este párrafo. |
suggestedPositionedObjectIds |
Los ID de los objetos posicionados sugeridos para adjuntar a este párrafo, enmarcados por ID de sugerencia. |
ParagraphElement
Un ParagraphElement describe contenido de un Paragraph
.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
Es el índice de inicio basado en cero de este elemento de párrafo, en unidades de código UTF-16. |
endIndex |
El índice final con base cero de este elemento de párrafo, exclusivo, en unidades de código UTF-16. |
Campo de unión content . Es el contenido del elemento de párrafo. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
textRun |
Es un elemento de párrafo de ejecución de texto. |
autoText |
Un elemento de párrafo de texto automático. |
pageBreak |
Un elemento de párrafo de salto de página. |
columnBreak |
Un elemento de párrafo de salto de columna. |
footnoteReference |
Un elemento de un párrafo de referencia de una nota al pie. |
horizontalRule |
Un elemento de párrafo de regla horizontal. |
equation |
Un elemento de párrafo de ecuación. |
inlineObjectElement |
Es un elemento de párrafo de un objeto intercalado. |
person |
Un elemento de párrafo que dirige a una persona o dirección de correo electrónico. |
richLink |
Es un elemento de párrafo que vincula a un recurso de Google (como un archivo en Google Drive, un video de YouTube o un evento de Calendario). |
TextRun
Es un objeto ParagraphElement
que representa una ejecución de texto con el mismo estilo.
Representación JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
Es el texto de esta ejecución. Cualquier elemento que no sea de texto en la ejecución se reemplaza por el carácter Unicode U+E907. |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de esta ejecución. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia en esta ejecución, con clave de ID de sugerencia. |
TextStyle
Representa el estilo que se puede aplicar al texto.
Los estilos de texto heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de texto depende del lugar en el que se defina ese estilo:
- El TextStyle del texto de un
Paragraph
hereda delnamed style type
correspondiente del párrafo. - El TextStyle en una
named style
se hereda del estilo con nombrenormal text
. - El TextStyle del estilo con nombre
normal text
se hereda del estilo de texto predeterminado del editor de Documentos. - El TextStyle de un elemento
Paragraph
contenido en una tabla puede heredar su estilo de texto del estilo de tabla.
Si el estilo de texto no se hereda de un estilo superior, al desconfigurar los campos, se revertirá el estilo a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Indica si el texto se renderiza en negrita o no. |
italic |
Indica si el texto está en cursiva o no. |
underline |
Indica si el texto está subrayado o no. |
strikethrough |
Indica si el texto está tachado o no. |
smallCaps |
Indica si el texto está en mayúsculas o no. |
backgroundColor |
Es el color de fondo del texto. Si se configura, el color será RGB o transparente, según el campo |
foregroundColor |
Es el color de primer plano del texto. Si se configura, el color será RGB o transparente, según el campo |
fontSize |
El tamaño de la fuente del texto. |
weightedFontFamily |
La familia de fuentes y el grosor renderizado del texto. Si una solicitud de actualización especifica valores para Si Si se configura |
baselineOffset |
Es el desplazamiento vertical del texto con respecto a su posición normal. El texto con desplazamientos del modelo de referencia |
link |
Es el destino del hipervínculo del texto. Si no se establece, no se mostrará ningún vínculo. Los vínculos no se heredan del texto superior. Cambiar el vínculo de una solicitud de actualización provoca otros cambios en el estilo de texto del rango:
|
OptionalColor
Es un color que puede ser totalmente opaco o completamente transparente.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Si se establece, se usará como color opaco. Si no la estableces, representa un color transparente. |
Color
Un color sólido.
Representación JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
Es el valor de color RGB. |
RgbColor
Un color RGB
Representación JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
El componente rojo del color, de 0.0 a 1.0. |
green |
El componente verde del color, de 0.0 a 1.0. |
blue |
El componente azul del color, de 0.0 a 1.0. |
Dimensión
Es una magnitud en una dirección única en las unidades especificadas.
Representación JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Campos | |
---|---|
magnitude |
La magnitud. |
unit |
Unidades para magnitud. |
Unidad
Unidades de medida.
Enumeraciones | |
---|---|
UNIT_UNSPECIFIED |
Las unidades son desconocidas. |
PT |
Un punto, 1/72 de pulgada. |
WeightedFontFamily
Representa una familia de fuentes y un grosor del texto.
Representación JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
fontFamily |
La familia de fuentes del texto. La familia de fuentes puede ser cualquier fuente del menú Fuente de Documentos o de Google Fonts. Si no se reconoce el nombre de la fuente, el texto se renderizará en |
weight |
El grosor de la fuente. Este campo puede tener cualquier valor que sea múltiplo de El valor predeterminado es El grosor de la fuente constituye solo un componente del grosor de la fuente renderizada. Una combinación de
|
BaselineOffset
Maneras en las que el texto se puede desplazar verticalmente de su posición normal.
Enumeraciones | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
El desplazamiento del modelo de referencia del texto se hereda del elemento superior. |
NONE |
El texto no está desplazado verticalmente. |
SUPERSCRIPT |
El texto se desplaza verticalmente hacia arriba (superíndice). |
SUBSCRIPT |
El texto se desplaza verticalmente hacia abajo (subíndice). |
Vínculo
Es una referencia a otra parte de un documento o a un recurso URL externo.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión destination . Es el destino del vínculo. Las direcciones (destination ) solo pueden ser una de las siguientes opciones: |
|
url |
Una URL externa. |
tabId |
El ID de una pestaña de este documento. |
bookmark |
Un favorito en este documento. En los documentos que contienen una sola pestaña, los vínculos a favoritos dentro de esa pestaña siguen mostrando |
heading |
Es un encabezado de este documento. En los documentos que contienen una sola pestaña, los vínculos a encabezados dentro de esa pestaña siguen mostrando |
bookmarkId |
El ID de un favorito en este documento. Campo heredado: en su lugar, establece Si este campo se usa en una solicitud de escritura, se considera que el favorito proviene del ID de pestaña especificado en la solicitud. Si no se especifica un ID de pestaña en la solicitud, se considera que pertenece a la primera pestaña del documento. |
headingId |
El ID de un encabezado de este documento. Campo heredado: en su lugar, establece Si este campo se usa en una solicitud de escritura, se considera que el encabezado proviene del ID de pestaña especificado en la solicitud. Si no se especifica un ID de pestaña en la solicitud, se considera que pertenece a la primera pestaña del documento. |
BookmarkLink
Es una referencia a un favorito en este documento.
Representación JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
El ID de un favorito en este documento. |
tabId |
El ID de la pestaña que contiene este favorito. |
HeadingLink
Es una referencia a un encabezado de este documento.
Representación JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
El ID de un encabezado de este documento. |
tabId |
El ID de la pestaña que contiene este encabezado. |
SuggestedTextStyle
Un cambio sugerido para un TextStyle
.
Representación JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Una |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos del |
TextStyleSuggestionState
Una máscara que indica cuáles de los campos del TextStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Campos | |
---|---|
boldSuggested |
Indica si hubo un cambio sugerido para |
italicSuggested |
Indica si hubo un cambio sugerido para |
underlineSuggested |
Indica si hubo un cambio sugerido para |
strikethroughSuggested |
Indica si hubo un cambio sugerido para |
smallCapsSuggested |
Indica si hubo un cambio sugerido para |
backgroundColorSuggested |
Indica si hubo un cambio sugerido para |
foregroundColorSuggested |
Indica si hubo un cambio sugerido para |
fontSizeSuggested |
Indica si hubo un cambio sugerido para |
weightedFontFamilySuggested |
Indica si hubo un cambio sugerido para |
baselineOffsetSuggested |
Indica si hubo un cambio sugerido para |
linkSuggested |
Indica si hubo un cambio sugerido para |
AutoText
Un objeto ParagraphElement
que representa un espacio en el texto que se reemplaza de forma dinámica por contenido que puede cambiar con el tiempo, como un número de página.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Es el tipo de este texto automático. |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este AutoText. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este AutoText, codificado por ID de sugerencia. |
Tipo
Los tipos de texto automático.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Un tipo de texto automático no especificado. |
PAGE_NUMBER |
Es un tipo de texto automático que representa el número de página actual. |
PAGE_COUNT |
Escribe el texto automático que representa el número total de páginas en el documento. |
PageBreak
Un elemento ParagraphElement
que representa un salto de página. Un salto de página hace que el texto siguiente comience en la parte superior de la página siguiente.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este salto de página. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de página puede afectar el diseño del contenido y el estilo del texto que se inserta junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este salto de página, marcado por el ID de sugerencia. |
ColumnBreak
Una ParagraphElement
que representa un salto de columna. Un salto de columna hace que el texto posterior comience en la parte superior de la siguiente columna.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este salto de columna. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de columna puede afectar el diseño del contenido y el estilo del texto que se inserta junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este salto de columna, marcado por el ID de sugerencia. |
FootnoteReference
Un objeto ParagraphElement
que representa una referencia de nota al pie. Una referencia de nota al pie es el contenido intercalado renderizado con un número y se usa para identificar la nota al pie.
Representación JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnoteId |
Es el ID de |
footnoteNumber |
Es la cantidad renderizada de esta nota al pie. |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de esta FootnoteReference. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a esta FootnoteReference con la clave de ID de sugerencia. |
HorizontalRule
Un objeto ParagraphElement
que representa una línea horizontal
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de esta HorizontalRule. Al igual que ocurre con el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de una regla horizontal puede afectar el diseño del contenido y el estilo del texto que se inserta junto a ella. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a esta HorizontalRule, codificado por ID de sugerencia. |
Ecuación
Un objeto ParagraphElement
que representa una ecuación.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
InlineObjectElement
Es un ParagraphElement
que contiene un InlineObject
.
Representación JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inlineObjectId |
El ID de las |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este InlineObjectElement. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un elemento de objeto intercalado puede afectar el diseño del contenido y el estilo del texto que se inserta junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este InlineObject, controlado por el ID de sugerencia. |
Persona
Una persona o dirección de correo electrónico mencionada en un documento. Estas menciones se comportan como un elemento inmutable y único que contiene el nombre o la dirección de correo electrónico de la persona.
Representación JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
personId |
Solo salida. El ID único de este vínculo. |
suggestedInsertionIds[] |
IDs para sugerencias que insertan el vínculo de esta persona en el documento. Un |
suggestedDeletionIds[] |
Son los IDs de las sugerencias que quitan el vínculo del documento a esta persona. Una |
textStyle |
Es el estilo de texto de este |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este |
personProperties |
Solo salida. Son las propiedades de este |
PersonProperties
Propiedades específicas de un Person
vinculado
Representación JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
Solo salida. El nombre de la persona si aparece en el texto del vínculo en lugar de la dirección de correo electrónico de la persona. |
email |
Solo salida. La dirección de correo electrónico vinculada a tu |
RichLink
Un vínculo a un recurso de Google (como un archivo en Drive, un video de YouTube o un evento de Calendario)
Representación JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
richLinkId |
Solo salida. Es el ID de este vínculo. |
suggestedInsertionIds[] |
Son los IDs de las sugerencias que insertan este vínculo en el documento. Un |
suggestedDeletionIds[] |
ID de las sugerencias que quitan el vínculo del documento. Una |
textStyle |
Es el estilo de texto de este |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este |
richLinkProperties |
Solo salida. Son las propiedades de este |
RichLinkProperties
Propiedades específicas de un RichLink
Representación JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Solo salida. El título de |
uri |
Solo salida. Es el URI del |
mimeType |
Solo salida. El tipo de MIME de |
ParagraphStyle
Estilos que se aplican a un párrafo completo.
Los estilos de párrafo heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de párrafo depende del lugar en el que se define:
- El ParagraphStyle en una
Paragraph
se hereda delnamed style type
correspondiente del párrafo. - El ParagraphStyle en una
named style
hereda del estilo con nombrenormal text
. - El ParagraphStyle del estilo con nombre
normal text
se hereda del estilo de párrafo predeterminado del editor de Documentos. - El ParagraphStyle de un elemento
Paragraph
contenido en una tabla puede heredar su estilo de párrafo del estilo de tabla.
Si el estilo de párrafo no se hereda de un elemento superior, al anular la configuración de los campos, se revertirá el estilo a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
El ID de encabezado del párrafo. Si está vacío, este párrafo no es un encabezado. Esta propiedad es de solo lectura. |
namedStyleType |
El tipo de estilo con nombre del párrafo. Dado que la actualización del tipo de estilo con nombre afecta otras propiedades dentro de ParagraphStyle, este tipo se aplica antes de que se actualicen las otras propiedades. |
alignment |
Es la alineación del texto para este párrafo. |
lineSpacing |
La cantidad de espacio entre líneas, como un porcentaje de normal, donde la normalidad se representa como 100.0. Si no la estableces, el valor se heredará del elemento superior. |
direction |
Es la dirección del texto de este párrafo. Si no la estableces, el valor predeterminado será |
spacingMode |
El modo de espaciado para el párrafo. |
spaceAbove |
La cantidad de espacio adicional sobre el párrafo. Si no la estableces, el valor se heredará del elemento superior. |
spaceBelow |
La cantidad de espacio adicional debajo del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
borderBetween |
Es el borde entre este párrafo y el párrafo siguiente y el anterior. Si no la estableces, el valor se heredará del elemento superior. El borde medio se renderiza cuando el párrafo adyacente tiene las mismas propiedades de borde y sangría. Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad. |
borderTop |
Es el borde en la parte superior de este párrafo. Si no la estableces, el valor se heredará del elemento superior. El borde superior se renderiza cuando el párrafo anterior tiene diferentes propiedades de borde y sangría. Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad. |
borderBottom |
Es el borde en la parte inferior de este párrafo. Si no la estableces, el valor se heredará del elemento superior. El borde inferior se renderiza cuando el siguiente párrafo tiene diferentes propiedades de borde y sangría. Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad. |
borderLeft |
Es el borde a la izquierda de este párrafo. Si no la estableces, el valor se heredará del elemento superior. Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad. |
borderRight |
Es el borde que se encuentra a la derecha de este párrafo. Si no la estableces, el valor se heredará del elemento superior. Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad. |
indentFirstLine |
La cantidad de sangría para la primera línea del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
indentStart |
Es la cantidad de sangría del párrafo en el lado que corresponde al inicio del texto, según la dirección actual del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
indentEnd |
Es la cantidad de sangría del párrafo en el lado que corresponde al final del texto, según la dirección actual del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
tabStops[] |
Una lista de las tabulaciones para este párrafo. La lista de tabulaciones no se hereda. Esta propiedad es de solo lectura. |
keepLinesTogether |
Si todas las líneas del párrafo deben colocarse en la misma página o columna, si es posible. Si no la estableces, el valor se heredará del elemento superior. |
keepWithNext |
Si al menos una parte de este párrafo debe presentarse en la misma página o columna que el siguiente párrafo, si es posible. Si no la estableces, el valor se heredará del elemento superior. |
avoidWidowAndOrphan |
Indica si se deben evitar las viudas y los huérfanos en el párrafo. Si no la estableces, el valor se heredará del elemento superior. |
shading |
El sombreado del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
pageBreakBefore |
Indica si el párrafo actual siempre debe comenzar al principio de una página. Si no la estableces, el valor se heredará del elemento superior. Si intentas actualizar |
NamedStyleType
Son los tipos de estilos con nombre.
Enumeraciones | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
No se especifica el tipo de estilo con nombre. |
NORMAL_TEXT |
Texto normal. |
TITLE |
Título. |
SUBTITLE |
Subtítulo. |
HEADING_1 |
Encabezado 1. |
HEADING_2 |
Encabezado 2. |
HEADING_3 |
Encabezado 3. |
HEADING_4 |
Encabezado 4. |
HEADING_5 |
Encabezado 5. |
HEADING_6 |
Encabezado 6. |
Alineación
Los tipos de alineación de texto para un párrafo.
Enumeraciones | |
---|---|
ALIGNMENT_UNSPECIFIED |
La alineación del párrafo se hereda del elemento superior. |
START |
El párrafo se alinea con el inicio de la línea. Alineado a la izquierda para el texto LTR; de lo contrario, alineado a la derecha. |
CENTER |
El párrafo está centrado. |
END |
El párrafo está alineado al final de la línea. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda |
JUSTIFIED |
El párrafo está justificado. |
ContentDirection
El contenido de las instrucciones puede fluir.
Enumeraciones | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
No se especifica la dirección del contenido. |
LEFT_TO_RIGHT |
El contenido va de izquierda a derecha. |
RIGHT_TO_LEFT |
El contenido va de derecha a izquierda. |
SpacingMode
Los diferentes modos de espaciado entre párrafos.
Enumeraciones | |
---|---|
SPACING_MODE_UNSPECIFIED |
El modo de espaciado se hereda del elemento superior. |
NEVER_COLLAPSE |
El espaciado de párrafo siempre está renderizado. |
COLLAPSE_LISTS |
Se omite el espaciado de párrafo entre los elementos de la lista. |
ParagraphBorder
Un borde alrededor de un párrafo.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde. |
width |
Es el ancho del borde. |
padding |
El relleno del borde. |
dashStyle |
El estilo de guion del borde. |
DashStyle
Los tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el valor de “ST_PresetLineDashVal”. tipo simple descrito en la sección 20.1.10.48 de "Formatos de archivo de Office Open XML: Referencia sobre los aspectos básicos y el lenguaje de marcado", parte 1 de la 4a edición de ECMA-376.
Enumeraciones | |
---|---|
DASH_STYLE_UNSPECIFIED |
Estilo de guion no especificado. |
SOLID |
Línea continua Corresponde al valor "solid" de ECMA-376 ST_PresetLineDashVal. Este es el estilo de guion predeterminado. |
DOT |
Línea de puntos. Corresponde al valor "punto" de ECMA-376 ST_PresetLineDashVal. |
DASH |
Línea punteada Corresponde al valor "dash" de ECMA-376 ST_PresetLineDashVal. |
TabStop
Una tabulación dentro de un párrafo.
Representación JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
El desplazamiento entre esta tabulación y el margen de inicio. |
alignment |
Es la alineación de esta tabulación. Si no la estableces, el valor predeterminado será |
TabStopAlignment
La alineación de la tabulación
Enumeraciones | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
No se especifica la alineación de la tabulación. |
START |
La tabulación está alineada con el inicio de la línea. Esta es la opción predeterminada. |
CENTER |
La tabulación está alineada con el centro de la línea. |
END |
La tabulación está alineada al final de la línea. |
Sombras
El sombreado de un párrafo.
Representación JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
backgroundColor |
El color de fondo del sombreado de este párrafo. |
SuggestedParagraphStyle
Un cambio sugerido para un ParagraphStyle
.
Representación JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Una |
paragraphStyleSuggestionState |
Una máscara que indica cuáles de los campos del |
ParagraphStyleSuggestionState
Una máscara que indica cuáles de los campos del ParagraphStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
Campos | |
---|---|
headingIdSuggested |
Indica si hubo un cambio sugerido para |
namedStyleTypeSuggested |
Indica si hubo un cambio sugerido para |
alignmentSuggested |
Indica si hubo un cambio sugerido para |
lineSpacingSuggested |
Indica si hubo un cambio sugerido para |
directionSuggested |
Indica si hubo un cambio sugerido para |
spacingModeSuggested |
Indica si hubo un cambio sugerido para |
spaceAboveSuggested |
Indica si hubo un cambio sugerido para |
spaceBelowSuggested |
Indica si hubo un cambio sugerido para |
borderBetweenSuggested |
Indica si hubo un cambio sugerido para |
borderTopSuggested |
Indica si hubo un cambio sugerido para |
borderBottomSuggested |
Indica si hubo un cambio sugerido para |
borderLeftSuggested |
Indica si hubo un cambio sugerido para |
borderRightSuggested |
Indica si hubo un cambio sugerido para |
indentFirstLineSuggested |
Indica si hubo un cambio sugerido para |
indentStartSuggested |
Indica si hubo un cambio sugerido para |
indentEndSuggested |
Indica si hubo un cambio sugerido para |
keepLinesTogetherSuggested |
Indica si hubo un cambio sugerido para |
keepWithNextSuggested |
Indica si hubo un cambio sugerido para |
avoidWidowAndOrphanSuggested |
Indica si hubo un cambio sugerido para |
shadingSuggestionState |
Una máscara que indica cuáles de los campos de |
pageBreakBeforeSuggested |
Indica si hubo un cambio sugerido para |
ShadingSuggestionState
Una máscara que indica cuáles de los campos en el Shading
base se cambiaron en este cambio sugerido. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si hubo un cambio sugerido en |
Viñeta
Describe la viñeta de un párrafo.
Representación JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
listId |
El ID de la lista a la que pertenece este párrafo. |
nestingLevel |
El nivel de anidamiento de este párrafo en la lista. |
textStyle |
El estilo de texto específico de párrafo que se aplicó a esta viñeta. |
SuggestedBullet
Un cambio sugerido para un Bullet
.
Representación JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Una |
bulletSuggestionState |
Una máscara que indica cuáles de los campos del |
BulletSuggestionState
Una máscara que indica cuáles de los campos del Bullet
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
listIdSuggested |
Indica si hubo un cambio sugerido en |
nestingLevelSuggested |
Indica si hubo un cambio sugerido en |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
ObjectReferences
Es una colección de IDs de objeto.
Representación JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
objectIds[] |
Los ID de objeto |
SectionBreak
Un objeto StructuralElement
que representa un salto de sección. Una sección es un rango de contenido que tiene el mismo SectionStyle
. Un salto de sección representa el inicio de una nueva sección, y el estilo de la sección se aplica a la sección que sigue después del salto de sección.
El cuerpo del documento siempre comienza con un salto de sección.
Representación JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
sectionStyle |
Es el estilo de la sección que sigue a este salto de sección. |
SectionStyle
El estilo que se aplica a una sección.
Representación JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
columnProperties[] |
Las propiedades de las columnas de la sección. Si está vacía, la sección contiene una columna con las propiedades predeterminadas del editor de Documentos. Una sección se puede actualizar para que no tenga más de 3 columnas. Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se generará un error 400 de solicitud incorrecta. |
columnSeparatorStyle |
El estilo de los separadores de columna. Este estilo se puede configurar incluso cuando hay una columna en la sección. Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
contentDirection |
Es la dirección del contenido de esta sección. Si no la estableces, el valor predeterminado será Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
marginTop |
El margen superior de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
marginBottom |
Es el margen inferior de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
marginRight |
El margen derecho de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
marginLeft |
El margen izquierdo de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
marginHeader |
El margen del encabezado de la sección. Si no se establece, el valor predeterminado es Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
marginFooter |
El margen del pie de página de la sección. Si no se establece, el valor predeterminado es Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
sectionType |
Solo salida. Es el tipo de sección. |
defaultHeaderId |
El ID del encabezado predeterminado. Si no se establece, el valor se hereda del SectionStyle Esta propiedad es de solo lectura. |
defaultFooterId |
Es el ID del pie de página predeterminado. Si no se establece, el valor se hereda del SectionStyle Esta propiedad es de solo lectura. |
firstPageHeaderId |
El ID del encabezado que se usa solo para la primera página de la sección. Si Esta propiedad es de solo lectura. |
firstPageFooterId |
El ID del pie de página que se usa solo para la primera página de la sección. Si Esta propiedad es de solo lectura. |
evenPageHeaderId |
El ID del encabezado que se utiliza solo para páginas pares. Si el valor de Esta propiedad es de solo lectura. |
evenPageFooterId |
Es el ID del pie de página que se usa solo para páginas pares. Si el valor de Esta propiedad es de solo lectura. |
useFirstPageHeaderFooter |
Indica si se deben usar los IDs de encabezado o pie de página de la primera página de la sección. Si no se establece, se hereda de Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
pageNumberStart |
El número de página desde la que se comienza a contar la cantidad de páginas de esta sección. Si no la estableces, la numeración de las páginas continuará desde la sección anterior. Si no estableces el valor en la primera Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
flipPageOrientation |
Opcional. Indica si se deben invertir las dimensiones del elemento Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
SectionColumnProperties
Propiedades que se aplican a la columna de una sección.
Representación JSON |
---|
{ "width": { object ( |
Campos | |
---|---|
width |
Solo salida. El ancho de la columna. |
paddingEnd |
Es el relleno al final de la columna. |
ColumnSeparatorStyle
El estilo de los separadores de columnas entre columnas.
Enumeraciones | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Estilo de separador de columnas no especificado. |
NONE |
No hay líneas de separador de columnas entre las columnas. |
BETWEEN_EACH_COLUMN |
Renderiza una línea de separador de columnas entre cada columna. |
SectionType
Representa cómo se posiciona el inicio de la sección actual en relación con la sección anterior.
Enumeraciones | |
---|---|
SECTION_TYPE_UNSPECIFIED |
El tipo de sección no se especifica. |
CONTINUOUS |
La sección comienza inmediatamente después del último párrafo de la sección anterior. |
NEXT_PAGE |
La sección comienza en la página siguiente. |
Tabla
Un objeto StructuralElement
que representa una tabla.
Representación JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
Campos | |
---|---|
rows |
Cantidad de filas en la tabla. |
columns |
Cantidad de columnas de la tabla. Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad diferente de celdas. |
tableRows[] |
El contenido y el estilo de cada fila |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
tableStyle |
El estilo de la tabla. |
Fila de la tabla
El contenido y el estilo de una fila en un Table
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Campos | |
---|---|
startIndex |
Es el índice de inicio basado en cero de esta fila, en unidades de código UTF-16. |
endIndex |
El índice final basado en cero de esta fila, exclusivo, en unidades de código UTF-16. |
tableCells[] |
El contenido y el estilo de cada celda de esta fila. Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad diferente de celdas que otras filas en la misma tabla. |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
tableRowStyle |
El estilo de la fila de la tabla. |
suggestedTableRowStyleChanges |
El estilo sugerido cambia en esta fila, codificado por ID de sugerencia. |
TableCell
El contenido y el estilo de una celda en un Table
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
Es el índice de inicio basado en cero de esta celda, en unidades de código UTF-16. |
endIndex |
El índice final basado en cero de esta celda, exclusivo, en unidades de código UTF-16. |
content[] |
Es el contenido de la celda. |
tableCellStyle |
Es el estilo de la celda. |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
suggestedTableCellStyleChanges |
Los cambios sugeridos para el estilo de celda de la tabla, vinculados por ID de sugerencia. |
TableCellStyle
Es el estilo de un TableCell
.
Los estilos de celda de tabla heredados se representan como campos sin configurar en este mensaje. Un estilo de celda de tabla puede heredar del estilo de la tabla.
Representación JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Campos | |
---|---|
rowSpan |
El intervalo de filas de la celda. Esta propiedad es de solo lectura. |
columnSpan |
El intervalo de columnas de la celda. Esta propiedad es de solo lectura. |
backgroundColor |
El color de fondo de la celda. |
borderLeft |
Borde izquierdo de la celda. |
borderRight |
Borde derecho de la celda. |
borderTop |
Borde superior de la celda. |
borderBottom |
Borde inferior de la celda. |
paddingLeft |
Relleno izquierdo de la celda. |
paddingRight |
El padding derecho de la celda. |
paddingTop |
Padding superior de la celda. |
paddingBottom |
Padding inferior de la celda |
contentAlignment |
La alineación del contenido en la celda de la tabla. La alineación predeterminada es la misma que la de las celdas de tabla nuevas que se crean en el editor de Documentos. |
TableCellBorder
Un borde alrededor de una celda de la tabla.
Los bordes de las celdas de la tabla no pueden ser transparentes. Para ocultar el borde de celda de una tabla, establece el ancho en 0.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde. Este color no puede ser transparente. |
width |
Es el ancho del borde. |
dashStyle |
El estilo de guion del borde. |
ContentAlignment
Los tipos de alineación del contenido.
Derivado de un subconjunto de valores de "ST_TextAnchoringType" tipo simple en la sección 20.1.10.59 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de la 4a edición de ECMA-376.
Enumeraciones | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Una alineación de contenido no especificada. La alineación de contenido se hereda del elemento superior, si existe. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Una alineación de contenido no compatible. |
TOP |
Una alineación que alinea el contenido con la parte superior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE |
Una alineación que alinea el contenido con el centro del contenedor de contenido. Corresponde al parámetro "ctr" de ECMA-376 ST_TextAnchoringType. |
BOTTOM |
Es una alineación que alinea el contenido con la parte inferior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "b". |
SuggestedTableCellStyle
Un cambio sugerido para un TableCellStyle
.
Representación JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Una |
tableCellStyleSuggestionState |
Una máscara que indica cuáles de los campos del |
TableCellStyleSuggestionState
Una máscara que indica cuáles de los campos del TableCellStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Campos | |
---|---|
rowSpanSuggested |
Indica si hubo un cambio sugerido para |
columnSpanSuggested |
Indica si hubo un cambio sugerido para |
backgroundColorSuggested |
Indica si hubo un cambio sugerido para |
borderLeftSuggested |
Indica si hubo un cambio sugerido para |
borderRightSuggested |
Indica si hubo un cambio sugerido para |
borderTopSuggested |
Indica si hubo un cambio sugerido para |
borderBottomSuggested |
Indica si hubo un cambio sugerido para |
paddingLeftSuggested |
Indica si hubo un cambio sugerido para |
paddingRightSuggested |
Indica si hubo un cambio sugerido para |
paddingTopSuggested |
Indica si hubo un cambio sugerido para |
paddingBottomSuggested |
Indica si hubo un cambio sugerido para |
contentAlignmentSuggested |
Indica si hubo un cambio sugerido para |
TableRowStyle
Diseños que se aplican a una fila de la tabla.
Representación JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
La altura mínima de la fila. En el Editor de Documentos, la fila se renderizará a una altura igual o superior a este valor para mostrar todo el contenido de las celdas de la fila. |
tableHeader |
Indica si la fila es un encabezado de tabla. |
preventOverflow |
Indica si la fila no puede desbordar los límites de la página o de las columnas. |
SuggestedTableRowStyle
Un cambio sugerido para un TableRowStyle
.
Representación JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Una |
tableRowStyleSuggestionState |
Una máscara que indica cuáles de los campos del |
TableRowStyleSuggestionState
Una máscara que indica cuáles de los campos del TableRowStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
minRowHeightSuggested |
Indica si hubo un cambio sugerido para |
TableStyle
Diseños que se aplican a una tabla.
Representación JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
tableColumnProperties[] |
Propiedades de cada columna Ten en cuenta que, en Documentos, las tablas contienen filas y las filas contienen celdas, similar a HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el |
TableColumnProperties
Propiedades de una columna en una tabla.
Representación JSON |
---|
{ "widthType": enum ( |
Campos | |
---|---|
widthType |
El tipo de ancho de la columna. |
width |
El ancho de la columna. Se establece cuando el |
WidthType
El tipo de ancho de la columna.
Enumeraciones | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
El tipo de ancho de columna no se especifica. |
EVENLY_DISTRIBUTED |
El ancho de columna se distribuye de manera uniforme entre las demás columnas distribuidas de manera uniforme. El ancho de la columna se determina automáticamente y tendrá una parte igual del ancho restante para la tabla después de contabilizar todas las columnas con anchos especificados. |
FIXED_WIDTH |
Un ancho de columna fijo. La propiedad [width][google.apps.docs.v1.TableColumnProperties.width ] contiene el ancho de la columna. |
TableOfContents
Es un elemento StructuralElement
que representa un índice.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
Es el contenido del índice. |
suggestedInsertionIds[] |
Los IDs de inserción sugeridos. Una |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
Encabezado
El encabezado de un documento.
Representación JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
headerId |
El ID del encabezado. |
content[] |
El contenido del encabezado. Los índices del contenido de un encabezado comienzan en cero. |
Nota a pie de página
Una nota al pie de un documento.
Representación JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Campos | |
---|---|
footnoteId |
Es el ID de la nota al pie. |
content[] |
El contenido de la nota al pie Los índices del contenido de una nota al pie comienzan en cero. |
DocumentStyle
Es el estilo del documento.
Representación JSON |
---|
{ "background": { object ( |
Campos | |
---|---|
background |
Corresponde al fondo del documento. Los documentos no pueden tener un color de fondo transparente. |
defaultHeaderId |
El ID del encabezado predeterminado. Si no la estableces, no habrá ningún encabezado predeterminado. Esta propiedad es de solo lectura. |
defaultFooterId |
Es el ID del pie de página predeterminado. Si no la estableces, no se establecerá un pie de página predeterminado. Esta propiedad es de solo lectura. |
evenPageHeaderId |
El ID del encabezado que se utiliza solo para páginas pares. El valor de Esta propiedad es de solo lectura. |
evenPageFooterId |
Es el ID del pie de página que se usa solo para páginas pares. El valor de Esta propiedad es de solo lectura. |
firstPageHeaderId |
El ID del encabezado que se usa solo para la primera página. Si no se establece, no existe un encabezado único para la primera página. El valor de Esta propiedad es de solo lectura. |
firstPageFooterId |
Es el ID del pie de página que se usa solo para la primera página. Si no la estableces, no habrá un pie de página único para la primera página. El valor de Esta propiedad es de solo lectura. |
useFirstPageHeaderFooter |
Indica si se deben usar los IDs de encabezado o pie de página de la primera página. |
useEvenPageHeaderFooter |
Indica si se deben usar los IDs de encabezado y pie de página de páginas pares para las páginas pares. |
pageNumberStart |
El número de página desde el que se comienza a contar la cantidad de páginas. |
marginTop |
El margen superior de la página. Si actualizas el margen superior de la página en el estilo del documento, se borrará el margen superior de la página en todos los estilos de sección. |
marginBottom |
El margen inferior de la página. Si actualizas el margen inferior de la página en el estilo del documento, se borrará ese margen en todos los estilos de sección. |
marginRight |
El margen derecho de la página. Si actualizas el margen derecho de la página en el estilo del documento, se borrará ese margen en todos los estilos de sección. También puede provocar que el tamaño de las columnas se modifique en todas las secciones. |
marginLeft |
El margen izquierdo de la página. Si actualizas el margen izquierdo de la página en el estilo del documento, se borrará ese margen en todos los estilos de sección. También puede provocar que el tamaño de las columnas se modifique en todas las secciones. |
pageSize |
Indica el tamaño de una página del documento. |
marginHeader |
La cantidad de espacio entre la parte superior de la página y el contenido del encabezado. |
marginFooter |
Es la cantidad de espacio entre la parte inferior de la página y el contenido del pie de página. |
useCustomHeaderFooterMargins |
Indica si se respetan los valores de DocumentStyle Esta propiedad es de solo lectura. |
flipPageOrientation |
Opcional. Indica si se deben girar las dimensiones de |
Información general
Representa el fondo de un documento.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Es el color de fondo. |
Tamaño
Un ancho y una altura.
Representación JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
La altura del objeto. |
width |
El ancho del objeto. |
SuggestedDocumentStyle
Un cambio sugerido para DocumentStyle
.
Representación JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
documentStyle |
Una |
documentStyleSuggestionState |
Una máscara que indica cuáles de los campos del |
DocumentStyleSuggestionState
Una máscara que indica cuáles de los campos del DocumentStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
backgroundSuggestionState |
Una máscara que indica cuáles de los campos de |
defaultHeaderIdSuggested |
Indica si hubo un cambio sugerido para |
defaultFooterIdSuggested |
Indica si hubo un cambio sugerido para |
evenPageHeaderIdSuggested |
Indica si hubo un cambio sugerido para |
evenPageFooterIdSuggested |
Indica si hubo un cambio sugerido para |
firstPageHeaderIdSuggested |
Indica si hubo un cambio sugerido para |
firstPageFooterIdSuggested |
Indica si hubo un cambio sugerido para |
useFirstPageHeaderFooterSuggested |
Indica si hubo un cambio sugerido para |
useEvenPageHeaderFooterSuggested |
Indica si hubo un cambio sugerido para |
pageNumberStartSuggested |
Indica si hubo un cambio sugerido para |
marginTopSuggested |
Indica si hubo un cambio sugerido para |
marginBottomSuggested |
Indica si hubo un cambio sugerido para |
marginRightSuggested |
Indica si hubo un cambio sugerido para |
marginLeftSuggested |
Indica si hubo un cambio sugerido para |
pageSizeSuggestionState |
Una máscara que indica cuál de los campos de [tamaño] Se modificó [google.apps.docs.v1.DocumentStyle.size] en esta sugerencia. |
marginHeaderSuggested |
Indica si hubo un cambio sugerido para |
marginFooterSuggested |
Indica si hubo un cambio sugerido para |
useCustomHeaderFooterMarginsSuggested |
Indica si hubo un cambio sugerido para |
flipPageOrientationSuggested |
Opcional. Indica si hubo un cambio sugerido para |
BackgroundSuggestionState
Una máscara que indica cuáles de los campos del Background
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, Backgound
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si el color de fondo actual se modificó en esta sugerencia. |
SizeSuggestionState
Una máscara que indica cuáles de los campos del Size
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, Size
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
heightSuggested |
Indica si hubo un cambio sugerido para |
widthSuggested |
Indica si hubo un cambio sugerido para |
NamedStyles
Los estilos con nombre. Los párrafos del documento pueden heredar sus TextStyle
y ParagraphStyle
de estos estilos con nombre.
Representación JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Los estilos con nombre. Hay una entrada para cada uno de los |
NamedStyle
Un estilo con nombre. Los párrafos del documento pueden heredar sus TextStyle
y ParagraphStyle
de este estilo con nombre si tienen el mismo tipo de estilo con nombre.
Representación JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
Es el tipo de este estilo con nombre. |
textStyle |
Es el estilo de texto de este estilo con nombre. |
paragraphStyle |
Es el estilo de párrafo de este estilo con nombre. |
SuggestedNamedStyles
Un cambio sugerido para NamedStyles
.
Representación JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Una |
namedStylesSuggestionState |
Una máscara que indica cuáles de los campos del |
NamedStylesSuggestionState
Es el estado de sugerencia de un mensaje NamedStyles
.
Representación JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
stylesSuggestionStates[] |
Una máscara que indica cuáles de los campos del El orden de estos estados de sugerencias de estilo con nombre coincide con el orden del estilo con nombre correspondiente dentro de la sugerencia |
NamedStyleSuggestionState
Un estado de sugerencia de un mensaje NamedStyle
.
Representación JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
El tipo de estilo con nombre al que corresponde este estado de sugerencia. Este campo se proporciona como una ventaja para hacer coincidir NamedStylesuggestionState con su |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
paragraphStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
Lista
Una lista representa los atributos de una lista de un grupo de párrafos que pertenecen a la misma lista. Un párrafo que forma parte de una lista tiene una referencia al ID de la lista en su bullet
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Son las propiedades de la lista. |
suggestedListPropertiesChanges |
Los cambios sugeridos para las propiedades de la lista, con clave por ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacía, entonces esta no es una inserción sugerida. |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacía, no hay sugerencias de eliminaciones de esta lista. |
ListProperties
Las propiedades de una list
que describen el aspecto de las viñetas que pertenecen a los párrafos asociados con una lista.
Representación JSON |
---|
{
"nestingLevels": [
{
object ( |
Campos | |
---|---|
nestingLevels[] |
Describe las propiedades de las viñetas en el nivel asociado. Una lista tiene, como máximo, 9 niveles de anidamiento, con un nivel 0 que corresponde al nivel superior y un nivel 8 que corresponde al nivel más anidado. Los niveles de anidación se muestran en orden ascendente, y los menos anidados se muestran primero. |
NestingLevel
Contiene propiedades que describen el aspecto de una viñeta de lista en un nivel determinado de anidación.
Representación JSON |
---|
{ "bulletAlignment": enum ( |
Campos | |
---|---|
bulletAlignment |
Es la alineación de la viñeta dentro del espacio designado para renderizarla. |
glyphFormat |
La cadena de formato que usan las viñetas en este nivel de anidación. El formato del glifo contiene uno o más marcadores de posición, que se reemplazan por los valores adecuados según Por ejemplo, el formato de glifo
El formato de glifo puede contener marcadores de posición para el nivel de anidamiento actual, así como marcadores de posición para los niveles de anidación superiores. Por ejemplo, una lista puede tener un formato de glifo de
Para niveles de anidamiento ordenados, la cadena que reemplaza un marcador de posición en formato glifo para un párrafo en particular depende del orden de este dentro de la lista. |
indentFirstLine |
Es la cantidad de sangría para la primera línea de párrafos en este nivel de anidación. |
indentStart |
Es la cantidad de sangría para los párrafos en este nivel de anidación. Se aplica en el lado que corresponde al inicio del texto, según la dirección del contenido del párrafo. |
textStyle |
El estilo de texto de las viñetas en este nivel de anidación. |
startNumber |
Es el número del primer elemento de lista en este nivel de anidación. El valor 0 se considera como el valor 1 en las listas con letras y con números romanos. Para valores de 0 y 1, las listas de números romanos y con letras comienzan en Este valor se ignora para niveles de anidamiento con glifos desordenados. |
Campo de unión glyph_kind . El tipo de glifo que usan las viñetas. Esto define el glifo de viñeta que reemplaza los marcadores de posición en el elemento glyph_format . glyph_kind puede ser solo uno de los siguientes: |
|
glyphType |
Es el tipo de glifo que usan las viñetas cuando se ordenan los párrafos en este nivel de anidamiento. El tipo de glifo determina qué tipo de glifo se utiliza para reemplazar los marcadores de posición dentro de |
glyphSymbol |
Un símbolo de glifo personalizado que se usa para las viñetas cuando los párrafos en este nivel de anidación no están ordenados. El símbolo del glifo reemplaza los marcadores de posición dentro de |
BulletAlignment
Los tipos de alineación de una viñeta.
Enumeraciones | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
La alineación de las viñetas no está especificada. |
START |
La viñeta se alinea con el inicio del espacio asignado para la renderización de la viñeta. Alineado a la izquierda para el texto LTR; de lo contrario, alineado a la derecha. |
CENTER |
La viñeta se alinea con el centro del espacio designado para renderizar la viñeta. |
END |
La viñeta se alinea con el final del espacio designado para renderizarla. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda |
GlyphType
Son los tipos de glifos que usan las viñetas cuando se ordenan los párrafos en este nivel de anidamiento.
Enumeraciones | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
El tipo de glifo no se especifica o no se admite. |
NONE |
Una string vacía. |
DECIMAL |
Un número, como 1 , 2 o 3 . |
ZERO_DECIMAL |
Es un 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. |
UPPER_ALPHA |
Una letra mayúscula, como A , B o C . |
ALPHA |
Una letra minúscula, como a , b o c . |
UPPER_ROMAN |
Un número romano en mayúsculas, como I , II o III . |
ROMAN |
Un número romano en minúscula, como i , ii o iii . |
SuggestedListProperties
Un cambio sugerido para ListProperties
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Una |
listPropertiesSuggestionState |
Una máscara que indica cuáles de los campos del |
ListPropertiesSuggestionState
Una máscara que indica cuáles de los campos del ListProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Campos | |
---|---|
nestingLevelsSuggestionStates[] |
Una máscara que indica cuáles de los campos del Los estados de sugerencia de nivel de anidamiento se muestran en orden ascendente a partir del nivel de anidamiento, con el primer nivel de anidación que se muestra primero. |
NestingLevelSuggestionState
Una máscara que indica cuáles de los campos del NestingLevel
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
bulletAlignmentSuggested |
Indica si hubo un cambio sugerido para |
glyphTypeSuggested |
Indica si hubo un cambio sugerido para |
glyphFormatSuggested |
Indica si hubo un cambio sugerido para |
glyphSymbolSuggested |
Indica si hubo un cambio sugerido para |
indentFirstLineSuggested |
Indica si hubo un cambio sugerido para |
indentStartSuggested |
Indica si hubo un cambio sugerido para |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
startNumberSuggested |
Indica si hubo un cambio sugerido para |
NamedRanges
Una colección de todos los NamedRange
del documento que comparten un nombre determinado.
Representación JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
El nombre que comparten todos los |
namedRanges[] |
Son las |
NamedRange
Una colección de Range
con el mismo ID de rango con nombre.
Los rangos con nombre permiten a los desarrolladores asociar partes de un documento con una etiqueta arbitraria definida por el usuario para que su contenido se pueda leer o editar más tarde de manera programática. Un documento puede contener varios rangos con nombre con el mismo nombre, pero cada rango con nombre tiene un ID único.
Un rango con nombre se crea con un solo Range
, y el contenido insertado dentro de un rango con nombre generalmente expande ese rango. Sin embargo, ciertos cambios en el documento pueden hacer que el rango se divida en varios.
Los rangos con nombre no son privados. Todas las aplicaciones y colaboradores que tienen acceso al documento pueden ver sus rangos con nombre.
Representación JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
El ID del rango con nombre. |
name |
El nombre del rango con nombre. |
ranges[] |
Los rangos que pertenecen a este rango con nombre. |
Rango
Especifica un rango contiguo de texto.
Representación JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
Campos | |
---|---|
segmentId |
Es el ID del encabezado, el pie de página o la nota al pie que contiene este rango. Un ID de segmento vacío hace referencia al cuerpo del documento. |
startIndex |
Es el índice de inicio basado en cero de este rango, en unidades de código UTF-16. En todos los usos actuales, se debe proporcionar un índice de inicio. Este campo es un Int32Value para adaptarse a futuros casos de uso con rangos abiertos. |
endIndex |
Es el índice final basado en cero de este rango, exclusivo, en unidades de código UTF-16. En todos los usos actuales, se debe proporcionar un índice final. Este campo es un Int32Value para adaptarse a futuros casos de uso con rangos abiertos. |
tabId |
La pestaña que contiene este rango. 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:
|
InlineObject
Un objeto que aparece intercalado con el texto. Un InlineObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
objectId |
El ID de este objeto intercalado. Puede usarse para actualizar las propiedades de un objeto. |
inlineObjectProperties |
Son las propiedades de este objeto intercalado. |
suggestedInlineObjectPropertiesChanges |
Los cambios sugeridos para las propiedades del objeto intercalados, con clave por ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacía, entonces esta no es una inserción sugerida. |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
InlineObjectProperties
Propiedades de un InlineObject
Representación JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
El objeto incorporado de este objeto intercalado. |
EmbeddedObject
Es un objeto incorporado en el documento.
Representación JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Campos | |
---|---|
title |
El título del objeto incorporado. |
description |
La descripción del objeto incorporado. |
embeddedObjectBorder |
El borde del objeto incorporado. |
size |
El tamaño visible de la imagen después de recortarla. |
marginTop |
El margen superior del objeto incorporado. |
marginBottom |
El margen inferior del objeto incorporado. |
marginRight |
El margen derecho del objeto incorporado. |
marginLeft |
El margen izquierdo del objeto incorporado. |
linkedContentReference |
Es una referencia al contenido de la fuente vinculada externa. Por ejemplo, contiene una referencia al gráfico de origen de Hojas de cálculo de Google cuando el objeto incorporado es un gráfico vinculado. Si no la estableces, el objeto incorporado no estará vinculado. |
Campo de unión properties . Las propiedades que son específicas de cada tipo de objeto incorporado Las direcciones (properties ) solo pueden ser una de las siguientes opciones: |
|
embeddedDrawingProperties |
Propiedades de un dibujo incorporado |
imageProperties |
Son las propiedades de una imagen. |
EmbeddedDrawingProperties
Este tipo no tiene campos.
Son las propiedades de un dibujo incorporado y que se usan para diferenciar el tipo de objeto. Los dibujos incorporados se crean y editan en un documento. Ten en cuenta que no se admiten detalles exhaustivos.
ImageProperties
Son las propiedades de una imagen.
Representación JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
contentUri |
Un URI para la imagen con una vida útil predeterminada de 30 minutos. Este URI se etiqueta con la cuenta del solicitante. Cualquier persona con el URI accede de manera efectiva a la imagen como el solicitante original. Si cambia la configuración de uso compartido del documento, es posible que se pierda el acceso a la imagen. |
sourceUri |
El URI de origen es el URI que se usa para insertar la imagen. El URI de origen puede estar vacío. |
brightness |
El efecto de brillo de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa que no hay efecto. |
contrast |
El efecto de contraste de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa que no hay efecto. |
transparency |
El efecto de transparencia de la imagen. El valor debe estar en el intervalo [0.0, 1.0], donde 0 significa sin efecto y 1 significa transparente. |
cropProperties |
Las propiedades de recorte de la imagen. |
angle |
Ángulo de rotación en el sentido de las manecillas del reloj de la imagen, en radianes. |
CropProperties
Son las propiedades de recorte de una imagen.
El rectángulo recortado se representa con desplazamientos fraccionarios de los 4 bordes del contenido original.
- Si el desplazamiento está en el intervalo (0, 1), el borde correspondiente del rectángulo de recorte se posiciona dentro del rectángulo delimitador original de la imagen.
- Si el desplazamiento es negativo o mayor que 1, el borde correspondiente del rectángulo de recorte se posiciona fuera del rectángulo delimitador original de la imagen.
- Si todas las compensaciones y el ángulo de rotación son 0, la imagen no se recorta.
Representación JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Campos | |
---|---|
offsetLeft |
El desplazamiento especifica qué tan lejos se encuentra el borde izquierdo del rectángulo de recorte respecto del borde izquierdo del contenido original como una fracción del ancho del contenido original. |
offsetRight |
El desplazamiento especifica qué tan lejos se encuentra el borde derecho del rectángulo de recorte del borde derecho del contenido original como una fracción del ancho del contenido original. |
offsetTop |
El desplazamiento especifica qué tan lejos se encuentra el borde superior del rectángulo de recorte del borde superior del contenido original como una fracción de la altura del contenido original. |
offsetBottom |
El desplazamiento especifica qué tan lejos se encuentra el borde inferior del rectángulo de recorte del borde inferior del contenido original como una fracción de la altura del contenido original. |
angle |
Ángulo de rotación en el sentido de las manecillas del reloj del rectángulo de recorte alrededor de su centro, en radianes. La rotación se aplica después de las compensaciones. |
EmbeddedObjectBorder
Es un borde alrededor de una EmbeddedObject
.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde. |
width |
Es el ancho del borde. |
dashStyle |
El estilo de guion del borde. |
propertyState |
Es el estado de la propiedad de la frontera. |
PropertyState
Son los posibles estados de una propiedad.
Enumeraciones | |
---|---|
RENDERED |
Si el estado de una propiedad es RENDERED, el elemento tiene la propiedad correspondiente cuando se renderiza en el documento. Este es el valor predeterminado. |
NOT_RENDERED |
Si el estado de una propiedad es NOT_RENDERED, el elemento no tiene la propiedad correspondiente cuando se renderiza en el documento. |
LinkedContentReference
Es una referencia al contenido de la fuente vinculada externa.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión reference . Es la referencia específica del tipo de contenido vinculado. Las direcciones (reference ) solo pueden ser una de las siguientes opciones: |
|
sheetsChartReference |
Es una referencia al gráfico vinculado. |
SheetsChartReference
Una referencia a un gráfico vinculado incorporado desde Hojas de cálculo de Google.
Representación JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
Campos | |
---|---|
spreadsheetId |
Es el ID de la hoja de cálculo de Hojas de cálculo de Google que contiene el gráfico de origen. |
chartId |
El ID del gráfico específico en la hoja de cálculo de Hojas de cálculo de Google incorporada. |
SuggestedInlineObjectProperties
Un cambio sugerido para InlineObjectProperties
.
Representación JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Una |
inlineObjectPropertiesSuggestionState |
Una máscara que indica cuáles de los campos del |
InlineObjectPropertiesSuggestionState
Una máscara que indica cuáles de los campos del InlineObjectProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embeddedObjectSuggestionState |
Una máscara que indica cuáles de los campos de |
EmbeddedObjectSuggestionState
Una máscara que indica cuáles de los campos del EmbeddedObject
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Una máscara que indica cuáles de los campos de |
imagePropertiesSuggestionState |
Una máscara que indica cuáles de los campos de |
titleSuggested |
Indica si hubo un cambio sugerido para |
descriptionSuggested |
Indica si hubo un cambio sugerido para |
embeddedObjectBorderSuggestionState |
Una máscara que indica cuáles de los campos de |
sizeSuggestionState |
Una máscara que indica cuáles de los campos de |
marginLeftSuggested |
Indica si hubo un cambio sugerido para |
marginRightSuggested |
Indica si hubo un cambio sugerido para |
marginTopSuggested |
Indica si hubo un cambio sugerido para |
marginBottomSuggested |
Indica si hubo un cambio sugerido para |
linkedContentReferenceSuggestionState |
Una máscara que indica cuáles de los campos de |
EmbeddedDrawingPropertiesSuggestionState
Este tipo no tiene campos.
Una máscara que indica cuáles de los campos del EmbeddedDrawingProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
ImagePropertiesSuggestionState
Una máscara que indica cuáles de los campos del ImageProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
contentUriSuggested |
Indica si hubo un cambio sugerido para |
sourceUriSuggested |
Indica si se sugirió un cambio en [sourceUri]. [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indica si hubo un cambio sugerido para [brillo]. [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
Indica si se sugirió un cambio en el [contraste]. [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indica si se sugirió un cambio para la [transparencia]. [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Una máscara que indica cuáles de los campos de |
angleSuggested |
Indica si hubo un cambio sugerido para [angle]. [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
Una máscara que indica cuáles de los campos del CropProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offsetLeftSuggested |
Indica si hubo un cambio sugerido para |
offsetRightSuggested |
Indica si hubo un cambio sugerido para |
offsetTopSuggested |
Indica si hubo un cambio sugerido para |
offsetBottomSuggested |
Indica si hubo un cambio sugerido para |
angleSuggested |
Indica si hubo un cambio sugerido para |
EmbeddedObjectBorderSuggestionState
Una máscara que indica cuáles de los campos del EmbeddedObjectBorder
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Campos | |
---|---|
colorSuggested |
Indica si hubo un cambio sugerido para el [color]. [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indica si hubo un cambio sugerido para [width]. [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indica si se sugirió un cambio para [dashStyle]. [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indica si hubo un cambio sugerido en [propertyState]. [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Una máscara que indica cuáles de los campos del LinkedContentReference
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Una máscara que indica cuáles de los campos de |
SheetsChartReferenceSuggestionState
Una máscara que indica cuáles de los campos del SheetsChartReference
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica si hubo un cambio sugerido para |
chartIdSuggested |
Indica si hubo un cambio sugerido para |
PositionedObject
Es un objeto que está anclado a un Paragraph
y posicionado respecto al principio del párrafo. Un objeto PositionedObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
objectId |
El ID de este objeto posicionado. |
positionedObjectProperties |
Son las propiedades de este objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
Los cambios sugeridos para las propiedades del objeto posicionado, con clave por ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacía, entonces esta no es una inserción sugerida. |
suggestedDeletionIds[] |
Los ID de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
PositionedObjectProperties
Propiedades de un PositionedObject
Representación JSON |
---|
{ "positioning": { object ( |
Campos | |
---|---|
positioning |
El posicionamiento de este objeto posicionado en relación con la línea nueva del |
embeddedObject |
El objeto incorporado de este objeto posicionado. |
PositionedObjectPositioning
El posicionamiento de un PositionedObject
El objeto posicionado se posiciona de manera relativa al comienzo de la Paragraph
a la que se conecta.
Representación JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
El diseño de este objeto posicionado. |
leftOffset |
El desplazamiento del borde izquierdo del objeto posicionado en relación con el comienzo del |
topOffset |
El desplazamiento del borde superior del objeto posicionado en relación con el comienzo del |
PositionedObjectLayout
Posibles diseños de un objeto [PositionedObject][google.aps.docs.v1.PositionedObject].
Enumeraciones | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
El diseño no está especificado. |
WRAP_TEXT |
El texto se ajusta al objeto posicionado. |
BREAK_LEFT |
Divide el texto de modo que el objeto posicionado esté a la izquierda y el texto esté a la derecha. |
BREAK_RIGHT |
Divide el texto de modo que el objeto posicionado esté a la derecha y el texto esté a la izquierda. |
BREAK_LEFT_RIGHT |
Rompe el texto de modo que no haya texto a la izquierda o derecha del objeto posicionado. |
IN_FRONT_OF_TEXT |
El objeto posicionado está frente al texto. |
BEHIND_TEXT |
El objeto posicionado está detrás del texto. |
SuggestedPositionedObjectProperties
Un cambio sugerido para PositionedObjectProperties
.
Representación JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Una |
positionedObjectPropertiesSuggestionState |
Una máscara que indica cuáles de los campos del |
PositionedObjectPropertiesSuggestionState
Una máscara que indica cuáles de los campos del PositionedObjectProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioningSuggestionState |
Una máscara que indica cuáles de los campos de |
embeddedObjectSuggestionState |
Una máscara que indica cuáles de los campos de |
PositionedObjectPositioningSuggestionState
Una máscara que indica cuáles de los campos del PositionedObjectPositioning
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Campos | |
---|---|
layoutSuggested |
Indica si hubo un cambio sugerido para |
leftOffsetSuggested |
Indica si hubo un cambio sugerido para |
topOffsetSuggested |
Indica si hubo un cambio sugerido para |
SuggestionsViewMode
Es el modo de vista de sugerencias aplicado al documento y que indica cómo se representan los cambios sugeridos. Proporciona opciones para leer el documento con todas las sugerencias intercaladas, aceptadas o rechazadas.
Enumeraciones | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
El modo SuggestionsViewMode aplicado al documento devuelto depende del nivel de acceso actual del usuario. Si el usuario solo tiene acceso de lectura, se aplica PREVIEW_WITHOUT_SUGGESTIONS . De lo contrario, se aplica SUGGESTIONS_INLINE . Este es el modo de vista de sugerencias predeterminado. |
SUGGESTIONS_INLINE |
El documento que se muestra tiene sugerencias intercaladas. Los cambios sugeridos se diferenciarán del contenido base del documento. Las solicitudes para recuperar un documento con este modo mostrarán un error 403 si el usuario no tiene permiso para ver los cambios sugeridos. |
PREVIEW_SUGGESTIONS_ACCEPTED |
El documento que se muestra es una vista previa con todos los cambios sugeridos aceptados. Las solicitudes para recuperar un documento con este modo mostrarán un error 403 si el usuario no tiene permiso para ver los cambios sugeridos. |
PREVIEW_WITHOUT_SUGGESTIONS |
El documento que se muestra es una vista previa y todos los cambios sugeridos se rechazan si hay sugerencias. |
Métodos |
|
---|---|
|
Aplica una o más actualizaciones al documento. |
|
Crea un documento en blanco con el título proporcionado en la solicitud. |
|
Obtiene la versión más reciente del documento especificado. |