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