- Recurso: Documento
- Cuerpo
- StructuralElement
- Párrafo
- ParagraphElement
- TextRun
- TextStyle
- OpcionalColor
- Color
- RgbColor
- Dimensión
- Unidad
- WeightedFontFamily
- BaselineOffset
- Vínculo
- SuggestedTextStyle
- TextStyleSuggestedionState
- AutoText
- Tipo
- Salto de página
- ColumnBreak
- Referencia del pie de página
- HorizontalRule
- Ecuación
- InlineObjectElement
- Persona
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType.
- Alineación
- Dirección del contenido
- Modo de espaciado
- ParagraphBorder
- EstiloDeDash
- TabStop
- TabStopAlignment.
- Sombra
- SuggestedParagraphStyle
- ParagraphStyleSuggestedionState
- ShadingSuggestedionState
- Viñeta
- Bullet sugerido
- BulletsuggestionState
- ObjectReferences
- SecciónBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- Tipo de sección
- Tabla
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- Alineación de contenido
- SuggestedTableCellStyle
- TableCellStyleSuggestedionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestedionState
- TableStyle
- TableColumnProperties
- WidthType;
- TableOfContents
- Encabezado
- Pie de página
- Nota al pie
- DocumentStyle
- Segundo plano
- Tamaño
- SuggestedDocumentStyle
- DocumentStyleHintionState
- BackgroundSuggestedionState
- SizeSugeririonState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylessuggestionState
- NamedStyleSuggestedionState
- Lista
- ListProperties
- Nivel de anidación
- Alineación con viñetas
- Tipo de glifo
- SuggestedListProperties
- ListPropertiesSugerenciaionState
- NestingLevelSugerenciaionState
- NombreRangos
- NamedRange,
- Rango
- SuggestionsViewMode.
- InlineObject
- InlineObjectProperties
- EmbedObject
- EmbedDrawingProperties
- ImageProperties
- CropProperties
- EmbedObjectBorder
- PropiedadState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSugerenciaionState
- EmbedObjectSugerenciaionState
- EmbedDrawingPropertiesSugerenciaionState
- ImagePropertiesHintdState
- CropPropertiesSugerenciaionState
- EmbedObjectBorderHintionState
- LinkedContentReferenceSugerenciaion
- SheetsChartReferenceSugerenciaionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning:
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSugerenciaionState
- PositionedObjectPositioningSugerenciaionState
- Métodos
Recurso: Documento
Un archivo de Documentos de Google
Representación JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
Campos | |
---|---|
documentId |
Solo salida. Es el ID del documento. |
title |
Es el título del documento. |
body |
Solo salida. Es el cuerpo principal del documento. |
headers |
Solo salida. Son los encabezados del documento, codificados por ID de encabezado. |
footers |
Solo salida. Son los pies de página del documento, codificados por el ID del pie de página. |
footnotes |
Solo salida. Son las notas al pie del documento, marcadas por un ID de nota al pie. |
documentStyle |
Solo salida. Es el estilo del documento. |
suggestedDocumentStyleChanges |
Solo salida. Los cambios sugeridos en el estilo del documento, basados en el ID de sugerencia. |
namedStyles |
Solo salida. Los estilos con nombre del documento. |
suggestedNamedStylesChanges |
Solo salida. Los cambios sugeridos en los estilos con nombre del documento, con claves según el ID de sugerencia. |
lists |
Solo salida. Son las listas del documento, codificadas por ID de lista. |
namedRanges |
Solo salida. Los rangos con nombre en el documento, codificados por nombre. |
revisionId |
Solo salida. El ID de revisión del documento. Se puede usar en solicitudes de actualización para especificar a qué revisión de un documento se deben aplicar actualizaciones y cómo debe comportarse 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 string opaca. El formato del ID de revisión puede cambiar con el tiempo. El ID de revisión que se muestra solo puede ser válido por 24 horas después de que se muestra y no puede compartirse entre usuarios. Si el ID de revisión no se modifica entre llamadas, el documento no se modifica. Por el contrario, un ID modificado (para el mismo documento y el mismo usuario) suele significar que el documento se actualizó. Sin embargo, un ID modificado también puede deberse a factores internos, como cambios de formato de ID. |
suggestionsViewMode |
Solo salida. El modo de vista de sugerencias aplicado al documento. Nota: Cuando se edita un documento, los cambios deben basarse en un documento que tenga |
inlineObjects |
Solo salida. Los objetos intercalados en el documento, codificados por ID de objeto. |
positionedObjects |
Solo salida. Los objetos posicionados en el documento, codificados por ID de objeto. |
Cuerpo
El cuerpo del documento.
El cuerpo suele incluir el contenido completo del documento, excepto headers
, footers
y footnotes
.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
El contenido del cuerpo. Los índices para el contenido del cuerpo comienzan en cero. |
Elemento estructural
Un StructuralElement describe el contenido que 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 |
El índice final basado en cero de este elemento estructural, exclusivo de las unidades de código UTF-16. |
Campo de unión content . 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 |
Tipo de salto de sección de elemento estructural. |
table |
Un tipo de tabla de elemento estructural. |
tableOfContents |
Un índice de tipo de elemento estructural. |
Párrafo
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[] |
El contenido del párrafo, dividido en sus partes. |
paragraphStyle |
El estilo de este párrafo. |
suggestedParagraphStyleChanges |
El estilo de párrafo sugerido cambia a este párrafo y depende del ID de sugerencia. |
bullet |
La viñeta de este párrafo. Si no está presente, el párrafo no pertenece a una lista. |
suggestedBulletChanges |
Los cambios sugeridos para la viñeta de este párrafo. |
positionedObjectIds[] |
Son los ID de los objetos posicionados anclados a este párrafo. |
suggestedPositionedObjectIds |
Son los ID de los objetos posicionados que se sugieren que se adjunten a este párrafo, con claves por ID de sugerencia. |
Elemento de párrafo
Un ParagraphElement describe el contenido dentro de una 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 de base cero de este elemento de párrafo, exclusivo en unidades de código UTF-16. |
Campo de unión content . El contenido del elemento de párrafo. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
textRun |
Un elemento de párrafo de ejecución de texto. |
autoText |
Un elemento de párrafo de texto automático. |
pageBreak |
Un elemento de párrafo de salto de página. |
columnBreak |
Un elemento de párrafo de salto de columna. |
footnoteReference |
Un elemento de párrafo de referencia de pie de página |
horizontalRule |
Un elemento de párrafo de regla horizontal. |
equation |
Un elemento de párrafo de ecuación. |
inlineObjectElement |
Un elemento de párrafo de objeto intercalado. |
person |
Es un elemento de un párrafo que vincula a una persona o una dirección de correo electrónico. |
richLink |
Un elemento de párrafo que se vincula a un recurso de Google (como un archivo en Google Drive, un video de YouTube o un evento de Calendario). |
Ejecución de texto
Es un ParagraphElement
que representa una serie de textos 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 son de texto en la ejecución se reemplazan por el carácter Unicode U+E907. |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
Es el estilo de texto de esta ejecución. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a esta ejecución, basado en el ID de sugerencia. |
TextStyle
Representa el estilo que se puede aplicar al texto.
Los estilos de texto heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de texto depende de dónde se define el estilo de texto:
- El TextStyle de texto en un
Paragraph
hereda delnamed 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 del editor de Documentos. - El TextStyle de 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 se hereda de un elemento superior, si anulas la configuración de los campos, se revertirá 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. |
italic |
Si el texto está en cursiva o no. |
underline |
Indica si el texto está subrayado o no. |
strikethrough |
Indica si el texto ha sido tachado o no. |
smallCaps |
Indica si el texto está en letras mayúsculas pequeñas o no. |
backgroundColor |
El color de fondo del texto Si se establece, el color es RGB o transparente, según el campo |
foregroundColor |
El color de primer plano del texto. Si se establece, el color es RGB o transparente, según el campo |
fontSize |
El tamaño de la fuente del texto |
weightedFontFamily |
Es la familia de fuentes y el peso renderizado del texto. Si una solicitud de actualización especifica valores para Si no se configura Si se configura |
baselineOffset |
Desplazamiento vertical del texto desde su posición normal. El texto con desplazamiento de referencia |
link |
Es el destino del hipervínculo del texto. Si no estableces la política, no habrá ningún vínculo. Los vínculos no se heredan del texto superior. Si cambias el vínculo en una solicitud de actualización, se aplicarán otros cambios al estilo de texto del rango:
|
Color opcional
Un color que puede ser completamente opaco o completamente transparente.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Si se establece, se usará como color opaco. Si no se establece, representa un color transparente. |
Color
Un color sólido.
Representación JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
El valor de color RGB. |
Color de RGB
Un color RGB.
Representación JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
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
Una magnitud en una sola dirección en las unidades especificadas.
Representación JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Campos | |
---|---|
magnitude |
La magnitud. |
unit |
Unidades de magnitud. |
Unidad
Unidades de medida.
Enumeradores | |
---|---|
UNIT_UNSPECIFIED |
Las unidades son desconocidas. |
PT |
Un punto, 1/72 de pulgada. |
Fuente de la familia con ponderación
Representa una familia de fuentes y el grosor del texto.
Representación JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
fontFamily |
Es la familia de fuentes del texto. La familia de fuentes puede ser cualquier fuente del menú Fuentes en Documentos o de Google Fonts. Si no se reconoce el nombre de la fuente, se renderiza el texto en |
weight |
El grosor de la fuente. Este campo puede tener cualquier valor que sea múltiplo de El valor predeterminado es El grosor de la fuente constituye solo un componente del grosor de la fuente renderizado. Una combinación del
|
Compensación de referencia
Las formas en las que el texto se puede desplazar verticalmente desde su posición normal
Enumeradores | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
El desplazamiento de referencia del texto se hereda del elemento superior. |
NONE |
El texto no está desplazado verticalmente. |
SUPERSCRIPT |
El texto está desplazado verticalmente (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 . El destino del vínculo. Las direcciones (destination ) solo pueden ser una de las siguientes opciones: |
|
url |
Una URL externa. |
bookmarkId |
Es el ID de un favorito en este documento. |
headingId |
Es el ID de un encabezado en este documento. |
Estilo de texto sugerido
Se sugiere un cambio en TextStyle
.
Representación JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Un |
textStyleSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de sugerencia de texto
Es una máscara que indica cuáles de los campos en el TextStyle
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Campos | |
---|---|
boldSuggested |
Indica si se sugirió un cambio a |
italicSuggested |
Indica si se sugirió un cambio a |
underlineSuggested |
Indica si se sugirió un cambio a |
strikethroughSuggested |
Indica si se sugirió un cambio a |
smallCapsSuggested |
Indica si se sugirió un cambio a |
backgroundColorSuggested |
Indica si se sugirió un cambio a |
foregroundColorSuggested |
Indica si se sugirió un cambio a |
fontSizeSuggested |
Indica si se sugirió un cambio a |
weightedFontFamilySuggested |
Indica si se sugirió un cambio a |
baselineOffsetSuggested |
Indica si se sugirió un cambio a |
linkSuggested |
Indica si se sugirió un cambio a |
Texto automático
Es un ParagraphElement
que representa un lugar del texto que se reemplaza de forma dinámica por contenido que puede cambiar con el tiempo, como un número de página.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Es el tipo de este texto automático. |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
El estilo de texto de este AutoText. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este texto automático, con una clave por ID de sugerencia. |
Tipo
Los tipos de texto automático.
Enumeradores | |
---|---|
TYPE_UNSPECIFIED |
Un tipo de texto automático sin especificar. |
PAGE_NUMBER |
Escribe para el texto automático que representa el número de la página actual. |
PAGE_COUNT |
Escribe para el texto automático que representa la cantidad total de páginas del documento. |
Salto de página
Un objeto 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 ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
El estilo de texto de este salto de página. Al igual que ocurre con el contenido de texto, como las ejecuciones de texto y las referencias al pie de página, el estilo de un salto de página puede afectar el diseño del contenido y el estilo que se inserta junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este salto de página, con clave por ID de sugerencia. |
Salto de columna
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 siguiente columna.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
El estilo de texto de esta ColumnBreak Al igual que ocurre con el contenido de texto, como las ejecuciones de texto y las referencias al pie de página, el estilo de un salto de columna puede afectar el diseño del contenido y el estilo que se inserta junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este ColumnBreak, basado en el ID de sugerencia. |
Referencia al pie de página
Un objeto ParagraphElement
que representa una referencia de una nota al pie. Una referencia a pie de página es el contenido intercalado renderizado con un número y se usa para identificar la nota al pie.
Representación JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnoteId |
Es el ID de |
footnoteNumber |
Es el número renderizado de esta nota al pie. |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
El estilo de texto de esta FootnoteReference. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a FootnoteReference, con la clave del ID de sugerencia. |
Regla horizontal
Un objeto ParagraphElement
que representa una línea horizontal.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
El estilo de texto de esta HorizontalRule. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias al pie de página, el estilo de texto de una regla horizontal puede afectar el diseño del contenido y el estilo que se inserta junto a ella. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a esta HorizontalRule, con un ID de sugerencia. |
Ecuación
Un objeto ParagraphElement
que representa una ecuación.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
ElementoinlineObject
Un objeto ParagraphElement
que contiene un elemento InlineObject
.
Representación JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inlineObjectId |
Es el ID de |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
textStyle |
El estilo de texto de este InlineObjectElement. Al igual que en el contenido de texto, como las ejecuciones de texto y las referencias al pie de página, el estilo de texto de un elemento de objeto intercalado puede afectar el diseño del contenido y el estilo que se inserta junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este objeto InlineObject, que usa el ID de sugerencia. |
Person
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 ID de sugerencias que insertan el vínculo de esta persona en el documento. Un |
suggestedDeletionIds[] |
ID de sugerencias para quitar a esta persona del vínculo. Un |
textStyle |
El estilo de texto de este |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este |
personProperties |
Solo salida. Las propiedades de este |
Propiedades de persona
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 en la dirección de correo electrónico de la persona. |
email |
Solo salida. La dirección de correo electrónico vinculada a este |
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 ID de sugerencias que insertan este vínculo en el documento. Un |
suggestedDeletionIds[] |
Son los ID de sugerencias que quitan este vínculo del documento. Un |
textStyle |
El estilo de texto de este |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este |
richLinkProperties |
Solo salida. Las propiedades de este |
Propiedades de RichLink
Propiedades específicas de un objeto RichLink
.
Representación JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Solo salida. Es el título de |
uri |
Solo salida. Es el URI de |
mimeType |
Solo salida. El tipo de MIME de |
ParagraphStyle
Estilos que se aplican a un párrafo completo
Los estilos de párrafo heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de párrafo depende de dónde se define su estilo:
- El ParagraphStyle en un
Paragraph
se hereda delnamed style type
correspondiente del párrafo. - El ParagraphStyle en un
named style
se hereda del estilo con nombrenormal text
. - El ParagraphStyle del estilo con nombre
normal text
se hereda del estilo de párrafo predeterminado en el editor de Documentos. - El ParagraphStyle en un elemento
Paragraph
que se contiene en una tabla puede heredar su estilo de párrafo del estilo de tabla.
Si el estilo de párrafo no hereda de un elemento superior, si anula la configuración de los campos, el estilo se revertirá a un valor que coincida con los valores predeterminados en el editor de Documentos.
Representación JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
Es el ID de encabezado del párrafo. Si está vacío, este párrafo no es un encabezado. Esta propiedad es de solo lectura. |
namedStyleType |
El tipo de estilo con nombre del párrafo. Como la actualización del tipo de estilo con nombre afecta 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 |
La cantidad de espacio entre las líneas, como un porcentaje de la normal, donde la 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 se establece, el valor predeterminado es |
spacingMode |
Es el modo de espaciado para un párrafo. |
spaceAbove |
La cantidad de espacio adicional sobre el párrafo. Si no la estableces, el valor se heredará del elemento superior. |
spaceBelow |
La cantidad de espacio adicional debajo del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
borderBetween |
Es el borde entre este párrafo y los párrafos anterior y siguiente. Si no la estableces, el valor se heredará del elemento superior. Se renderiza el borde intermedio cuando el párrafo adyacente tiene las mismas propiedades de sangría y borde. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo. |
borderTop |
Es el borde en la parte superior de este párrafo. Si no la estableces, el valor se heredará del elemento superior. Se renderiza el borde superior 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 se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo. |
borderBottom |
Es el borde en la parte inferior de este párrafo. Si no la estableces, el valor se heredará del elemento superior. Se renderiza el borde inferior 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 se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo. |
borderLeft |
Es el borde a la izquierda de este párrafo. Si no la estableces, el valor se heredará del elemento superior. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo. |
borderRight |
Es el borde a la derecha de este párrafo. Si no la estableces, el valor se heredará del elemento superior. Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo. |
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 |
La cantidad de sangría del párrafo del lado que corresponde al inicio del texto, según la dirección del párrafo actual. Si no la estableces, el valor se heredará del elemento superior. |
indentEnd |
La cantidad de sangría del párrafo del lado que corresponde al final del texto, según la dirección del párrafo actual. Si no la estableces, el valor se heredará del elemento superior. |
tabStops[] |
Se mostrará una lista de las pestañas 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 mostrarse 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, al menos una parte de este párrafo debe aparecer en la misma página o columna que el párrafo siguiente. Si no la estableces, el valor se heredará del elemento superior. |
avoidWidowAndOrphan |
Si se deben evitar las viudas y los huérfanos del párrafo. Si no la estableces, el valor se heredará del elemento superior. |
shading |
Sombreado del párrafo Si no la estableces, el valor se heredará del elemento superior. |
pageBreakBefore |
Indica si el párrafo actual debe comenzar siempre al principio de una página. Si no la estableces, el valor se heredará del elemento superior. Si intentas actualizar |
TipodeEstilodeNombre
Los tipos de estilos con nombre.
Enumeradores | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
El tipo de estilo con nombre no está especificado. |
NORMAL_TEXT |
Texto normal. |
TITLE |
Título. |
SUBTITLE |
Subtítulos. |
HEADING_1 |
Encabezado 1. |
HEADING_2 |
Encabezado 2. |
HEADING_3 |
Encabezado 3. |
HEADING_4 |
Encabezado 4. |
HEADING_5 |
Encabezado 5. |
HEADING_6 |
Encabezado 6. |
Alineación
Son los tipos de alineación de texto para un párrafo.
Enumeradores | |
---|---|
ALIGNMENT_UNSPECIFIED |
La alineación del párrafo se hereda del elemento superior. |
START |
El párrafo se alinea con el inicio de la línea. Alineado hacia la izquierda para texto de izquierda a derecha, alineado hacia la derecha. |
CENTER |
El párrafo está centrado. |
END |
El párrafo se alinea con el final de la línea. Alineado a la derecha para texto de izquierda a derecha, a la izquierda, en caso contrario. |
JUSTIFIED |
El párrafo se justifica. |
Dirección de contenido
El contenido en el que pueden fluir las instrucciones sobre cómo llegar
Enumeradores | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
La dirección del contenido no está especificada. |
LEFT_TO_RIGHT |
El contenido va de izquierda a derecha. |
RIGHT_TO_LEFT |
El contenido va de derecha a izquierda. |
Modo spacing
Los diferentes modos para el espaciado de párrafos.
Enumeradores | |
---|---|
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. |
Borde de párrafo
Un borde alrededor de un párrafo
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde. |
width |
El ancho del borde. |
padding |
El padding del borde. |
dashStyle |
El estilo de guion del borde. |
Estilo de guion
Los tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el tipo simple "ST_PresetLineDashVal" descrito en la sección 20.1.10.48 de "Office Open XML File Formats - Fundamentals andMark Language Reference", parte 1 de la cuarta edición 376 del ECMA-376.
Enumeradores | |
---|---|
DASH_STYLE_UNSPECIFIED |
Estilo de guion no especificado. |
SOLID |
Línea continua. Corresponde al valor "macizo" de ECMA-376 ST_PresetLineDashVal. 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
Una tabulación dentro de un párrafo.
Representación JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
El desplazamiento entre esta parada de pestaña y el margen de inicio. |
alignment |
La alineación de esta pestaña se detiene. Si no se establece, el valor predeterminado es |
TabStopAlignment
Alineación de la tabulación.
Enumeradores | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
La alineación de la tabulación no está especificada. |
START |
La tabulación se alinea con el inicio de la línea. Esta es la opción predeterminada. |
CENTER |
La tabulación está alineada con el centro de la línea. |
END |
La tabulación se alinea al final de la línea. |
Sombreado
Sombreado de un párrafo.
Representación JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
backgroundColor |
El color de fondo de este sombreado de párrafo. |
Estilo de párrafo sugerido
Se sugiere un cambio en ParagraphStyle
.
Representación JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Un |
paragraphStyleSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado del párrafo de párrafo
Es una máscara que indica cuáles de los campos en el ParagraphStyle
base se modificaron 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 se sugirió un cambio a |
namedStyleTypeSuggested |
Indica si se sugirió un cambio a |
alignmentSuggested |
Indica si se sugirió un cambio a |
lineSpacingSuggested |
Indica si se sugirió un cambio a |
directionSuggested |
Indica si se sugirió un cambio a |
spacingModeSuggested |
Indica si se sugirió un cambio a |
spaceAboveSuggested |
Indica si se sugirió un cambio a |
spaceBelowSuggested |
Indica si se sugirió un cambio a |
borderBetweenSuggested |
Indica si se sugirió un cambio a |
borderTopSuggested |
Indica si se sugirió un cambio a |
borderBottomSuggested |
Indica si se sugirió un cambio a |
borderLeftSuggested |
Indica si se sugirió un cambio a |
borderRightSuggested |
Indica si se sugirió un cambio a |
indentFirstLineSuggested |
Indica si se sugirió un cambio a |
indentStartSuggested |
Indica si se sugirió un cambio a |
indentEndSuggested |
Indica si se sugirió un cambio a |
keepLinesTogetherSuggested |
Indica si se sugirió un cambio a |
keepWithNextSuggested |
Indica si se sugirió un cambio a |
avoidWidowAndOrphanSuggested |
Indica si se sugirió un cambio a |
shadingSuggestionState |
Es una máscara que indica cuál de los campos en |
pageBreakBeforeSuggested |
Indica si se sugirió un cambio a |
Estado de sugerencia de sombra
Es una máscara que indica cuáles de los campos en el Shading
base se modificaron en este cambio sugerido. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si se sugirió un cambio en |
Viñeta
Describe la viñeta de un párrafo.
Representación JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
listId |
Es el ID de la lista a la que pertenece este párrafo. |
nestingLevel |
El nivel de anidamiento de este párrafo en la lista. |
textStyle |
Es el estilo de texto específico del párrafo aplicado en esta viñeta. |
Viñeta sugerida
Se sugiere un cambio en Bullet
.
Representación JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Un |
bulletSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de viñeta sugerido
Es una máscara que indica cuáles de los campos en el Bullet
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
listIdSuggested |
Indica si se sugirió un cambio en |
nestingLevelSuggested |
Indica si se sugirió un cambio en |
textStyleSuggestionState |
Es una máscara que indica cuál de los campos en |
Referencias de objetos
Una colección de ID de objetos.
Representación JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
objectIds[] |
Los ID de objeto. |
Salto de sección
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 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 ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
sectionStyle |
El estilo de la sección después de este salto de sección |
Estilo de sección
El estilo que se aplica a una sección.
Representación JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
columnProperties[] |
Las propiedades de las columnas de la sección. Si está vacía, la sección contiene una columna con las propiedades predeterminadas en el editor de Documentos. Una sección se puede actualizar para que no tenga más de 3 columnas. Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
columnSeparatorStyle |
El estilo de los separadores de columnas. Este estilo se puede establecer incluso cuando hay una columna en la sección. Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá 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 se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
marginTop |
El margen de la parte superior de la sección. Si no se configura, el valor predeterminado de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
marginBottom |
El margen de la página inferior de la sección. Si no se configura, el valor predeterminado de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
marginRight |
El margen derecho de la sección. Si no se configura, el valor predeterminado de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
marginLeft |
El margen izquierdo de la sección. Si no se configura, el valor predeterminado de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
marginHeader |
Es el margen de encabezado de la sección. Si no se configura, el valor predeterminado de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
marginFooter |
El margen del pie de página de la sección. Si no se configura, el valor predeterminado de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá 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 |
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 |
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 |
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 usa solo para páginas pares. Si el valor de Esta propiedad es de solo lectura. |
evenPageFooterId |
El ID del pie de página que se usa solo para páginas pares. Si el valor de Esta propiedad es de solo lectura. |
useFirstPageHeaderFooter |
Indica si se deben usar los ID 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 de Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
pageNumberStart |
Indica el número de página desde el que se comienza a contar la cantidad de páginas de esta sección. Si no la estableces, la numeración de página continuará desde la sección anterior. Si no se configura el valor en la primera Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta. |
Propiedades de la columna de la sección
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 |
El padding al final de la columna. |
Estilo de separador de columna
El estilo de los separadores de columnas entre columnas.
Enumeradores | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Un estilo de separador de columna no especificado. |
NONE |
No hay líneas de separador de columnas entre las columnas. |
BETWEEN_EACH_COLUMN |
Renderiza una línea de separador de columna entre cada columna. |
SectionType
Representa cómo se posiciona el inicio de la sección actual en relación con la sección anterior.
Enumeradores | |
---|---|
SECTION_TYPE_UNSPECIFIED |
El tipo de sección no está especificado. |
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 estilo de cada fila |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
tableStyle |
El estilo de la tabla. |
TableRow
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 final basado en cero de esta fila, exclusivo en unidades de código UTF-16. |
tableCells[] |
El contenido y 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 ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
tableRowStyle |
El estilo de la fila de la tabla. |
suggestedTableRowStyleChanges |
El estilo sugerido cambia a esta fila, marcada por el ID de sugerencia. |
TableCell
El contenido y el estilo de una celda en Table
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
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 de unidades de código UTF-16. |
content[] |
El contenido de la celda |
tableCellStyle |
El estilo de la celda. |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
suggestedTableCellStyleChanges |
Los cambios sugeridos en el estilo de celda de la tabla, basados en el ID de sugerencia. |
Estilo de celda de tabla
El estilo de un TableCell
.
Los estilos de celda de tabla heredados se representan como campos sin configurar en este mensaje. Un estilo de celda de tabla puede heredar 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 |
El intervalo de columnas de la celda Esta propiedad es de solo lectura. |
backgroundColor |
El color de fondo de la celda |
borderLeft |
Es el borde izquierdo de la celda. |
borderRight |
El borde derecho de la celda. |
borderTop |
El borde superior de la celda |
borderBottom |
El borde inferior de la celda. |
paddingLeft |
Relleno izquierdo de la celda. |
paddingRight |
Relleno derecho de la celda. |
paddingTop |
Relleno superior de la celda. |
paddingBottom |
Relleno inferior de la celda. |
contentAlignment |
Alineación del contenido en la celda de la tabla La alineación predeterminada coincide con la de las celdas de tablas recién creadas en el editor de Documentos. |
Bordecelular
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 la celda de una tabla, establece el ancho en 0.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde. Este color no puede ser transparente. |
width |
El ancho del borde. |
dashStyle |
El estilo de guion del borde. |
Alineación de contenido
Los tipos de alineación del contenido
Derivado de un subconjunto de los valores del tipo simple "ST_TextAnchoringType" de la sección 20.1.10.59 de la sección sobre formatos de archivo XML de Office abiertos - Referencia del lenguaje de marcado y aspectos básicos, parte 1 de ECMA-376 4a edición.
Enumeradores | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Alineación de contenido sin especificar. La alineación del contenido se hereda del elemento superior (si existe). |
CONTENT_ALIGNMENT_UNSUPPORTED |
Alineación de contenido no admitida |
TOP |
Alineación que alinea el contenido con la parte superior del titular del contenido. Corresponde a ECT-376 ST_TextAnchoringType 't'. |
MIDDLE |
Alineación que alinea el contenido con el medio del titular del contenido. Corresponde a ECMA-376 ST_TextAnchoringType 'ctr'. |
BOTTOM |
Alineación que alinea el contenido con la parte inferior del titular del contenido. Corresponde a ECMA-376 ST_TextAnchoringType 'b'. |
SuggestedTableCellStyle
Se sugiere un cambio en TableCellStyle
.
Representación JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Un |
tableCellStyleSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de celda de sugerencias de la tabla
Es una máscara que indica cuáles de los campos en el TableCellStyle
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Campos | |
---|---|
rowSpanSuggested |
Indica si se sugirió un cambio a |
columnSpanSuggested |
Indica si se sugirió un cambio a |
backgroundColorSuggested |
Indica si se sugirió un cambio a |
borderLeftSuggested |
Indica si se sugirió un cambio a |
borderRightSuggested |
Indica si se sugirió un cambio a |
borderTopSuggested |
Indica si se sugirió un cambio a |
borderBottomSuggested |
Indica si se sugirió un cambio a |
paddingLeftSuggested |
Indica si se sugirió un cambio a |
paddingRightSuggested |
Indica si se sugirió un cambio a |
paddingTopSuggested |
Indica si se sugirió un cambio a |
paddingBottomSuggested |
Indica si se sugirió un cambio a |
contentAlignmentSuggested |
Indica si se sugirió un cambio a |
Estilo de fila de la tabla
Estilos que se aplican a una fila de la tabla.
Representación JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
La altura mínima de la fila. La fila se renderizará en el editor de Documentos a una altura igual o superior a este valor para mostrar todo el contenido en las celdas de la fila. |
tableHeader |
Indica si la fila es un encabezado de tabla. |
preventOverflow |
Indica si la fila no puede sobrepasar los límites de la página o de la columna. |
Estilo de fila de la tabla sugerido
Se sugiere un cambio en TableRowStyle
.
Representación JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Un |
tableRowStyleSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de tabla de estilo de fila
Es una máscara que indica cuáles de los campos en el TableRowStyle
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
minRowHeightSuggested |
Indica si se sugirió un cambio a |
Estilo de tabla
Estilos que se aplican a una tabla
Representación JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
tableColumnProperties[] |
Las propiedades de cada columna. Tenga en cuenta que, en Documentos, las tablas contienen filas y las filas contienen celdas, de manera similar a lo que sucede en el código HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el |
Propiedades de la columna de la tabla
Las propiedades de una columna en una tabla.
Representación JSON |
---|
{ "widthType": enum ( |
Campos | |
---|---|
widthType |
El tipo de ancho de la columna. |
width |
El ancho de la columna. Se establece cuando el |
Tipo de ancho
Es el tipo de ancho de la columna.
Enumeradores | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
El tipo de ancho de columna no está especificado. |
EVENLY_DISTRIBUTED |
El ancho de la columna se distribuye de manera uniforme entre las otras columnas que se distribuyen de manera uniforme. El ancho de la columna se determina automáticamente y tendrá una porción igual del ancho restante para la tabla después de considerar todas las columnas con anchos especificados. |
FIXED_WIDTH |
Es un ancho de columna fijo. La propiedad [width][google.apps.docs.v1.TableColumnProperties.width ] contiene el ancho de la columna. |
Índice
Un objeto StructuralElement
que representa un índice.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
El contenido del índice. |
suggestedInsertionIds[] |
Son los ID de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
Encabezado
Un encabezado de documento
Representación JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
headerId |
Es el ID del encabezado. |
content[] |
El contenido del encabezado. Los índices para el contenido de un encabezado comienzan en cero. |
Nota a pie de página
Una nota al pie en un documento.
Representación JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Campos | |
---|---|
footnoteId |
Es el ID de la nota al pie. |
content[] |
El contenido de la nota al pie Los índices del contenido de una nota al pie comienzan en cero. |
DocumentStyle
Es el estilo del documento.
Representación JSON |
---|
{ "background": { object ( |
Campos | |
---|---|
background |
Es el fondo del documento. Los documentos no pueden tener un color de fondo transparente. |
defaultHeaderId |
Es el ID del encabezado predeterminado. Si no estableces la política, no habrá un encabezado predeterminado. Esta propiedad es de solo lectura. |
defaultFooterId |
El ID del pie de página predeterminado. Si no estableces la política, no habrá ningún pie de página predeterminado. Esta propiedad es de solo lectura. |
evenPageHeaderId |
El ID del encabezado que se usa solo para páginas pares. El valor de Esta propiedad es de solo lectura. |
evenPageFooterId |
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 |
Es el ID del encabezado que se usa solo para la primera página. Si no la estableces, no habrá 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 la estableces, no habrá un pie de página único para la primera página. El valor de Esta propiedad es de solo lectura. |
useFirstPageHeaderFooter |
Indica si se deben usar los ID de encabezado o pie de página de la primera página. |
useEvenPageHeaderFooter |
Indica si se deben usar los ID de encabezado y pie de página pares para las páginas pares. |
pageNumberStart |
El número de la página desde el cual se empieza a contar la cantidad de páginas. |
marginTop |
El margen de la parte superior de la página. La actualización del margen de la página superior en el estilo de documento borra el margen de la página superior en todos los estilos de sección. |
marginBottom |
El margen de la página inferior. La actualización del margen de la página inferior en el estilo de documento borra el margen de la página inferior en todos los estilos de sección. |
marginRight |
El margen de la página correcto Si actualizas el margen de la página correcto en el estilo del documento, se borrará el margen de la página correcto en todos los estilos de sección. También puede provocar que las columnas cambien de tamaño en todas las secciones. |
marginLeft |
El margen de la página ubicado a la izquierda. Si se actualiza el margen de la página izquierdo del estilo del documento, se borra el margen izquierdo de todos los estilos de la sección. También puede provocar que las columnas cambien de tamaño en todas las secciones. |
pageSize |
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 |
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. |
Información general
Representa el fondo de un documento.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
El color de fondo |
Tamaño
Ancho y alto
Representación JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
La altura del objeto. |
width |
El ancho del objeto. |
Estilo de documento sugerido
Se sugiere un cambio en DocumentStyle
.
Representación JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
documentStyle |
Un |
documentStyleSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de la sugerencia de documento
Es una máscara que indica cuáles de los campos en el DocumentStyle
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
backgroundSuggestionState |
Es una máscara que indica cuál de los campos en |
defaultHeaderIdSuggested |
Indica si se sugirió un cambio a |
defaultFooterIdSuggested |
Indica si se sugirió un cambio a |
evenPageHeaderIdSuggested |
Indica si se sugirió un cambio a |
evenPageFooterIdSuggested |
Indica si se sugirió un cambio a |
firstPageHeaderIdSuggested |
Indica si se sugirió un cambio a |
firstPageFooterIdSuggested |
Indica si se sugirió un cambio a |
useFirstPageHeaderFooterSuggested |
Indica si se sugirió un cambio a |
useEvenPageHeaderFooterSuggested |
Indica si se sugirió un cambio a |
pageNumberStartSuggested |
Indica si se sugirió un cambio a |
marginTopSuggested |
Indica si se sugirió un cambio a |
marginBottomSuggested |
Indica si se sugirió un cambio a |
marginRightSuggested |
Indica si se sugirió un cambio a |
marginLeftSuggested |
Indica si se sugirió un cambio a |
pageSizeSuggestionState |
Es una máscara que indica cuál de los campos en [size] [google.apps.docs.v1.DocumentStyle.size] se cambiaron en esta sugerencia. |
marginHeaderSuggested |
Indica si se sugirió un cambio a |
marginFooterSuggested |
Indica si se sugirió un cambio a |
useCustomHeaderFooterMarginsSuggested |
Indica si se sugirió un cambio a |
Estado de sugerencia de fondo
Es una máscara que indica cuáles de los campos en el Background
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, Backgound
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si el color de fondo actual se modificó en esta sugerencia. |
Estado de la sugerencia de tamaño
Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a |
widthSuggested |
Indica si se sugirió un cambio a |
Estilos con nombre
Los estilos con nombre. Los párrafos del documento pueden heredar su TextStyle
y su ParagraphStyle
de estos estilos con nombre.
Representación JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Los estilos con nombre. Hay una entrada para cada uno de los posibles |
Estilo con nombre
Un estilo con nombre. Los párrafos del documento pueden heredar su TextStyle
y su ParagraphStyle
de este estilo con nombre cuando tienen el mismo tipo de estilo.
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 |
El estilo de párrafo de este estilo con nombre. |
Sugerencias de nombres con estilos
Se sugiere un cambio en NamedStyles
.
Representación JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Un |
namedStylesSuggestionState |
Es una máscara que indica cuáles de los campos en el |
EstadoDeSugerenciaDeEstiloEstilo
Es el estado de sugerencia de un mensaje NamedStyles
.
Representación JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
stylesSuggestionStates[] |
Es una máscara que indica cuáles de los campos en el El orden de estos estados de sugerencias de estilo con nombre coincide con el orden del estilo con nombre correspondiente dentro de la sugerencia de |
EstadoDeSugerenciaDeEstiloDeNombre
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 del NamedStyleSuggestedionState con su |
textStyleSuggestionState |
Es una máscara que indica cuál de los campos en |
paragraphStyleSuggestionState |
Es una máscara que indica cuál de los campos en |
Cómo mostrar en lista
Una lista representa los atributos de lista de un grupo de párrafos que pertenecen a la misma lista. Un párrafo que forma parte de una lista tiene una referencia al ID de la lista en su bullet
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Las propiedades de la lista |
suggestedListPropertiesChanges |
Los cambios sugeridos para las propiedades de la lista, codificados por ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida. |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacía, no hay sugerencias de eliminaciones de esta lista. |
Propiedades de lista
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 anidación con un nivel de anidamiento 0 que corresponde al nivel superior y un nivel de anidación 8 corresponde al nivel más anidado. Los niveles de anidamiento se muestran en orden ascendente, y el menos anidado se muestra primero. |
Nivel de anidación
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 |
Alineación de la viñeta dentro del espacio asignado para renderizarla. |
glyphFormat |
La string de formato que usan las viñetas en este nivel de anidación. El formato del glifo contiene uno o más marcadores de posición, que se reemplazan por los valores adecuados según Por ejemplo, el formato de glifo
El formato del 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, la string que reemplaza un marcador de posición en formato de glifo para un párrafo en particular depende del orden del párrafo en la lista. |
indentFirstLine |
La cantidad de sangría de la primera línea de párrafos en este nivel de anidación. |
indentStart |
La cantidad de sangría de 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 |
El estilo de texto de las viñetas en este nivel de anidación |
startNumber |
El número del primer elemento de la lista en este nivel de anidación. El valor de 0 se trata como un valor de 1 en el caso de las listas con letras y de números romanos. Para los valores de 0 y 1, las listas con letras y números romanos comenzarán en Este valor se ignora para anidar niveles con glifos sin ordenar. |
Campo de unión glyph_kind . Es el tipo de glifo que usan las balas. Esto define el glifo de viñetas que reemplaza los marcadores de posición en glyph_format . glyph_kind puede ser solo uno de los siguientes: |
|
glyphType |
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 usan 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 |
Alineación de viñetas
Los tipos de alineación de una viñeta
Enumeradores | |
---|---|
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 hacia la izquierda para texto de izquierda a derecha, alineado hacia la derecha. |
CENTER |
La viñeta está alineada 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 texto de izquierda a derecha, a la izquierda, en caso contrario. |
Tipo de glifo
Los tipos de glifos que usan las viñetas cuando se ordenan los párrafos en este nivel de anidación.
Enumeradores | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
El tipo de glifo no se especifica o no se admite. |
NONE |
Una string vacía. |
DECIMAL |
Un número, como 1 , 2 o 3 |
ZERO_DECIMAL |
Un número en el que los números de un solo dígito tienen el prefijo cero, como 01 , 02 o 03 . Los números que tengan más de un dígito no tienen un prefijo de cero. |
UPPER_ALPHA |
Una letra mayúscula, como A , B o C |
ALPHA |
Una letra minúscula, como a , b o c |
UPPER_ROMAN |
Un número romano en mayúsculas, como I , II o III |
ROMAN |
Un número romano en minúscula, como i , ii o iii |
PropiedadesListList
Un cambio sugerido para ListProperties
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Un |
listPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de la lista de propiedades sugeridas
Es una máscara que indica cuáles de los campos en el 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[] |
Es una máscara que indica cuáles de los campos en el Los estados de sugerencia del nivel de anidamiento se muestran en orden ascendente con respecto al nivel de anidamiento que se muestra primero. |
Estado de sugerencia de nivel de anidación
Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a |
glyphTypeSuggested |
Indica si se sugirió un cambio a |
glyphFormatSuggested |
Indica si se sugirió un cambio a |
glyphSymbolSuggested |
Indica si se sugirió un cambio a |
indentFirstLineSuggested |
Indica si se sugirió un cambio a |
indentStartSuggested |
Indica si se sugirió un cambio a |
textStyleSuggestionState |
Es una máscara que indica cuál de los campos en |
startNumberSuggested |
Indica si se sugirió un cambio a |
Rangos con nombre
Una colección de todas las NamedRange
en el documento que comparten un nombre determinado.
Representación JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
El nombre que comparten todos los |
namedRanges[] |
Los |
RangoNombre
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 de manera programática más tarde. 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 elemento Range
, y el contenido insertado dentro de un rango con nombre suele expandirlo. Sin embargo, ciertos cambios en el documento pueden dividir el rango en varios rangos.
Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tengan acceso al documento podrán ver los rangos con nombre.
Representación JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
El ID del rango con nombre. |
name |
El nombre del rango con nombre. |
ranges[] |
Los rangos que pertenecen a este rango con nombre. |
Rango
Especifica un rango de texto contiguo.
Representación JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
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 |
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 Int32Value a fin de adaptarse a casos de uso futuros con rangos abiertos. |
endIndex |
Es el índice final con base 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 Int32Value a fin de adaptarse a casos de uso futuros con rangos abiertos. |
Modo de vista de sugerencias
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.
Enumeradores | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
El SuggestionsViewMode aplicado al documento mostrado 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 predeterminado de vista de sugerencias. |
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 mediante 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 que acepta todos los cambios sugeridos. Las solicitudes para recuperar un documento mediante 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 alguna sugerencia en el documento. |
Objeto intercalado
Es un objeto que aparece intercalado con 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 a las propiedades del objeto intercalado, codificados por ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida. |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
Propiedades de objetos intercalados
Propiedades de un InlineObject
Representación JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
El objeto incorporado de este objeto intercalado. |
Objeto incorporado
Un objeto incorporado en el documento.
Representación JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Campos | |
---|---|
title |
El título del objeto incorporado. |
description |
La descripción del objeto incorporado. |
embeddedObjectBorder |
El borde del objeto incorporado. |
size |
El tamaño visible de la imagen después de recortarla. |
marginTop |
El margen superior del objeto incorporado. |
marginBottom |
El margen inferior del objeto incorporado. |
marginRight |
El margen derecho del objeto incorporado. |
marginLeft |
El margen izquierdo del objeto incorporado. |
linkedContentReference |
Una referencia al contenido de la fuente externa vinculada. 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 |
Las propiedades de un dibujo incorporado |
imageProperties |
Las propiedades de una imagen |
Propiedades de dibujo incorporadas
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 en un documento. Ten en cuenta que no se admiten todos los detalles.
ImageProperties
Las propiedades de una imagen
Representación JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
contentUri |
Un URI de 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 solicitante original. Si cambia la configuración de uso compartido del documento, es posible que se pierda el acceso a la imagen. |
sourceUri |
El URI de origen es el que se usa para insertar la imagen. El URI de origen puede estar vacío. |
brightness |
El efecto de brillo de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa sin efecto. |
contrast |
Efecto de contraste de la imagen El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa sin efecto. |
transparency |
El efecto de transparencia de la imagen. El valor debe estar en el intervalo [0.0, 1.0], donde 0 significa sin efecto y 1 significa transparente. |
cropProperties |
Las propiedades de recorte de la imagen. |
angle |
El ángulo de rotación de la imagen en el sentido de las manecillas del reloj, en radianes |
Propiedades de recorte
Las propiedades de recorte de una imagen.
El rectángulo recortado se representa con desplazamientos fraccionarios de los 4 bordes del contenido original.
- Si el desplazamiento está en el intervalo (0, 1), el borde correspondiente del rectángulo de recorte se posiciona dentro del rectángulo delimitador original de la imagen.
- Si el desplazamiento es negativo o mayor que 1, el borde correspondiente del rectángulo de recorte se posiciona fuera del rectángulo delimitador original de la imagen.
- Si todos los desplazamientos 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 la distancia hacia el interior del 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 la distancia hacia el interior del borde derecho del rectángulo de recorte desde el borde derecho del contenido original como una fracción del ancho del contenido original. |
offsetTop |
El desplazamiento especifica la distancia hacia el borde superior del rectángulo de recorte desde el borde superior del contenido original como una fracción de la altura del contenido original. |
offsetBottom |
El desplazamiento especifica la distancia hacia el interior del borde inferior del rectángulo de recorte desde el borde inferior del contenido original como una fracción de la altura del contenido original. |
angle |
El ángulo de rotación en el sentido de las manecillas del rectángulo de recorte alrededor de su centro, en radianes. La rotación se aplica después de las compensaciones. |
BordeDeObjetoIncorporado
Un borde alrededor de un EmbeddedObject
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde. |
width |
El ancho del borde. |
dashStyle |
El estilo de guion del borde. |
propertyState |
El estado de la propiedad de borde. |
EstadoDePropiedad
Los posibles estados de una propiedad.
Enumeradores | |
---|---|
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. |
Referencia de contenido vinculado
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 |
Una referencia al gráfico vinculado. |
Referencia de SheetsChart
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 Google que contiene el gráfico fuente. |
chartId |
El ID del gráfico específico en la hoja de cálculo de Google que está incorporada |
Propiedades de objetos intercaladas sugeridas
Un cambio sugerido para InlineObjectProperties
.
Representación JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Un |
inlineObjectPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos en el |
Estado de las propiedades de objeto intercaladas
Es una máscara que indica cuáles de los campos en el InlineObjectProperties
base se modificaron 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ál de los campos en |
Estado de la sugerencia del objeto incorporado
Es una máscara que indica cuáles de los campos en el EmbeddedObject
base se modificaron 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ál de los campos en |
imagePropertiesSuggestionState |
Es una máscara que indica cuál de los campos en |
titleSuggested |
Indica si se sugirió un cambio a |
descriptionSuggested |
Indica si se sugirió un cambio a |
embeddedObjectBorderSuggestionState |
Es una máscara que indica cuál de los campos en |
sizeSuggestionState |
Es una máscara que indica cuál de los campos en |
marginLeftSuggested |
Indica si se sugirió un cambio a |
marginRightSuggested |
Indica si se sugirió un cambio a |
marginTopSuggested |
Indica si se sugirió un cambio a |
marginBottomSuggested |
Indica si se sugirió un cambio a |
linkedContentReferenceSuggestionState |
Es una máscara que indica cuál de los campos en |
Estado de las propiedades de dibujo incorporadas
Es una máscara que indica cuáles de los campos en el EmbeddedDrawingProperties
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Estado de las propiedades de las imágenes sugeridas
Es una máscara que indica cuáles de los campos en el ImageProperties
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
contentUriSuggested |
Indica si se sugirió un cambio a |
sourceUriSuggested |
Indica si se sugirió un cambio en [sourceUri] [google.apps.docs.v1.EmbedObject.source_uri]. |
brightnessSuggested |
Indica si se sugirió un cambio a [brightness] [google.apps.docs.v1.EmbedObject.brightness]. |
contrastSuggested |
Indica si se sugirió un cambio a [googlest.docs.v1.EmbedObject.contrast]. |
transparencySuggested |
Indica si se sugirió un cambio a [transparency] [google.apps.docs.v1.EmbedObject.transparency]. |
cropPropertiesSuggestionState |
Es una máscara que indica cuál de los campos en |
angleSuggested |
Indica si se sugirió un cambio a [google.apps.docs.v1.EmbedObject.angle]. |
Estado de las sugerencias de cultivo
Es una máscara que indica cuáles de los campos en el CropProperties
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offsetLeftSuggested |
Indica si se sugirió un cambio a |
offsetRightSuggested |
Indica si se sugirió un cambio a |
offsetTopSuggested |
Indica si se sugirió un cambio a |
offsetBottomSuggested |
Indica si se sugirió un cambio a |
angleSuggested |
Indica si se sugirió un cambio a |
Estado del borde incorporado de objetos
Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a [color] [google.apps.docs.v1.EmbedBorderObject.color]. |
widthSuggested |
Indica si se sugirió un cambio para [width] [google.apps.docs.v1.EmbedBorderObject.width]. |
dashStyleSuggested |
Indica si se sugirió un cambio a [dashStyle] [google.apps.docs.v1.EmbedBorderObject.dash_style]. |
propertyStateSuggested |
Indica si se sugirió un cambio en [googleState.apps.docs.v1.EmbedBorderObject.property_state]. |
Estado de referencia de contenido vinculado
Es una máscara que indica cuáles de los campos en el LinkedContentReference
base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Es una máscara que indica cuál de los campos en |
Estado de referencia de gráfico de sugerencia
Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a |
chartIdSuggested |
Indica si se sugirió un cambio a |
Posición posicionada
Es un objeto que está conectado a un Paragraph
y se posiciona en relación con el comienzo del párrafo. Un PositionedObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
objectId |
El ID de este objeto posicionado. |
positionedObjectProperties |
Las propiedades de este objeto posicionado |
suggestedPositionedObjectPropertiesChanges |
Los cambios sugeridos en las propiedades de objeto posicionados, marcados por el ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida. |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido. |
PositionedObjectProperties
Propiedades de un PositionedObject
Representación JSON |
---|
{ "positioning": { object ( |
Campos | |
---|---|
positioning |
La posición de este objeto posicionado en relación con la nueva línea de |
embeddedObject |
El objeto incorporado de este objeto posicionado |
PositionedObjectPositioning
El posicionamiento de un PositionedObject
El objeto posicionado se posiciona en relación con el comienzo de la Paragraph
a la que está conectado.
Representación JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
El diseño de este objeto posicionado |
leftOffset |
El desplazamiento del borde izquierdo del objeto posicionado en relación con el comienzo de la |
topOffset |
El desplazamiento del borde superior del objeto posicionado en relación con el comienzo de la |
Diseño de objeto posicionado
Los posibles diseños de un objeto [PositionedObject][google.aps.docs.v1.PositionedObject]
Enumeradores | |
---|---|
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 esté a la izquierda y el texto a la derecha. |
BREAK_RIGHT |
Divide el texto de modo que el objeto posicionado se encuentre a la derecha y el texto esté a la izquierda. |
BREAK_LEFT_RIGHT |
Rompe el texto de modo que no haya texto a la izquierda o 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. |
PropertiesPositionedObjectProperties
Un cambio sugerido para PositionedObjectProperties
.
Representación JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Un |
positionedObjectPropertiesSuggestionState |
Es una máscara que indica cuáles de los campos en el |
PositionedObjectPropertiesSugerenciaionState
Es una máscara que indica cuáles de los campos en el 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 |
Es una máscara que indica cuál de los campos en |
embeddedObjectSuggestionState |
Es una máscara que indica cuál de los campos en |
PositionedObjectPositioningSugerenciaionState
Es una máscara que indica cuáles de los campos en el PositionedObjectPositioning
base se modificaron 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 se sugirió un cambio a |
leftOffsetSuggested |
Indica si se sugirió un cambio a |
topOffsetSuggested |
Indica si se sugirió un cambio a |
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. |