- Recurso: Document
- Tab
- TabProperties
- DocumentTab
- Body
- 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
- Header
- Pie de página
- Nota al pie
- DocumentStyle
- Antecedentes
- Tamaño
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- List
- 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: Document
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[] |
Son las pestañas que forman parte de un documento. Las pestañas pueden contener pestañas secundarias, es decir, una pestaña anidada dentro de otra. Las pestañas secundarias se representan con el campo |
revisionId |
Solo salida. Es el ID de revisión del documento. Se puede usar en solicitudes de actualización para especificar qué revisión de un documento se debe actualizar y cómo se debe comportar la solicitud si el documento se editó desde esa revisión. Solo se propaga 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. Se garantiza que un ID de revisión devuelto solo es válido durante 24 horas después de que se devolvió y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre las llamadas, significa que el documento no se modificó. Por el contrario, un ID cambiado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un cambio de ID también puede deberse a factores internos, como cambios 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. Encabezados del documento, con el ID del encabezado como clave. Campo heredado: En su lugar, usa |
footers |
Solo salida. Son los pies de página del documento, con clave según el ID del pie de página. Campo heredado: En su lugar, usa |
footnotes |
Solo salida. Son las notas al pie del documento, organizadas por ID. Campo heredado: En su lugar, usa |
documentStyle |
Solo salida. Es el estilo del documento. Campo heredado: En su lugar, usa |
suggestedDocumentStyleChanges |
Solo salida. Son los cambios sugeridos en el estilo del documento, con la clave del 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. Son los cambios sugeridos en los estilos con nombre del documento, organizados por ID de sugerencia. Campo heredado: En su lugar, usa |
lists |
Solo salida. Son las listas del documento, con el ID de la lista como clave. Campo heredado: En su lugar, usa |
namedRanges |
Solo salida. Son los rangos con nombre del documento, con el nombre como clave. Campo heredado: En su lugar, usa |
inlineObjects |
Solo salida. Son los objetos intercalados en el documento, con el ID del objeto como clave. Campo heredado: En su lugar, usa |
positionedObjects |
Solo salida. Objetos posicionados en el documento, con el ID del objeto como clave. Campo heredado: En su lugar, usa |
Pestaña
Es una pestaña en un documento.
Representación JSON |
---|
{ "tabProperties": { object ( |
Campos | |
---|---|
tabProperties |
Son las propiedades de la pestaña, como el ID y el título. |
childTabs[] |
Son las pestañas secundarias anidadas dentro de esta pestaña. |
Campo de unión content . Es el contenido de la pestaña. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
documentTab |
Una pestaña con el contenido del documento, como texto e imágenes |
TabProperties
Son las propiedades de una pestaña.
Representación JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
Campos | |
---|---|
tabId |
Solo salida. Es el ID de la pestaña. No se puede cambiar este campo. |
title |
Es el nombre visible para el usuario de la pestaña. |
parentTabId |
Opcional. Es el ID de la pestaña principal. Está vacío cuando la pestaña actual es de nivel raíz, lo que significa que no tiene elementos superiores. |
index |
Índice basado en cero de la pestaña dentro del elemento principal. |
nestingLevel |
Solo salida. Profundidad de la pestaña dentro del documento. Las pestañas de nivel raíz comienzan en 0. |
DocumentTab
Es una pestaña con el contenido del documento.
Representación JSON |
---|
{ "body": { object ( |
Campos | |
---|---|
body |
Es el cuerpo principal de la pestaña del documento. |
headers |
Encabezados en la pestaña del documento, con la clave del ID del encabezado. |
footers |
Son los pies de página de la pestaña del documento, con la clave del ID del pie de página. |
footnotes |
Son las notas al pie de la pestaña del documento, con la clave del ID de la nota al pie. |
documentStyle |
Es el estilo de la pestaña del documento. |
suggestedDocumentStyleChanges |
Son los cambios sugeridos en el estilo de la pestaña del documento, con la clave del ID de sugerencia. |
namedStyles |
Son los estilos con nombre de la pestaña del documento. |
suggestedNamedStylesChanges |
Son los cambios sugeridos en los estilos con nombre de la pestaña del documento, con la clave del ID de sugerencia. |
lists |
Son las listas de la pestaña del documento, con el ID de la lista como clave. |
namedRanges |
Son los rangos con nombre en la pestaña del documento, organizados por nombre. |
inlineObjects |
Son los objetos intercalados en la pestaña del documento, con el ID del objeto como clave. |
positionedObjects |
Son los objetos posicionados en la pestaña del documento, con el ID del objeto como clave. |
Cuerpo
Es el cuerpo del documento.
Por lo general, el cuerpo contiene el contenido completo del documento, excepto headers
, footers
y footnotes
.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
Es el contenido del cuerpo. Los índices del contenido del cuerpo comienzan en cero. |
StructuralElement
Un StructuralElement describe el contenido que proporciona estructura al documento.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
Índice de inicio basado en cero de este elemento estructural, en unidades de código UTF-16. |
endIndex |
Í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 elemento estructural de índice. |
Párrafo
Es un objeto StructuralElement
que representa un párrafo. Un párrafo es un rango de contenido que termina con un carácter de salto de línea.
Representación JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
Es el contenido del párrafo, desglosado en sus partes componentes. |
paragraphStyle |
Es el estilo de este párrafo. |
suggestedParagraphStyleChanges |
Es el estilo de párrafo sugerido que se aplica a este párrafo, con la clave del ID de sugerencia. |
bullet |
Viñeta de este párrafo. Si no está presente, el párrafo no pertenece a una lista. |
suggestedBulletChanges |
Son los cambios sugeridos en la viñeta de este párrafo. |
positionedObjectIds[] |
Son los IDs de los objetos posicionados que están vinculados a este párrafo. |
suggestedPositionedObjectIds |
Son los IDs de los objetos posicionados que se sugieren para adjuntarse a este párrafo, con el ID de sugerencia como clave. |
ParagraphElement
Un ParagraphElement describe el contenido dentro 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 |
Índice final basado en 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 |
Es un elemento de párrafo de texto automático. |
pageBreak |
Es un elemento de párrafo de salto de página. |
columnBreak |
Es un elemento de párrafo de salto de columna. |
footnoteReference |
Es un elemento de párrafo de referencia de nota al pie. |
horizontalRule |
Es un elemento de párrafo de regla horizontal. |
equation |
Es un elemento de párrafo de ecuación. |
inlineObjectElement |
Es un elemento de párrafo de objeto intercalado. |
person |
Es un elemento de párrafo que vincula 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
Un ParagraphElement
que representa una ejecución de texto que tiene el mismo diseño.
Representación JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
Es el texto de esta ejecución. Los elementos que no son de texto en la ejecución se reemplazan por el carácter Unicode U+E907. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs 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 |
Es el estilo de texto sugerido que cambia en esta ejecución, con la clave del ID de sugerencia. |
TextStyle
Representa el diseño que se puede aplicar al texto.
Los estilos de texto heredados se representan como campos no establecidos en este mensaje. El elemento superior de un estilo de texto depende de dónde se defina el estilo de texto:
- El TextStyle del texto en un
Paragraph
hereda elnamed style type
correspondiente del párrafo. - El TextStyle en un
named style
hereda del estilo con nombrenormal text
. - El TextStyle del estilo con nombre
normal text
hereda del estilo de texto predeterminado en el editor de Documentos. - El TextStyle en un elemento
Paragraph
que se encuentra en una tabla puede heredar su estilo de texto del estilo de la tabla.
Si el estilo de texto no hereda de un elemento superior, anular la configuración de los campos restablecerá el estilo a un valor que coincida con los valores predeterminados en el 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 letras pequeñas capitalizadas. |
backgroundColor |
Es el color de fondo del texto. Si se configura, el color es RGB o transparente, según el campo |
foregroundColor |
Es el color de primer plano del texto. Si se configura, el color es RGB o transparente, según el campo |
fontSize |
Tamaño de la fuente del texto |
weightedFontFamily |
Familia de fuentes y grosor renderizado del texto. Si una solicitud de actualización especifica valores para Si no se establece Si se establece |
baselineOffset |
Es el desplazamiento vertical del texto desde su posición normal. El texto con desplazamientos de la línea de base |
link |
Es el destino del hipervínculo del texto. Si no se configura, no habrá ningún vínculo. Los vínculos no se heredan del texto principal. Cambiar el vínculo en una solicitud de actualización provoca otros cambios en el estilo de texto del rango:
|
OptionalColor
Es un color que puede ser completamente opaco o completamente transparente.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Si se configura, se usará como un color opaco. Si no se configura, representa un color transparente. |
Color
Un color sólido.
Representación JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
Es el valor de color RGB. |
RgbColor
Es un color RGB.
Representación JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
Es el componente rojo del color, de 0.0 a 1.0. |
green |
Componente verde del color, de 0.0 a 1.0. |
blue |
Componente azul del color, de 0.0 a 1.0. |
Dimensión
Es una magnitud en una sola dirección en las unidades especificadas.
Representación JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Campos | |
---|---|
magnitude |
Es la magnitud. |
unit |
Unidades de magnitud. |
Unidad
Unidades de medida.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Se desconocen las unidades. |
PT |
Un punto, 1/72 de pulgada. |
WeightedFontFamily
Representa una familia y un peso de fuente de texto.
Representación JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
fontFamily |
Es la familia de fuentes del texto. La familia de fuentes puede ser cualquiera del menú Fuente en Documentos o de Google Fonts. Si no se reconoce el nombre de la fuente, el texto se renderiza en |
weight |
El grosor de la fuente. Este campo puede tener cualquier valor que sea un 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 del valor
|
BaselineOffset
Son las formas en que el texto se puede desplazar verticalmente desde su posición normal.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
El desplazamiento de la línea base del texto se hereda del elemento principal. |
NONE |
El texto no tiene un desplazamiento vertical. |
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 de 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 |
Es una URL externa. |
tabId |
Es el ID de una pestaña en este documento. |
bookmark |
Es un marcador en este documento. En los documentos que contienen una sola pestaña, los vínculos a marcadores dentro de la pestaña singular siguen devolviendo |
heading |
Es un encabezado en este documento. En los documentos que contienen una sola pestaña, los vínculos a los encabezados dentro de la pestaña singular siguen devolviendo |
bookmarkId |
Es el ID de un marcador en este documento. Campo heredado: En su lugar, configura Si este campo se usa en una solicitud de escritura, se considera que el marcador proviene del ID de la pestaña especificado en la solicitud. Si no se especifica un ID de pestaña en la solicitud, se considera que proviene de la primera pestaña del documento. |
headingId |
Es el ID de un encabezado en este documento. Campo heredado: En su lugar, configura Si este campo se usa en una solicitud de escritura, se considera que el encabezado proviene del ID de la pestaña especificado en la solicitud. Si no se especifica un ID de pestaña en la solicitud, se considera que proviene de la primera pestaña del documento. |
BookmarkLink
Es una referencia a un marcador en este documento.
Representación JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
Es el ID de un marcador en este documento. |
tabId |
Es el ID de la pestaña que contiene este marcador. |
HeadingLink
Es una referencia a un encabezado de este documento.
Representación JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
Es el ID de un encabezado en este documento. |
tabId |
Es el ID de la pestaña que contiene este encabezado. |
SuggestedTextStyle
Es un cambio sugerido en un TextStyle
.
Representación JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Es un objeto |
textStyleSuggestionState |
Es una máscara que indica cuáles de los campos del |
TextStyleSuggestionState
Es una máscara que indica cuáles de los campos del TextStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en |
italicSuggested |
Indica si hubo un cambio sugerido en |
underlineSuggested |
Indica si hubo un cambio sugerido en |
strikethroughSuggested |
Indica si hubo un cambio sugerido en |
smallCapsSuggested |
Indica si hubo un cambio sugerido en |
backgroundColorSuggested |
Indica si hubo un cambio sugerido en |
foregroundColorSuggested |
Indica si hubo un cambio sugerido en |
fontSizeSuggested |
Indica si hubo un cambio sugerido en |
weightedFontFamilySuggested |
Indica si hubo un cambio sugerido en |
baselineOffsetSuggested |
Indica si hubo un cambio sugerido en |
linkSuggested |
Indica si hubo un cambio sugerido en |
AutoText
Un ParagraphElement
que representa un punto 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 texto automático. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs 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 |
Es el estilo de texto sugerido que cambia a este AutoText, con la clave del ID de sugerencia. |
Tipo
Son los tipos de texto automático.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Es un tipo de texto automático sin especificar. |
PAGE_NUMBER |
Es el tipo de texto automático que representa el número de página actual. |
PAGE_COUNT |
Es el tipo de texto automático que representa la cantidad total de páginas del documento. |
PageBreak
Un 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[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este PageBreak. 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, así como el estilo del texto insertado junto a él. |
suggestedTextStyleChanges |
Es el estilo de texto sugerido que cambia a este PageBreak, con la clave del ID de sugerencia. |
ColumnBreak
Es un objeto ParagraphElement
que representa un salto de columna. Un salto de columna hace que el texto siguiente comience en la parte superior de la columna siguiente.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este ColumnBreak. 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, así como el diseño del texto insertado junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este ColumnBreak, con la clave del 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 que se renderiza 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 |
ID del objeto |
footnoteNumber |
Es el número renderizado de esta nota al pie. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este FootnoteReference. |
suggestedTextStyleChanges |
Es el estilo de texto sugerido que cambia a esta FootnoteReference, con la clave del ID de sugerencia. |
HorizontalRule
Un ParagraphElement
que representa una línea horizontal.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
textStyle |
Es el estilo de texto de este HorizontalRule. Al igual que 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, así como el diseño del texto insertado junto a ella. |
suggestedTextStyleChanges |
Es el estilo de texto sugerido que cambia a este HorizontalRule, con la clave del ID de sugerencia. |
Ecuación
Es un objeto ParagraphElement
que representa una ecuación.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
InlineObjectElement
Un ParagraphElement
que contiene un InlineObject
.
Representación JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inlineObjectId |
Es el ID del |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs 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, así como el diseño del texto insertado junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este InlineObject, con la clave del ID de sugerencia. |
Persona
Es una persona o una dirección de correo electrónico mencionada en un documento. Estas menciones se comportan como un solo elemento inmutable 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. Es el ID único de este vínculo. |
suggestedInsertionIds[] |
Son los IDs de las sugerencias que insertan este vínculo de persona en el documento. Un |
suggestedDeletionIds[] |
Son los IDs de las sugerencias que quitan la vinculación de esta persona del documento. Un |
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
Son las propiedades específicas de un objeto Person
vinculado.
Representación JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
Es el nombre de la persona si se muestra en el texto del vínculo en lugar de la dirección de correo electrónico. |
email |
Es la dirección de correo electrónico vinculada a este |
RichLink
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[] |
Son los IDs de las sugerencias que quitan este vínculo del documento. Un |
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
Son las propiedades específicas de un RichLink
.
Representación JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Solo salida. Es el título del |
uri |
Solo salida. Es el URI del |
mimeType |
Solo salida. Tipo de MIME del |
ParagraphStyle
Son los estilos que se aplican a un párrafo completo.
Los estilos de párrafo heredados se representan como campos no establecidos en este mensaje. El elemento superior de un estilo de párrafo depende de dónde se defina el estilo de párrafo:
- El objeto ParagraphStyle de un objeto
Paragraph
hereda del objetonamed style type
correspondiente del párrafo. - El objeto ParagraphStyle en un
named style
hereda del estilo con nombrenormal text
. - El objeto ParagraphStyle del estilo con nombre
normal text
hereda del estilo de párrafo predeterminado en el editor de Documentos. - El objeto ParagraphStyle de un elemento
Paragraph
que se incluye en una tabla puede heredar su estilo de párrafo del estilo de la tabla.
Si el estilo de párrafo no hereda de un elemento superior, al anular la configuración de los campos, el estilo volverá a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
Es el ID del encabezado del párrafo. Si está vacío, este párrafo no es un encabezado. Esta propiedad es de solo lectura. |
namedStyleType |
Es el tipo de estilo con nombre del párrafo. Dado que la actualización del tipo de estilo con nombre afecta a otras propiedades dentro de ParagraphStyle, el tipo de estilo con nombre se aplica antes de que se actualicen las demás propiedades. |
alignment |
Es la alineación del texto de este párrafo. |
lineSpacing |
Es la cantidad de espacio entre las líneas, expresada como un porcentaje de lo normal, donde lo normal se representa como 100.0. Si no se configura, el valor se hereda del elemento superior. |
direction |
Es la dirección del texto de este párrafo. Si no se configura, el valor predeterminado es |
spacingMode |
Es el modo de espaciado del párrafo. |
spaceAbove |
Cantidad de espacio adicional sobre el párrafo. Si no se configura, el valor se hereda del elemento superior. |
spaceBelow |
Cantidad de espacio adicional debajo del párrafo. Si no se configura, el valor se hereda del elemento superior. |
borderBetween |
Borde entre este párrafo y los párrafos anterior y siguiente. Si no se configura, el valor se hereda del elemento superior. El borde intermedio se renderiza cuando el párrafo adyacente tiene las mismas propiedades de borde y sangría. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad. |
borderTop |
Es el borde en la parte superior de este párrafo. Si no se configura, el valor se hereda del elemento superior. El borde superior se renderiza cuando el párrafo anterior tiene diferentes propiedades de borde y sangría. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad. |
borderBottom |
El borde en la parte inferior de este párrafo. Si no se configura, el valor se hereda del elemento superior. El borde inferior se renderiza cuando el párrafo siguiente tiene diferentes propiedades de borde y sangría. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad. |
borderLeft |
Es el borde a la izquierda de este párrafo. Si no se configura, el valor se hereda del elemento superior. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad. |
borderRight |
Es el borde a la derecha de este párrafo. Si no se configura, el valor se hereda del elemento superior. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad. |
indentFirstLine |
Es la cantidad de sangría de la primera línea del párrafo. Si no se configura, el valor se hereda 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 se configura, el valor se hereda 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 se configura, el valor se hereda del elemento superior. |
tabStops[] |
Es una lista de las tabulaciones de este párrafo. La lista de tabulaciones no se hereda. Esta propiedad es de solo lectura. |
keepLinesTogether |
Indica si todas las líneas del párrafo deben diseñarse en la misma página o columna, si es posible. Si no se configura, el valor se hereda del elemento superior. |
keepWithNext |
Indica si, de ser posible, al menos una parte de este párrafo debe diseñarse en la misma página o columna que el siguiente. Si no se configura, el valor se hereda del elemento superior. |
avoidWidowAndOrphan |
Indica si se deben evitar las viudas y los huérfanos en el párrafo. Si no se configura, el valor se hereda del elemento superior. |
shading |
Es el sombreado del párrafo. Si no se configura, el valor se hereda del elemento superior. |
pageBreakBefore |
Indica si el párrafo actual siempre debe comenzar al principio de una página. Si no se configura, el valor se hereda del elemento superior. Si intentas actualizar |
NamedStyleType
Son los tipos de estilos con nombre.
Enums | |
---|---|
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 |
Título 2. |
HEADING_3 |
Título 3. |
HEADING_4 |
Título 4. |
HEADING_5 |
Encabezado 5. |
HEADING_6 |
Título 6. |
Alineación
Son los tipos de alineación de texto para un párrafo.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
La alineación del párrafo se hereda del elemento superior. |
START |
El párrafo está alineado con el inicio de la línea. Alineado a la izquierda para texto LTR y a la derecha en otros casos. |
CENTER |
El párrafo está centrado. |
END |
El párrafo está alineado con el final de la línea. Alineado a la derecha para el texto LTR y alineado a la izquierda en otros casos. |
JUSTIFIED |
El párrafo está justificado. |
ContentDirection
El contenido de las instrucciones sobre cómo llegar puede fluir.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
No se especificó 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
Son los diferentes modos de espaciado entre párrafos.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED |
El modo de espaciado se hereda del elemento principal. |
NEVER_COLLAPSE |
El espaciado de párrafo siempre se renderiza. |
COLLAPSE_LISTS |
Se omite el espaciado entre párrafos entre los elementos de la lista. |
ParagraphBorder
Es un borde alrededor de un párrafo.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
Es el color del borde. |
width |
Es el ancho del borde. |
padding |
Padding del borde. |
dashStyle |
Es el estilo de guiones del borde. |
DashStyle
Tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el tipo simple "ST_PresetLineDashVal" que se describe en la sección 20.1.10.49 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de ECMA-376, 5ª edición.
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED |
Es un estilo de guion sin especificar. |
SOLID |
Línea continua. Corresponde al valor "solid" de ST_PresetLineDashVal de ECMA-376. Este es el estilo de guion predeterminado. |
DOT |
Línea punteada. Corresponde al valor "dot" de ECMA-376 ST_PresetLineDashVal. |
DASH |
Línea punteada. Corresponde al valor "dash" de ECMA-376 ST_PresetLineDashVal. |
TabStop
Es una parada de tabulación dentro de un párrafo.
Representación JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
Es el desplazamiento entre esta parada de tabulación y el margen inicial. |
alignment |
Es la alineación de esta parada de tabulación. Si no se establece, el valor predeterminado es |
TabStopAlignment
Es la alineación de la parada de tabulación.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
La alineación de la parada de tabulación no está especificada. |
START |
La parada de tabulación se alinea con el inicio de la línea. Esta es la opción predeterminada. |
CENTER |
El tabulador está alineado con el centro de la línea. |
END |
La parada de tabulación está alineada con el final de la línea. |
Sombreado
Es el sombreado de un párrafo.
Representación JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
backgroundColor |
Es el color de fondo del sombreado de este párrafo. |
SuggestedParagraphStyle
Es un cambio sugerido en un ParagraphStyle
.
Representación JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Es un objeto |
paragraphStyleSuggestionState |
Es una máscara que indica cuáles de los campos del |
ParagraphStyleSuggestionState
Es una máscara que indica cuáles de los campos del ParagraphStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en |
namedStyleTypeSuggested |
Indica si hubo un cambio sugerido en |
alignmentSuggested |
Indica si hubo un cambio sugerido en |
lineSpacingSuggested |
Indica si hubo un cambio sugerido en |
directionSuggested |
Indica si hubo un cambio sugerido en |
spacingModeSuggested |
Indica si hubo un cambio sugerido en |
spaceAboveSuggested |
Indica si hubo un cambio sugerido en |
spaceBelowSuggested |
Indica si hubo un cambio sugerido en |
borderBetweenSuggested |
Indica si hubo un cambio sugerido en |
borderTopSuggested |
Indica si hubo un cambio sugerido en |
borderBottomSuggested |
Indica si hubo un cambio sugerido en |
borderLeftSuggested |
Indica si hubo un cambio sugerido en |
borderRightSuggested |
Indica si hubo un cambio sugerido en |
indentFirstLineSuggested |
Indica si hubo un cambio sugerido en |
indentStartSuggested |
Indica si hubo un cambio sugerido en |
indentEndSuggested |
Indica si hubo un cambio sugerido en |
keepLinesTogetherSuggested |
Indica si hubo un cambio sugerido en |
keepWithNextSuggested |
Indica si hubo un cambio sugerido en |
avoidWidowAndOrphanSuggested |
Indica si hubo un cambio sugerido en |
shadingSuggestionState |
Es una máscara que indica cuáles de los campos de |
pageBreakBeforeSuggested |
Indica si hubo un cambio sugerido en |
ShadingSuggestionState
Es una máscara que indica cuáles de los campos del objeto Shading
base se modificaron en este cambio sugerido. Para cualquier campo establecido 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 |
ID de la lista a la que pertenece este párrafo. |
nestingLevel |
Es el nivel de anidación de este párrafo en la lista. |
textStyle |
Es el estilo de texto específico del párrafo que se aplica a esta viñeta. |
SuggestedBullet
Es un cambio sugerido en un Bullet
.
Representación JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Es un objeto |
bulletSuggestionState |
Es una máscara que indica cuáles de los campos del |
BulletSuggestionState
Es una máscara que indica cuáles de los campos del Bullet
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 |
Es una máscara que indica cuáles de los campos de |
ObjectReferences
Es una colección de IDs de objetos.
Representación JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
objectIds[] |
Son los IDs de los objetos. |
SectionBreak
Es un 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 sección se aplica a la sección 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[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
sectionStyle |
Es el estilo de la sección posterior a este salto de sección. |
SectionStyle
Es el diseño que se aplica a una sección.
Representación JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
columnProperties[] |
Son las propiedades de las columnas de la sección. Si está vacío, la sección contiene una columna con las propiedades predeterminadas en el editor de Documentos. Se puede actualizar una sección para que tenga no más de 3 columnas. Cuando actualices esta propiedad, deberás establecer un valor concreto. Si no se configura esta propiedad, se generará un error 400 de solicitud incorrecta. |
columnSeparatorStyle |
Es el estilo de los separadores de columnas. Este estilo se puede establecer incluso cuando hay una columna en la sección. Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
contentDirection |
Es la dirección del contenido de esta sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
marginTop |
Es el margen superior de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce 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 actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
marginRight |
Es el margen derecho de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
marginLeft |
Es el margen izquierdo de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
marginHeader |
Es el margen del encabezado de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
marginFooter |
Es el margen del pie de página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
sectionType |
Solo salida. Es el tipo de sección. |
defaultHeaderId |
Es el ID del encabezado predeterminado. Si no se configura, el valor se hereda del Esta propiedad es de solo lectura. |
defaultFooterId |
ID del pie de página predeterminado. Si no se configura, el valor se hereda del Esta propiedad es de solo lectura. |
firstPageHeaderId |
Es 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 |
Es 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 |
Es el ID del encabezado que se usa solo para las 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 las 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 para la primera página de la sección. Si no se configura, hereda el valor de Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
pageNumberStart |
Número de página desde el que se comienza a contar la cantidad de páginas de esta sección. Si no se configura, la numeración de página continúa desde la sección anterior. Si el valor no está establecido en el primer Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
flipPageOrientation |
Opcional. Indica si se deben invertir las dimensiones de Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta. |
SectionColumnProperties
Son las propiedades que se aplican a la columna de una sección.
Representación JSON |
---|
{ "width": { object ( |
Campos | |
---|---|
width |
Solo salida. Es el ancho de la columna. |
paddingEnd |
Es el padding al final de la columna. |
ColumnSeparatorStyle
Es el estilo de los separadores de columnas.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Es un estilo de separador de columnas no especificado. |
NONE |
No hay líneas de separación entre las columnas. |
BETWEEN_EACH_COLUMN |
Renderiza una línea de separación entre cada columna. |
SectionType
Representa la posición del inicio de la sección actual en relación con la sección anterior.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED |
No se especificó el tipo de sección. |
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
Es 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 en la tabla. Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad diferente de celdas. |
tableRows[] |
Contenido y estilo de cada fila. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
tableStyle |
Es el estilo de la tabla. |
Fila de la tabla
Es 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 |
Í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 de la misma tabla. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
tableRowStyle |
Es el estilo de la fila de la tabla. |
suggestedTableRowStyleChanges |
Cambios de diseño sugeridos para esta fila, con la clave del ID de sugerencia. |
TableCell
Es el contenido y el estilo de una celda en un Table
.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
Índice de inicio basado en cero de esta celda, en unidades de código UTF-16. |
endIndex |
Í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[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
suggestedTableCellStyleChanges |
Son los cambios sugeridos en el estilo de la celda de la tabla, con el ID de sugerencia como clave. |
TableCellStyle
Es el estilo de un TableCell
.
Los estilos de celdas de tablas heredados se representan como campos no establecidos en este mensaje. El estilo de una celda de la tabla puede heredarse del estilo de la tabla.
Representación JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Campos | |
---|---|
rowSpan |
Es el tramo de filas de la celda. Esta propiedad es de solo lectura. |
columnSpan |
Es la extensión de la columna de la celda. Esta propiedad es de solo lectura. |
backgroundColor |
Es el color de fondo de la celda. |
borderLeft |
Es el borde izquierdo de la celda. |
borderRight |
Es el borde derecho de la celda. |
borderTop |
Es el borde superior de la celda. |
borderBottom |
Es el borde inferior de la celda. |
paddingLeft |
Es el padding izquierdo de la celda. |
paddingRight |
Es el padding derecho de la celda. |
paddingTop |
Es el padding superior de la celda. |
paddingBottom |
Es el padding inferior de la celda. |
contentAlignment |
Es la alineación del contenido en la celda de la tabla. La alineación predeterminada coincide con la alineación de las celdas de tabla recién creadas en el editor de Documentos. |
TableCellBorder
Es 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 una celda de la tabla, establece su ancho en 0.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
Es el color del borde. Este color no puede ser transparente. |
width |
Es el ancho del borde. |
dashStyle |
Es el estilo de guiones del borde. |
ContentAlignment
Son los tipos de alineación del contenido.
Se deriva de un subconjunto de los valores del tipo simple "ST_TextAnchoringType" en la sección 20.1.10.60 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de ECMA-376, 5ª edición.
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Es una alineación de contenido no especificada. La alineación del contenido se hereda del elemento principal, si existe. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Es una alineación de contenido no admitida. |
TOP |
Es una alineación que alinea el contenido con la parte superior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "t". |
MIDDLE |
Es una alineación que alinea el contenido al centro del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "ctr". |
BOTTOM |
Es una alineación que alinea el contenido a la parte inferior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "b". |
SuggestedTableCellStyle
Es un cambio sugerido en un TableCellStyle
.
Representación JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Es un objeto |
tableCellStyleSuggestionState |
Es una máscara que indica cuáles de los campos del |
TableCellStyleSuggestionState
Es una máscara que indica cuáles de los campos del TableCellStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en |
columnSpanSuggested |
Indica si hubo un cambio sugerido en |
backgroundColorSuggested |
Indica si hubo un cambio sugerido en |
borderLeftSuggested |
Indica si hubo un cambio sugerido en |
borderRightSuggested |
Indica si hubo un cambio sugerido en |
borderTopSuggested |
Indica si hubo un cambio sugerido en |
borderBottomSuggested |
Indica si hubo un cambio sugerido en |
paddingLeftSuggested |
Indica si hubo un cambio sugerido en |
paddingRightSuggested |
Indica si hubo un cambio sugerido en |
paddingTopSuggested |
Indica si hubo un cambio sugerido en |
paddingBottomSuggested |
Indica si hubo un cambio sugerido en |
contentAlignmentSuggested |
Indica si hubo un cambio sugerido en |
TableRowStyle
Son los diseños que se aplican a una fila de la tabla.
Representación JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
Es la altura mínima de la fila. La fila se renderizará en el editor de Documentos con 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 desbordarse más allá de los límites de la página o la columna. |
SuggestedTableRowStyle
Es un cambio sugerido en un TableRowStyle
.
Representación JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Es un objeto |
tableRowStyleSuggestionState |
Es una máscara que indica cuáles de los campos del |
TableRowStyleSuggestionState
Es una máscara que indica cuáles de los campos del TableRowStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
minRowHeightSuggested |
Indica si hubo un cambio sugerido en |
TableStyle
Son los diseños que se aplican a una tabla.
Representación JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
tableColumnProperties[] |
Son las propiedades de cada columna. Ten en cuenta que, en Documentos, las tablas contienen filas y las filas contienen celdas, de manera similar a HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el |
TableColumnProperties
Son las propiedades de una columna en una tabla.
Representación JSON |
---|
{ "widthType": enum ( |
Campos | |
---|---|
widthType |
Es el tipo de ancho de la columna. |
width |
Es el ancho de la columna. Se establece cuando el |
WidthType
Es el tipo de ancho de la columna.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
No se especificó el tipo de ancho de columna. |
EVENLY_DISTRIBUTED |
El ancho de la 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 de la tabla después de tener en cuenta todas las columnas con anchos especificados. |
FIXED_WIDTH |
Ancho de columna fijo. La propiedad [width][google.apps.docs.v1.TableColumnProperties.width contiene el ancho de la columna. |
TableOfContents
Un StructuralElement
que representa un índice.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
Es el contenido del índice. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
Encabezado
Es el encabezado de un documento.
Representación JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
headerId |
Es el ID del encabezado. |
content[] |
Es el contenido del encabezado. Los índices del contenido de un encabezado comienzan en cero. |
Nota a pie de página
Es 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[] |
Es 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 |
Es el fondo del documento. Los documentos no pueden tener un color de fondo transparente. |
defaultHeaderId |
Es el ID del encabezado predeterminado. Si no se establece, no hay un encabezado predeterminado. Esta propiedad es de solo lectura. |
defaultFooterId |
ID del pie de página predeterminado. Si no se establece, no habrá un pie de página predeterminado. Esta propiedad es de solo lectura. |
evenPageHeaderId |
Es el ID del encabezado que se usa solo para las 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 las páginas pares. El valor de Esta propiedad es de solo lectura. |
firstPageHeaderId |
Es el ID del encabezado que se usa solo para la primera página. Si no se configura, 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 se configura, no existirá 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 para la primera página. |
useEvenPageHeaderFooter |
Indica si se deben usar los IDs de encabezado o pie de página de las páginas pares para las páginas pares. |
pageNumberStart |
Número de página desde el que se comienza a contar la cantidad de páginas. |
marginTop |
Es 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 |
Es el margen inferior de la página. Si actualizas el margen inferior de la página en el estilo del documento, se borrará el margen inferior de la página en todos los estilos de sección. |
marginRight |
Es el margen derecho de la página. Si actualizas el margen derecho de la página en el estilo del documento, se borrará el margen derecho de la página en todos los estilos de sección. También puede hacer que las columnas cambien de tamaño en todas las secciones. |
marginLeft |
Es el margen izquierdo de la página. Si actualizas el margen izquierdo de la página en el estilo del documento, se borrará el margen izquierdo de la página en todos los estilos de sección. También puede hacer que las columnas cambien de tamaño en todas las secciones. |
pageSize |
Es el tamaño de una página del documento. |
marginHeader |
Es 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 DocumentStyle Esta propiedad es de solo lectura. |
flipPageOrientation |
Opcional. Indica si se deben invertir las dimensiones de |
Fondo
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 |
Es la altura del objeto. |
width |
Es el ancho del objeto. |
SuggestedDocumentStyle
Es un cambio sugerido para DocumentStyle
.
Representación JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
documentStyle |
Es un objeto |
documentStyleSuggestionState |
Es una máscara que indica cuáles de los campos del |
DocumentStyleSuggestionState
Es una máscara que indica cuáles de los campos del DocumentStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
backgroundSuggestionState |
Es una máscara que indica cuáles de los campos de |
defaultHeaderIdSuggested |
Indica si hubo un cambio sugerido en |
defaultFooterIdSuggested |
Indica si hubo un cambio sugerido en |
evenPageHeaderIdSuggested |
Indica si hubo un cambio sugerido en |
evenPageFooterIdSuggested |
Indica si hubo un cambio sugerido en |
firstPageHeaderIdSuggested |
Indica si hubo un cambio sugerido en |
firstPageFooterIdSuggested |
Indica si hubo un cambio sugerido en |
useFirstPageHeaderFooterSuggested |
Indica si hubo un cambio sugerido en |
useEvenPageHeaderFooterSuggested |
Indica si hubo un cambio sugerido en |
pageNumberStartSuggested |
Indica si hubo un cambio sugerido en |
marginTopSuggested |
Indica si hubo un cambio sugerido en |
marginBottomSuggested |
Indica si hubo un cambio sugerido en |
marginRightSuggested |
Indica si hubo un cambio sugerido en |
marginLeftSuggested |
Indica si hubo un cambio sugerido en |
pageSizeSuggestionState |
Máscara que indica cuáles de los campos de [size] [google.apps.docs.v1.DocumentStyle.size] se cambiaron en esta sugerencia. |
marginHeaderSuggested |
Indica si hubo un cambio sugerido en |
marginFooterSuggested |
Indica si hubo un cambio sugerido en |
useCustomHeaderFooterMarginsSuggested |
Indica si hubo un cambio sugerido en |
flipPageOrientationSuggested |
Opcional. Indica si hubo un cambio sugerido en |
BackgroundSuggestionState
Es una máscara que indica cuáles de los campos del Background
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, Backgound
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si se modificó el color de fondo actual en esta sugerencia. |
SizeSuggestionState
Es una máscara que indica cuáles de los campos del Size
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, Size
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
heightSuggested |
Indica si hubo un cambio sugerido en |
widthSuggested |
Indica si hubo un cambio sugerido en |
NamedStyles
Son 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[] |
Son los estilos con nombre. Hay una entrada para cada uno de los |
NamedStyle
Es un estilo con nombre. Los párrafos del documento pueden heredar sus TextStyle
y ParagraphStyle
de este estilo con nombre cuando 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
Es un cambio sugerido para NamedStyles
.
Representación JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Es un objeto |
namedStylesSuggestionState |
Es 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[] |
Máscara que indica cuáles de los campos del objeto El orden de estos estados de sugerencia de estilo con nombre coincide con el orden del estilo con nombre correspondiente dentro de la sugerencia |
NamedStyleSuggestionState
Es el estado de sugerencia de un mensaje NamedStyle
.
Representación JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
Es el tipo de diseño con nombre al que corresponde este estado de sugerencia. Este campo se proporciona para facilitar la coincidencia de NamedStyleSuggestionState con su |
textStyleSuggestionState |
Es una máscara que indica cuáles de los campos de |
paragraphStyleSuggestionState |
Es una máscara que indica cuáles de los campos de |
Lista
Un objeto List representa los atributos de lista para 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 |
Son los cambios sugeridos en las propiedades de la lista, con el ID de sugerencia como clave. |
suggestedInsertionId |
Es el ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida. |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias de borrado para esta lista. |
ListProperties
Son las propiedades de un objeto list
que describen el aspecto de las viñetas pertenecientes 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, en los que el nivel 0 corresponde al nivel superior y el nivel 8, al nivel más anidado. Los niveles de anidación se devuelven en orden ascendente, y primero se devuelve el menos anidado. |
NestingLevel
Contiene propiedades que describen el aspecto de una viñeta de lista en un nivel de anidación determinado.
Representación JSON |
---|
{ "bulletAlignment": enum ( |
Campos | |
---|---|
bulletAlignment |
Es la alineación de la viñeta dentro del espacio asignado para renderizarla. |
glyphFormat |
Es 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, y estos se reemplazan por los valores adecuados según el Por ejemplo, el formato de glifo
El formato de glifo puede contener marcadores de posición para el nivel de anidación actual y para los niveles de anidación superiores. Por ejemplo, una lista puede tener un formato de glifo de
En el caso de los niveles de anidación ordenados, la cadena que reemplaza un marcador de posición en el formato de glifo para un párrafo en particular depende del orden del párrafo dentro de la lista. |
indentFirstLine |
Es la cantidad de sangría para la primera línea de los 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 al lado que corresponde al inicio del texto, según la dirección del contenido del párrafo. |
textStyle |
Es el estilo de texto de las viñetas en este nivel de anidación. |
startNumber |
Es el número del primer elemento de la lista en este nivel de anidamiento. Un valor de 0 se trata como un valor de 1 para las listas con letras y números romanos. Para los valores 0 y 1, las listas con letras y números romanos comenzarán en Este valor se ignora para los niveles de anidación con glifos no ordenados. |
Campo de unión glyph_kind . Es el tipo de glifo que se usa en las viñetas. Define el glifo de viñeta que reemplaza los marcadores de posición en glyph_format . glyph_kind puede ser solo uno de los siguientes: |
|
glyphType |
Es el tipo de glifo que se usa en las viñetas cuando los párrafos de este nivel de anidamiento están ordenados. El tipo de glifo determina el tipo de glifo que se usa para reemplazar los marcadores de posición dentro de |
glyphSymbol |
Es un símbolo de glifo personalizado que usan las viñetas cuando los párrafos de este nivel de anidación no están ordenados. El símbolo de glifo reemplaza los marcadores de posición dentro de |
BulletAlignment
Son los tipos de alineación de una viñeta.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
La alineación de la viñeta no está especificada. |
START |
La viñeta se alinea con el inicio del espacio asignado para renderizarla. Alineado a la izquierda para texto LTR y a la derecha en otros casos. |
CENTER |
La viñeta se alinea con el centro del espacio asignado para renderizarla. |
END |
La viñeta se alinea con el final del espacio asignado para renderizarla. Alineado a la derecha para el texto LTR y alineado a la izquierda en otros casos. |
GlyphType
Son los tipos de glifos que se usan en las viñetas cuando los párrafos de este nivel de anidación están ordenados.
Enums | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
El tipo de glifo no se especificó o no es compatible. |
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 un prefijo cero, como 01 , 02 o 03 . Los números con más de un dígito no tienen un cero como prefijo. |
UPPER_ALPHA |
Una letra mayúscula, como A , B o C . |
ALPHA |
Una letra en 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
Es un cambio sugerido para ListProperties
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Es un objeto |
listPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos del |
ListPropertiesSuggestionState
Es una máscara que indica cuáles de los campos del ListProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Campos | |
---|---|
nestingLevelsSuggestionStates[] |
Máscara que indica cuáles de los campos del objeto Los estados de sugerencia del nivel de anidación se devuelven en orden ascendente del nivel de anidación, y primero se devuelve el menos anidado. |
NestingLevelSuggestionState
Es una máscara que indica cuáles de los campos del NestingLevel
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en |
glyphTypeSuggested |
Indica si hubo un cambio sugerido en |
glyphFormatSuggested |
Indica si hubo un cambio sugerido en |
glyphSymbolSuggested |
Indica si hubo un cambio sugerido en |
indentFirstLineSuggested |
Indica si hubo un cambio sugerido en |
indentStartSuggested |
Indica si hubo un cambio sugerido en |
textStyleSuggestionState |
Es una máscara que indica cuáles de los campos de |
startNumberSuggested |
Indica si hubo un cambio sugerido en |
NamedRanges
Es una colección de todos los NamedRange
s del documento que comparten un nombre determinado.
Representación JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
Es el nombre que comparten todos los |
namedRanges[] |
Los |
NamedRange
Es una colección de objetos Range
con el mismo ID de rango con nombre.
Los rangos con nombre permiten que los desarrolladores asocien partes de un documento con una etiqueta arbitraria definida por el usuario para que su contenido se pueda leer o editar de forma programática más adelante. Un documento puede contener varios rangos con nombre que tengan el mismo nombre, pero cada rango con nombre tiene un ID único.
Se crea un rango con nombre 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 rangos.
Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tienen acceso al documento pueden ver sus rangos con nombre.
Representación JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
Es el ID del rango con nombre. |
name |
Nombre del rango con nombre. |
ranges[] |
Son 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 en el que se incluye este rango. Un ID de segmento vacío significa el cuerpo del documento. |
startIndex |
Í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 admitir futuros casos de uso con rangos abiertos. |
endIndex |
Í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 admitir futuros casos de uso con rangos abiertos. |
tabId |
Es la pestaña que contiene este rango. Si se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña, haz lo siguiente:
En un documento que contiene varias pestañas, haz lo siguiente:
|
InlineObject
Objeto que aparece intercalado con el texto. Un InlineObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
objectId |
Es el ID de este objeto intercalado. Se puede usar para actualizar las propiedades de un objeto. |
inlineObjectProperties |
Son las propiedades de este objeto intercalado. |
suggestedInlineObjectPropertiesChanges |
Son los cambios sugeridos en las propiedades del objeto intercalado, con el ID de sugerencia como clave. |
suggestedInsertionId |
Es el ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida. |
suggestedDeletionIds[] |
Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido. |
InlineObjectProperties
Son las propiedades de un InlineObject
.
Representación JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
Es 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 |
Es el título del objeto incorporado. |
description |
Es la descripción del objeto incorporado. |
embeddedObjectBorder |
Es el borde del objeto incorporado. |
size |
Tamaño visible de la imagen después de recortarla. |
marginTop |
Es el margen superior del objeto incorporado. |
marginBottom |
Es el margen inferior del objeto incorporado. |
marginRight |
Es el margen derecho del objeto incorporado. |
marginLeft |
Es el margen izquierdo del objeto incorporado. |
linkedContentReference |
Es una referencia al contenido de la fuente externa vinculada. Por ejemplo, contiene una referencia al gráfico de Hojas de cálculo de Google fuente cuando el objeto incorporado es un gráfico vinculado. Si no se configura, el objeto incorporado no se vinculará. |
Campo de unión properties . Son las propiedades específicas de cada tipo de objeto integrado. Las direcciones (properties ) solo pueden ser una de las siguientes opciones: |
|
embeddedDrawingProperties |
Son las 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 se usan para diferenciar el tipo de objeto. Un dibujo incorporado es aquel que se crea y edita dentro de un documento. Ten en cuenta que no se admiten detalles extensos.
ImageProperties
Son las propiedades de una imagen.
Representación JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
contentUri |
Es un URI a la imagen con una vida útil predeterminada de 30 minutos. Este URI está etiquetado con la cuenta del solicitante. Cualquier persona que tenga el URI accederá a la imagen como el solicitante original. Es posible que se pierda el acceso a la imagen si cambia la configuración de uso compartido del documento. |
sourceUri |
El URI de origen es el URI que se usa para insertar la imagen. El URI de la fuente puede estar vacío. |
brightness |
Es 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 |
Es 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 |
Es el efecto de transparencia de la imagen. El valor debe estar en el intervalo [0.0, 1.0], donde 0 significa que no hay efecto y 1 significa que es transparente. |
cropProperties |
Son las propiedades de recorte de la imagen. |
angle |
Ángulo de rotación de la imagen en el sentido de las agujas del reloj, en radianes. |
CropProperties
Son las propiedades de recorte de una imagen.
El rectángulo de recorte se representa con desplazamientos fraccionarios desde 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 de límite 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 todos los desplazamientos y ángulos 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 hacia adentro se encuentra el borde izquierdo del rectángulo de recorte desde el borde izquierdo del contenido original, como una fracción del ancho del contenido original. |
offsetRight |
El desplazamiento especifica qué tan lejos hacia adentro 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 hacia adentro 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 adentro se encuentra el borde inferior del rectángulo de recorte con respecto al borde inferior del contenido original, como una fracción de la altura del contenido original. |
angle |
Es el á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
Un borde alrededor de un EmbeddedObject
.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
Es el color del borde. |
width |
Es el ancho del borde. |
dashStyle |
Es el estilo de guiones del borde. |
propertyState |
Es el estado de la propiedad de borde. |
PropertyState
Son los estados posibles de una propiedad.
Enums | |
---|---|
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 tendrá la propiedad correspondiente cuando se renderice en el documento. |
LinkedContentReference
Es una referencia al contenido de la fuente externa vinculada.
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
Es 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 |
Es el ID del gráfico específico en la hoja de cálculo de Hojas de cálculo de Google que está incorporada. |
SuggestedInlineObjectProperties
Es un cambio sugerido para InlineObjectProperties
.
Representación JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Es un objeto |
inlineObjectPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos del |
InlineObjectPropertiesSuggestionState
Es una máscara que indica cuáles de los campos del InlineObjectProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embeddedObjectSuggestionState |
Es una máscara que indica cuáles de los campos de |
EmbeddedObjectSuggestionState
Es una máscara que indica cuáles de los campos del EmbeddedObject
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos de |
imagePropertiesSuggestionState |
Es una máscara que indica cuáles de los campos de |
titleSuggested |
Indica si hubo un cambio sugerido en |
descriptionSuggested |
Indica si hubo un cambio sugerido en |
embeddedObjectBorderSuggestionState |
Es una máscara que indica cuáles de los campos de |
sizeSuggestionState |
Es una máscara que indica cuáles de los campos de |
marginLeftSuggested |
Indica si hubo un cambio sugerido en |
marginRightSuggested |
Indica si hubo un cambio sugerido en |
marginTopSuggested |
Indica si hubo un cambio sugerido en |
marginBottomSuggested |
Indica si hubo un cambio sugerido en |
linkedContentReferenceSuggestionState |
Es una máscara que indica cuáles de los campos de |
EmbeddedDrawingPropertiesSuggestionState
Este tipo no tiene campos.
Es una máscara que indica cuáles de los campos del EmbeddedDrawingProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
ImagePropertiesSuggestionState
Es una máscara que indica cuáles de los campos del ImageProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en |
sourceUriSuggested |
Indica si hubo un cambio sugerido en [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indica si hubo un cambio sugerido en [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
Indica si hubo un cambio sugerido en [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indica si hubo un cambio sugerido en [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos de |
angleSuggested |
Indica si hubo un cambio sugerido en [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
Es una máscara que indica cuáles de los campos del CropProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en |
offsetRightSuggested |
Indica si hubo un cambio sugerido en |
offsetTopSuggested |
Indica si hubo un cambio sugerido en |
offsetBottomSuggested |
Indica si hubo un cambio sugerido en |
angleSuggested |
Indica si hubo un cambio sugerido en |
EmbeddedObjectBorderSuggestionState
Es una máscara que indica cuáles de los campos del EmbeddedObjectBorder
base se modificaron en esta sugerencia. Para cualquier campo establecido 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 en [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indica si hubo un cambio sugerido en [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indica si hubo un cambio sugerido en [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
Es una máscara que indica cuáles de los campos del LinkedContentReference
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Es una máscara que indica cuáles de los campos de |
SheetsChartReferenceSuggestionState
Es una máscara que indica cuáles de los campos del SheetsChartReference
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica si hubo un cambio sugerido en |
chartIdSuggested |
Indica si hubo un cambio sugerido en |
PositionedObject
Es un objeto que está unido a un Paragraph
y se posiciona en relación con el inicio del párrafo. Un PositionedObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
objectId |
Es el ID de este objeto posicionado. |
positionedObjectProperties |
Son las propiedades de este objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
Son los cambios sugeridos en las propiedades del objeto posicionado, con el ID de sugerencia como clave. |
suggestedInsertionId |
Es el ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida. |
suggestedDeletionIds[] |
Son los IDs 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 |
Es la posición de este objeto posicionado en relación con el salto de línea del |
embeddedObject |
Es el objeto incorporado de este objeto posicionado. |
PositionedObjectPositioning
Es el posicionamiento de un PositionedObject
. El objeto posicionado se ubica en relación con el inicio del Paragraph
al que está vinculado.
Representación JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
Es el diseño de este objeto posicionado. |
leftOffset |
Es el desplazamiento del borde izquierdo del objeto posicionado en relación con el inicio del |
topOffset |
Es el desplazamiento del borde superior del objeto posicionado en relación con el inicio del |
PositionedObjectLayout
Son los diseños posibles de un [PositionedObject][google.aps.docs.v1.PositionedObject].
Enums | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
El diseño no está especificado. |
WRAP_TEXT |
El texto se ajusta alrededor del objeto posicionado. |
BREAK_LEFT |
Divide el texto de modo que el objeto posicionado quede a la izquierda y el texto a la derecha. |
BREAK_RIGHT |
Divide el texto de modo que el objeto posicionado quede a la derecha y el texto a la izquierda. |
BREAK_LEFT_RIGHT |
Divide el texto de modo que no haya texto a la izquierda ni a la derecha del objeto posicionado. |
IN_FRONT_OF_TEXT |
El objeto posicionado está delante del texto. |
BEHIND_TEXT |
El objeto posicionado está detrás del texto. |
SuggestedPositionedObjectProperties
Es un cambio sugerido para PositionedObjectProperties
.
Representación JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Es un objeto |
positionedObjectPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos del |
PositionedObjectPropertiesSuggestionState
Es una máscara que indica cuáles de los campos del PositionedObjectProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioningSuggestionState |
Es una máscara que indica cuáles de los campos de |
embeddedObjectSuggestionState |
Es una máscara que indica cuáles de los campos de |
PositionedObjectPositioningSuggestionState
Es una máscara que indica cuáles de los campos del PositionedObjectPositioning
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Campos | |
---|---|
layoutSuggested |
Indica si hubo un cambio sugerido en |
leftOffsetSuggested |
Indica si hubo un cambio sugerido en |
topOffsetSuggested |
Indica si hubo un cambio sugerido en |
SuggestionsViewMode
Es el modo de vista de sugerencias aplicado al documento que indica cómo se representan los cambios sugeridos. Proporciona opciones para leer el documento con todas las sugerencias intercaladas, aceptadas o rechazadas.
Enums | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
El SuggestionsViewMode aplicado al documento devuelto depende del nivel de acceso actual del usuario. Si el usuario solo tiene acceso de visualización, 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 dentro 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 devuelve 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 devuelve es una vista previa con todos los cambios sugeridos rechazados si hay sugerencias en el documento. |
Métodos |
|
---|---|
|
Aplica una o más actualizaciones al documento. |
|
Crea un documento en blanco con el título que se proporciona en la solicitud. |
|
Obtiene la versión más reciente del documento especificado. |