- Recurso: Documento
- Cuerpo
- StructuralElement
- Párrafo
- ParagraphElement
- TextRun
- TextStyle
- OpcionalColor
- Color
- Color Rgb
- Dimensión
- Unidad
- WeightedFontFamily
- BaselineOffset
- Vínculo
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Tipo
- Salto de página
- ColumnBreak
- Referencia de la nota al pie
- HorizontalRule
- Ecuación
- InlineObjectElement
- Person
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType;
- Alineación
- ContentDirection
- SpacingMode
- ParagraphBorder
- Estilo de guion
- TabStop
- TabStopAlignment
- Sombreado
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Viñeta
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle.
- Tipo de sección
- Tabla
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- Tipo de ancho
- TableOfContents
- Encabezado
- Pie de página
- Nota al pie
- DocumentStyle.
- Segundo plano
- Tamaño
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Lista
- ListProperties
- NestingLevel
- Alineación de viñetas
- Tipo de glifos
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- RangoNombre
- Rango
- SuggestionsViewMode
- InlineObject
- InlineObjectProperties
- EmbedObject
- EmbedDrawingProperties
- ImageProperties
- CropProperties
- EmbedObjectBorder
- Estado de la propiedad
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionsionState
- CropPropertiesSuggestionState
- EmbedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- Métodos
Recurso: Documento
Un documento 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. El cuerpo principal del documento. |
headers |
Solo salida. Los encabezados del documento, protegidos por el ID de encabezado. |
footers |
Solo salida. Los pies de página del documento, protegidos por el ID del pie de página. |
footnotes |
Solo salida. Las notas al pie en el documento, marcadas por el ID de la nota al pie. |
documentStyle |
Solo salida. El estilo del documento |
suggestedDocumentStyleChanges |
Solo salida. Los cambios sugeridos para el estilo del documento, protegidos por el ID de sugerencia. |
namedStyles |
Solo salida. Los estilos con nombre del documento. |
suggestedNamedStylesChanges |
Solo salida. Los cambios sugeridos para los estilos con nombre del documento, protegidos por el ID de sugerencia. |
lists |
Solo salida. Las listas del documento, ordenadas por el ID de lista. |
namedRanges |
Solo salida. Los rangos con nombre en el documento, protegidos por el nombre. |
revisionId |
Solo salida. El ID de revisión del documento. Se puede usar en las solicitudes de actualización para especificar a qué revisión de un documento 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. Solo se garantiza que un ID de revisión devuelto sea válido durante 24 horas después de haberse mostrado y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre llamadas, el documento no se modifica. Por el contrario, un ID modificado (para el mismo documento y usuario) suele indicar que se actualizó el documento. Sin embargo, los IDs modificados también pueden deberse a factores internos, como modificaciones en el formato de los IDs. |
suggestionsViewMode |
Solo salida. El modo de vista de sugerencias aplicado al documento. Nota: Cuando editas un documento, los cambios deben basarse en un documento con |
inlineObjects |
Solo salida. Los objetos intercalados en el documento, con clave por ID de objeto. |
positionedObjects |
Solo salida. Los objetos posicionados en el documento, protegidos por el ID de objeto. |
Cuerpo
Es el cuerpo del documento.
Por lo general, el cuerpo incluye el contenido completo del documento, excepto headers
, footers
y footnotes
.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
El contenido del cuerpo Los índices del contenido del cuerpo comienzan en cero. |
StructuralElement
Un StructuralElement describe el contenido que proporciona estructura al documento.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
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, en unidades de código UTF-16. |
Campo de unión content . Contenido del elemento estructural. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
paragraph |
Tipo de párrafo de elemento estructural. |
sectionBreak |
Es un tipo de salto de sección de un elemento estructural. |
table |
Es un tipo de tabla de elemento estructural. |
tableOfContents |
Es un tipo de índice de elemento estructural. |
Párrafo
Es una StructuralElement
que representa un párrafo. Un párrafo es un rango de contenido que termina con un carácter de salto de línea.
Representación JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
El contenido del párrafo, desglosado en sus partes componentes. |
paragraphStyle |
El estilo de este párrafo. |
suggestedParagraphStyleChanges |
El estilo de párrafo sugerido cambia a este, con clave por 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 en la viñeta de este párrafo. |
positionedObjectIds[] |
Son los ID de los objetos posicionados anclados a este párrafo. |
suggestedPositionedObjectIds |
Los ID de los objetos posicionados que se sugieren adjuntar a este párrafo, ordenados por ID de sugerencia. |
Elemento de párrafo
Un ParagraphElement describe contenido dentro de un Paragraph
.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
El índice de inicio basado en cero de este elemento de párrafo, en unidades de código UTF-16. |
endIndex |
El índice final 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 del 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 del párrafo de salto de página |
columnBreak |
Un elemento del párrafo del salto de columna. |
footnoteReference |
Un elemento de párrafo de referencia de nota al pie. |
horizontalRule |
Un elemento de párrafo de regla horizontal. |
equation |
Elemento de un párrafo de ecuación. |
inlineObjectElement |
Un elemento de párrafo de objeto intercalado. |
person |
Un elemento de párrafo que se vincula a una persona o dirección de correo electrónico. |
richLink |
Un elemento de párrafo que se vincula a un recurso de Google (como un archivo de Google Drive, un video de YouTube o un evento de Calendario). |
TextRun
Es una ParagraphElement
que representa una ejecución de texto con el mismo estilo.
Representación JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
Es el texto de esta ejecución. Cualquier elemento que no sea de texto en la ejecución se reemplaza con el carácter Unicode U+E907. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, 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 por ID de sugerencia. |
TextStyle
Representa el estilo que se puede aplicar al texto.
En este mensaje, los estilos de texto heredados se representan como campos sin configurar. El elemento superior de un estilo de texto depende de dónde se defina el estilo de texto:
- El TextStyle del texto en una
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 de
normal text
hereda del estilo de texto predeterminado del editor de Documentos. - El TextStyle de un elemento
Paragraph
que se encuentra en una tabla puede heredar su estilo de texto del estilo de tabla.
Si el estilo de texto no se hereda de uno de los elementos superiores, cuando se anula la configuración de campos, se revertirá el estilo a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Indica si el texto está en negrita o no. |
italic |
Indica si el texto está en cursiva o no. |
underline |
Indica si el texto está subrayado o no. |
strikethrough |
Indica si el texto está tachado o no. |
smallCaps |
Indica si el texto está en mayúsculas o no. |
backgroundColor |
Color de fondo del texto Si se establece, el color será RGB o transparente, según el campo |
foregroundColor |
Color de primer plano del texto Si se establece, el color será RGB o transparente, según el campo |
fontSize |
Es el tamaño de la fuente del texto. |
weightedFontFamily |
Es la familia de fuentes y el grosor representado del texto. Si una solicitud de actualización especifica valores para Si Si se configura |
baselineOffset |
Desplazamiento vertical del texto con respecto a su posición normal. El texto con desplazamientos de referencia de |
link |
Indica el destino del hipervínculo del texto. Si no la estableces, no habrá ningún vínculo. Los vínculos no se heredan del texto superior. Cambiar el vínculo en una solicitud de actualización genera otros cambios en el estilo de texto del rango:
|
Color opcional
Color que puede ser completamente opaco o completamente transparente.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Si se establece, se usará como un color opaco. Si no se establece, representará un color transparente. |
Color
Un color liso.
Representación JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
Es el valor de color RGB. |
Color RGB
Un color RGB
Representación JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
Indica el componente rojo del color, de 0.0 a 1.0. |
green |
El componente verde del color, de 0.0 a 1.0. |
blue |
El componente azul del color, de 0.0 a 1.0. |
Dimensión
Es una magnitud en una sola dirección en las unidades especificadas.
Representación JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Campos | |
---|---|
magnitude |
La magnitud. |
unit |
Las unidades para magnitud. |
Unidad
Unidades de medida.
Enumeradores | |
---|---|
UNIT_UNSPECIFIED |
Las unidades son desconocidas. |
PT |
Un punto, 1/72 de pulgada. |
WeightedFontFamily
Representa una familia de fuentes y el grosor del texto.
Representación JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
fontFamily |
La familia de fuentes del texto La familia de fuentes puede ser cualquier fuente del menú Fuente de Documentos o de Google Fonts. Si no se reconoce el nombre de la fuente, el texto se renderiza en |
weight |
El grosor de la fuente. Este campo puede tener cualquier valor que sea múltiplo de El valor predeterminado es El grosor de la fuente constituye solo un componente del grosor de la fuente renderizada. Una combinación de
|
Desfase de referencia
Indica las formas en las que el texto se puede desplazar verticalmente desde su posición normal.
Enumeradores | |
---|---|
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 de URL externo.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión destination . Es el destino del vínculo. Las direcciones (destination ) solo pueden ser una de las siguientes opciones: |
|
url |
Una URL externa. |
bookmarkId |
El ID de un favorito en este documento. |
headingId |
Es el ID de un encabezado de este documento. |
Estilodetexto sugerido
Es un cambio sugerido para una TextStyle
.
Representación JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Un |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos en el |
EstadodeSugerenciadeEstiloTexto
Una máscara que indica cuáles de los campos en el TextStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Campos | |
---|---|
boldSuggested |
Indica si se sugirió un cambio en |
italicSuggested |
Indica si se sugirió un cambio en |
underlineSuggested |
Indica si se sugirió un cambio en |
strikethroughSuggested |
Indica si se sugirió un cambio en |
smallCapsSuggested |
Indica si se sugirió un cambio en |
backgroundColorSuggested |
Indica si se sugirió un cambio en |
foregroundColorSuggested |
Indica si se sugirió un cambio en |
fontSizeSuggested |
Indica si se sugirió un cambio en |
weightedFontFamilySuggested |
Indica si se sugirió un cambio en |
baselineOffsetSuggested |
Indica si se sugirió un cambio en |
linkSuggested |
Indica si se sugirió un cambio en |
Texto automático
Un elemento ParagraphElement
que representa un punto 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 IDs de inserción sugeridos. Un elemento |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
textStyle |
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.
Enumeradores | |
---|---|
TYPE_UNSPECIFIED |
Un tipo de texto automático no especificado. |
PAGE_NUMBER |
El tipo de texto automático que representa el número de página actual. |
PAGE_COUNT |
El tipo de texto automático que representa la cantidad total de páginas en el documento. |
Salto de página
Un objeto ParagraphElement
que representa un salto de página Un salto de página hace que el texto posterior comience en la parte superior de la página siguiente.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
textStyle |
El estilo de texto de este salto de página. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de página puede afectar el diseño del contenido y el estilo del texto insertado 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 posterior comience en la parte superior de la siguiente columna.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
textStyle |
El estilo de texto de este ColumnBreak. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de columna puede afectar el diseño del contenido y el estilo del texto insertado junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este ColumnBreak, con clave por ID de sugerencia. |
Referencia de la nota al pie
Un objeto ParagraphElement
que representa una referencia de nota al pie Una referencia de nota al pie es el contenido intercalado que se renderiza con un número y se usa para identificar la nota al pie.
Representación JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnoteId |
El ID de |
footnoteNumber |
El número renderizado de esta nota al pie. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
textStyle |
El estilo de texto de esta FootnoteReference. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a esta FootnoteReference, codificado por 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 IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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 de notas al pie, el estilo de texto de una regla horizontal puede afectar el diseño del contenido y el estilo del texto insertado junto a ella. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a esta HorizontalRule, vinculada por ID de sugerencia. |
Ecuación
Es una ParagraphElement
que representa una ecuación.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un elemento |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
InlineObjectElement
Es un objeto ParagraphElement
que contiene un InlineObject
.
Representación JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inlineObjectId |
El ID de |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un elemento |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
textStyle |
El estilo de texto de este InlineObjectElement. Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un elemento de objeto intercalado puede afectar el diseño del contenido y el estilo del texto insertado junto a él. |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este InlineObject, vinculado por ID de sugerencia. |
Person
Una persona o dirección de correo electrónico que se menciona en un documento. Estas se comportan como un único 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[] |
ID para sugerencias que insertan el vínculo de esta persona en el documento. Un |
suggestedDeletionIds[] |
ID para sugerencias que quitan el vínculo de esta persona del documento. Una |
textStyle |
Es el estilo de texto de este elemento |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este |
personProperties |
Solo salida. Las propiedades de este |
Propiedades personales
Propiedades específicas de un Person
vinculado
Representación JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
Solo salida. Es el nombre de la persona si se muestra en el texto del vínculo en lugar de la dirección de correo electrónico de la persona. |
email |
Solo salida. La dirección de correo electrónico vinculada a este |
Vínculo enriquecido
Un vínculo a un recurso de Google (como un archivo en Drive, un video de YouTube o un evento del Calendario)
Representación JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
richLinkId |
Solo salida. Es el ID de este vínculo. |
suggestedInsertionIds[] |
ID para sugerencias que insertan este vínculo en el documento. Un |
suggestedDeletionIds[] |
ID para sugerencias que quitan este vínculo del documento. Una |
textStyle |
Es el estilo de texto de este elemento |
suggestedTextStyleChanges |
El estilo de texto sugerido cambia a este |
richLinkProperties |
Solo salida. Las propiedades de este |
Propiedades de vínculos enriquecidos
Propiedades específicas de un 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 defina el estilo de párrafo:
- El ParagraphStyle en una
Paragraph
hereda delnamed style type
correspondiente del párrafo. - El ParagraphStyle en un
named style
hereda del estilo con nombrenormal text
. - El ParagraphStyle del estilo con nombre
normal text
hereda del estilo de párrafo predeterminado del editor de Documentos. - En un elemento
Paragraph
que se encuentra en una tabla, ParagraphStyle puede heredar su estilo de párrafo del estilo de tabla.
Si el estilo de párrafo no se hereda de uno superior, al quitar los campos, se revertirá el estilo a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
El ID de encabezado del párrafo. Si está vacío, este párrafo no es un encabezado. Esta propiedad es de solo lectura. |
namedStyleType |
El tipo de estilo con nombre del párrafo. Dado que la actualización del tipo de diseño con nombre afecta a otras propiedades dentro de ParagraphStyle, el tipo de estilo con nombre se aplica antes que las demás propiedades. |
alignment |
La alineación del texto para este párrafo. |
lineSpacing |
La cantidad de espacio entre líneas, como un porcentaje de normal, donde normal se representa como 100.0. Si no se establece, el valor se hereda del elemento superior. |
direction |
La dirección del texto de este párrafo. Si no se establece, el valor predeterminado es |
spacingMode |
El modo de espaciado del párrafo. |
spaceAbove |
La cantidad de espacio adicional encima del párrafo. Si no se establece, el valor se hereda 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 |
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 intermedio se renderiza cuando el párrafo adyacente tiene las mismas propiedades de borde y sangría. Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo. |
borderTop |
Borde en la parte superior de este párrafo. Si no se establece, el valor se hereda del elemento superior. El borde superior se renderiza cuando el párrafo anterior tiene diferentes propiedades de borde y sangría. Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo. |
borderBottom |
Borde que aparece en la parte inferior de este párrafo. Si no se establece, el valor se hereda del elemento superior. El borde inferior se renderiza cuando el párrafo siguiente tiene propiedades de borde y sangría diferentes. Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo. |
borderLeft |
Es el borde a la izquierda de este párrafo. Si no se establece, el valor se hereda del elemento superior. Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo. |
borderRight |
Borde a la derecha de este párrafo. Si no se establece, el valor se hereda del elemento superior. Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo. |
indentFirstLine |
La cantidad de sangría para la primera línea del párrafo. Si no se establece, el valor se hereda del elemento superior. |
indentStart |
La cantidad de sangría para el párrafo en el lado que corresponde al inicio del texto, en función de la dirección actual del párrafo. Si no se establece, el valor se hereda del elemento superior. |
indentEnd |
La cantidad de sangría para el párrafo en el lado que corresponde al final del texto, según la dirección actual del párrafo. Si no se establece, el valor se hereda del elemento superior. |
tabStops[] |
Una lista de las tabulaciones para este párrafo. La lista de tabulaciones no se hereda. Esta propiedad es de solo lectura. |
keepLinesTogether |
Si todas las líneas del párrafo deben disponerse en la misma página o columna, si es posible. Si no se establece, el valor se hereda del elemento superior. |
keepWithNext |
Indica si, al menos, una parte de este párrafo debe disponerse en la misma página o columna que el siguiente párrafo, si es posible. Si no se establece, el valor se hereda del elemento superior. |
avoidWidowAndOrphan |
Indica si se deben evitar las viudas o los huérfanos para el párrafo. Si no se establece, el valor se hereda del elemento superior. |
shading |
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 |
TipoDeEstiloNombre
Los tipos de estilos con nombre.
Enumeradores | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
No se especifica el tipo de diseño con nombre. |
NORMAL_TEXT |
Texto normal |
TITLE |
Título. |
SUBTITLE |
Subtítulo. |
HEADING_1 |
Encabezado 1. |
HEADING_2 |
Encabezado 2. |
HEADING_3 |
Encabezado 3. |
HEADING_4 |
Encabezado 4. |
HEADING_5 |
Encabezado 5. |
HEADING_6 |
Encabezado 6. |
Alineación
Los tipos de alineación de texto para un párrafo.
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 a la izquierda para texto de izquierda a derecha; de lo contrario, alineado a la derecha |
CENTER |
El párrafo está centrado. |
END |
El párrafo se alinea al final de la línea. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda |
JUSTIFIED |
El párrafo está justificado. |
Dirección de contenido
El contenido de las instrucciones sobre cómo llegar puede fluir.
Enumeradores | |
---|---|
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. |
Modo de espaciado
Los diferentes modos de espaciado entre párrafos.
Enumeradores | |
---|---|
SPACING_MODE_UNSPECIFIED |
El modo de espaciado se hereda del elemento superior. |
NEVER_COLLAPSE |
El espaciado de párrafo se renderiza siempre. |
COLLAPSE_LISTS |
Se omite el espaciado de párrafo entre los elementos de la lista. |
Borde de párrafo
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 |
Estilo de guion del borde |
Estilo de Dash
Son 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: Aspectos básicos y referencia del lenguaje de marcado", parte 1 de la 4a edición ECMA-376.
Enumeradores | |
---|---|
DASH_STYLE_UNSPECIFIED |
Estilo de guion no especificado |
SOLID |
Línea continua. Corresponde al valor “solid” de ECMA-376 ST_PresetLineDashVal. Este es el estilo de guion predeterminado. |
DOT |
Línea de puntos. Corresponde al valor "punto" de ECMA-376 ST_PresetLineDashVal. |
DASH |
Línea punteada. Corresponde al valor "guion" de ECMA-376 ST_PresetLineDashVal. |
Parada de tabulación
Una tabulación en un párrafo.
Representación JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
El desplazamiento entre esta parada de tabulación y el margen inicial |
alignment |
La alineación de esta tabulación Si no se establece, el valor predeterminado es |
TabStopAlignment
La alineación de la tabulación
Enumeradores | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
La alineación 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 |
La tabulación está alineada con el centro de la línea. |
END |
La tabulación está alineada al final de la línea. |
Sombreado
Sombreado de un párrafo
Representación JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
backgroundColor |
El color de fondo del sombreado de este párrafo |
EstiloPárrafo sugerido
Es un cambio sugerido para una ParagraphStyle
.
Representación JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Un |
paragraphStyleSuggestionState |
Una máscara que indica cuáles de los campos en el |
Estado de sugerencia de estilo de párrafo
Una máscara que indica cuáles de los campos en el 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 se sugirió un cambio en |
namedStyleTypeSuggested |
Indica si se sugirió un cambio en |
alignmentSuggested |
Indica si se sugirió un cambio en |
lineSpacingSuggested |
Indica si se sugirió un cambio en |
directionSuggested |
Indica si se sugirió un cambio en |
spacingModeSuggested |
Indica si se sugirió un cambio en |
spaceAboveSuggested |
Indica si se sugirió un cambio en |
spaceBelowSuggested |
Indica si se sugirió un cambio en |
borderBetweenSuggested |
Indica si se sugirió un cambio en |
borderTopSuggested |
Indica si se sugirió un cambio en |
borderBottomSuggested |
Indica si se sugirió un cambio en |
borderLeftSuggested |
Indica si se sugirió un cambio en |
borderRightSuggested |
Indica si se sugirió un cambio en |
indentFirstLineSuggested |
Indica si se sugirió un cambio en |
indentStartSuggested |
Indica si se sugirió un cambio en |
indentEndSuggested |
Indica si se sugirió un cambio en |
keepLinesTogetherSuggested |
Indica si se sugirió un cambio en |
keepWithNextSuggested |
Indica si se sugirió un cambio en |
avoidWidowAndOrphanSuggested |
Indica si se sugirió un cambio en |
shadingSuggestionState |
Una máscara que indica cuáles de los campos de |
pageBreakBeforeSuggested |
Indica si se sugirió un cambio en |
Estado de sugerencia de sombreado
Una máscara que indica cuáles de los campos en el Shading
base se cambiaron en este cambio sugerido. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si 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 |
El ID de la lista a la que pertenece este párrafo. |
nestingLevel |
El nivel de anidación de este párrafo en la lista. |
textStyle |
El estilo de texto específico del párrafo aplicado a esta viñeta. |
Viñeta sugerida
Es un cambio sugerido para una Bullet
.
Representación JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Un |
bulletSuggestionState |
Una máscara que indica cuáles de los campos en el |
Estado de sugerencia de viñeta
Una máscara que indica cuáles de los campos en el Bullet
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
listIdSuggested |
Indica si se sugirió un cambio en |
nestingLevelSuggested |
Indica si se sugirió un cambio en |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
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 nueva sección, 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 IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
sectionStyle |
El estilo de la sección después de este salto de sección. |
Estilo de la sección
El estilo que se aplica a una sección.
Representación JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
columnProperties[] |
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 actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se mostrará un error 400 de solicitud incorrecta. |
columnSeparatorStyle |
El estilo de los separadores de columna. Este estilo se puede configurar incluso cuando hay una columna en la sección. Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
contentDirection |
La dirección del contenido de esta sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
marginTop |
El margen superior de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
marginBottom |
Es el margen inferior de la página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará 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 actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará 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 actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
marginHeader |
El margen del encabezado de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
marginFooter |
El margen del pie de página de la sección. Si no se establece, el valor predeterminado es Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
sectionType |
Solo salida. Es el tipo de sección. |
defaultHeaderId |
El ID del encabezado predeterminado. Si no se establece, se hereda del valor de la sección Esta propiedad es de solo lectura. |
defaultFooterId |
El ID del pie de página predeterminado. Si no se establece, se hereda del valor de la sección Esta propiedad es de solo lectura. |
firstPageHeaderId |
El ID del encabezado que se utiliza solo para la primera página de la sección. Si el elemento Esta propiedad es de solo lectura. |
firstPageFooterId |
Es el ID del pie de página que se utiliza solo para la primera página de la sección. Si el elemento Esta propiedad es de solo lectura. |
evenPageHeaderId |
Es el ID del encabezado que se usa 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 primera página de la sección. Si no se establece, se hereda del elemento Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
pageNumberStart |
Es el número de página desde la que se empieza a contar la cantidad de páginas de esta sección. Si no la estableces, la numeración de páginas continuará desde la sección anterior. Si no se establece el valor en la primera Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
flipPageOrientation |
Opcional. Indica si se deben girar las dimensiones de Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta. |
Propiedades de la columna
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 |
Relleno al final de la columna. |
Estilo deSeparadordecolumnas
El estilo de los separadores de columna 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 separadora de columnas entre cada columna. |
SectionType
Representa la posición del inicio de la sección actual en relación con la sección anterior.
Enumeradores | |
---|---|
SECTION_TYPE_UNSPECIFIED |
No se especifica el tipo de sección. |
CONTINUOUS |
La sección comienza inmediatamente después del último párrafo de la sección anterior. |
NEXT_PAGE |
La sección comienza en la página siguiente. |
Tabla
Es un objeto StructuralElement
que representa una tabla.
Representación JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
Campos | |
---|---|
rows |
Cantidad de filas en la tabla. |
columns |
Cantidad de columnas en la tabla. Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener un número de celdas diferente. |
tableRows[] |
El contenido y el estilo de cada fila |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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 |
El índice de inicio basado en cero de esta fila, en unidades de código UTF-16. |
endIndex |
El índice final basado en cero de esta fila, exclusivo, en unidades de código UTF-16. |
tableCells[] |
El contenido y el estilo de cada celda en esta fila. Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad de celdas diferente a otras en la misma tabla. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
tableRowStyle |
El estilo de la fila de la tabla. |
suggestedTableRowStyleChanges |
El estilo sugerido cambia a esta fila, con clave por ID de sugerencia. |
TableCell
El contenido y el estilo de una celda en una 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, en unidades de código UTF-16. |
content[] |
El contenido de la celda. |
tableCellStyle |
El estilo de la celda. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
suggestedTableCellStyleChanges |
Los cambios sugeridos en el estilo de celda de la tabla, protegidos por el ID de sugerencia. |
Estilo_CeldadeTabla
Es el estilo de un TableCell
.
Los estilos de celda de tabla heredados se representan como campos sin configurar en este mensaje. Un estilo de celda de tabla puede heredar del estilo de la tabla.
Representación JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Campos | |
---|---|
rowSpan |
El intervalo de filas de la celda. Esta propiedad es de solo lectura. |
columnSpan |
El intervalo de columnas de la celda. Esta propiedad es de solo lectura. |
backgroundColor |
Color de fondo de la celda. |
borderLeft |
Borde izquierdo de la celda. |
borderRight |
Borde derecho de la celda |
borderTop |
Borde superior de la celda |
borderBottom |
Borde inferior de la celda |
paddingLeft |
Relleno izquierdo de la celda. |
paddingRight |
Relleno derecho de la celda. |
paddingTop |
Relleno superior de la celda. |
paddingBottom |
Relleno inferior de la celda. |
contentAlignment |
La alineación del contenido en la celda de la tabla La alineación predeterminada coincide con la alineación de las celdas de tabla recién creadas en el editor de Documentos. |
Bordedetabla
Borde alrededor de una celda de una tabla.
Los bordes de las celdas de las tablas no pueden ser transparentes. Para ocultar el borde de una celda de una tabla, establece su 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 |
Estilo de guion del borde |
Alineación de contenido
Los tipos de alineación de contenido.
Derivado de un subconjunto de valores del tipo simple "ST_TextAnchoringType" en la sección 20.1.10.59 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de la ECMA-376 4a edición.
Enumeradores | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Una alineación de contenido no especificada La alineación del contenido se hereda del elemento superior, si existe. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Una alineación de contenido no compatible |
TOP |
Una alineación que alinea el contenido con la parte superior del contenedor de contenido Corresponde a ECMA-376 ST_TextAnchoringType “t”. |
MIDDLE |
Una alineación que alinea el contenido con el centro del contenedor de contenido Corresponde a ECMA-376 ST_TextAnchoringType “ctr”. |
BOTTOM |
Una alineación que alinea el contenido con la parte inferior del contenedor de contenido Corresponde a ECMA-376 ST_TextAnchoringType "b". |
SuggestedTableCellStyle
Es un cambio sugerido para una TableCellStyle
.
Representación JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Un |
tableCellStyleSuggestionState |
Una máscara que indica cuáles de los campos en el |
Estado de sugerencia de estilo de tabla
Una máscara que indica cuáles de los campos en el TableCellStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Campos | |
---|---|
rowSpanSuggested |
Indica si se sugirió un cambio en |
columnSpanSuggested |
Indica si se sugirió un cambio en |
backgroundColorSuggested |
Indica si se sugirió un cambio en |
borderLeftSuggested |
Indica si se sugirió un cambio en |
borderRightSuggested |
Indica si se sugirió un cambio en |
borderTopSuggested |
Indica si se sugirió un cambio en |
borderBottomSuggested |
Indica si se sugirió un cambio en |
paddingLeftSuggested |
Indica si se sugirió un cambio en |
paddingRightSuggested |
Indica si se sugirió un cambio en |
paddingTopSuggested |
Indica si se sugirió un cambio en |
paddingBottomSuggested |
Indica si se sugirió un cambio en |
contentAlignmentSuggested |
Indica si se sugirió un cambio en |
Estilo TableRow
Estilos que se aplican a una fila de tabla.
Representación JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
La altura mínima de la fila. En el Editor de Documentos, la fila se renderizará a una altura igual o superior a este valor para mostrar todo el contenido en las celdas de la fila. |
tableHeader |
Si la fila es un encabezado de tabla |
preventOverflow |
Indica si la fila no puede desbordarse en los límites de páginas o columnas. |
Estilo FilaTablaSugerida
Es un cambio sugerido para una TableRowStyle
.
Representación JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Un |
tableRowStyleSuggestionState |
Una máscara que indica cuáles de los campos en el |
Estado de sugerencia de estilo de tabla fila
Una máscara que indica cuáles de los campos en el 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 se sugirió un cambio en |
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 HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el |
Propiedades 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 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 porción igual del ancho restante para la tabla después de considerar 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. |
Tabla de contenidos
Es un objeto StructuralElement
que representa un índice.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
Es el contenido del índice. |
suggestedInsertionIds[] |
Son los IDs de inserción sugeridos. Un |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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 del contenido de un encabezado comienzan en cero. |
Nota a pie de página
Una nota al pie del 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
El estilo del documento
Representación JSON |
---|
{ "background": { object ( |
Campos | |
---|---|
background |
El fondo del documento Los documentos no pueden tener un color de fondo transparente. |
defaultHeaderId |
El ID del encabezado predeterminado. Si no la estableces, no habrá un encabezado predeterminado. Esta propiedad es de solo lectura. |
defaultFooterId |
El ID del pie de página predeterminado. Si no la estableces, no habrá un pie de página predeterminado. Esta propiedad es de solo lectura. |
evenPageHeaderId |
Es el ID del encabezado que se usa solo para páginas pares. El valor de Esta propiedad es de solo lectura. |
evenPageFooterId |
Es el ID del pie de página que se usa solo para las páginas pares. El valor de Esta propiedad es de solo lectura. |
firstPageHeaderId |
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 utiliza solo para la primera página. Si no se establece, no existirá un pie de página único para la primera página. El valor de Esta propiedad es de solo lectura. |
useFirstPageHeaderFooter |
Indica si se deben usar los ID de encabezado o pie de página de la primera página. |
useEvenPageHeaderFooter |
Indica si se deben usar los ID de encabezado o pie de página en las páginas pares. |
pageNumberStart |
Es el número de página desde la que se comienza a contar la cantidad de páginas. |
marginTop |
Margen superior de la página. Si actualizas el margen superior de la página en el estilo del documento, se borrará ese margen en todos los estilos de sección. |
marginBottom |
Es el margen inferior de la página. Si actualizas el margen de la página inferior en el estilo del documento, este se borrará de 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á el margen derecho de la página en todos los estilos de sección. También puede hacer que las columnas cambien de tamaño en todas las secciones. |
marginLeft |
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 todos los estilos de sección. También puede hacer que las columnas cambien de tamaño en todas las secciones. |
pageSize |
Es el tamaño de una página 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. |
flipPageOrientation |
Opcional. Indica si se deben girar las dimensiones de |
Información general
Representa el fondo de un documento.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Color de fondo |
Tamaño
El ancho y la altura
Representación JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
La altura del objeto. |
width |
El ancho del objeto. |
SuggestedDocumentStyle
Se sugiere un cambio en DocumentStyle
.
Representación JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
documentStyle |
Un |
documentStyleSuggestionState |
Una máscara que indica cuáles de los campos en el |
Estado de sugerencia de estilo de documento
Una máscara que indica cuáles de los campos en el DocumentStyle
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
backgroundSuggestionState |
Una máscara que indica cuáles de los campos de |
defaultHeaderIdSuggested |
Indica si se sugirió un cambio en |
defaultFooterIdSuggested |
Indica si se sugirió un cambio en |
evenPageHeaderIdSuggested |
Indica si se sugirió un cambio en |
evenPageFooterIdSuggested |
Indica si se sugirió un cambio en |
firstPageHeaderIdSuggested |
Indica si se sugirió un cambio en |
firstPageFooterIdSuggested |
Indica si se sugirió un cambio en |
useFirstPageHeaderFooterSuggested |
Indica si se sugirió un cambio en |
useEvenPageHeaderFooterSuggested |
Indica si se sugirió un cambio en |
pageNumberStartSuggested |
Indica si se sugirió un cambio en |
marginTopSuggested |
Indica si se sugirió un cambio en |
marginBottomSuggested |
Indica si se sugirió un cambio en |
marginRightSuggested |
Indica si se sugirió un cambio en |
marginLeftSuggested |
Indica si se sugirió un cambio en |
pageSizeSuggestionState |
Una máscara que indica cuáles de los campos de [tamaño] [google.apps.docs.v1.DocumentStyle.size] se cambiaron en esta sugerencia. |
marginHeaderSuggested |
Indica si se sugirió un cambio en |
marginFooterSuggested |
Indica si se sugirió un cambio en |
useCustomHeaderFooterMarginsSuggested |
Indica si se sugirió un cambio en |
flipPageOrientationSuggested |
Opcional. Indica si se sugirió un cambio en |
Estado de sugerencia de fondo
Una máscara que indica cuáles de los campos en el Background
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, Backgound
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica si el color de fondo actual se modificó en esta sugerencia. |
Estado de SugerenciasDeTamaño
Una máscara que indica cuáles de los campos en el Size
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, Size
tiene un nuevo valor sugerido.
Representación JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
heightSuggested |
Indica si se sugirió un cambio en |
widthSuggested |
Indica si se sugirió un cambio en |
EstilosNombre
Los estilos con nombre Los párrafos del documento pueden heredar sus TextStyle
y ParagraphStyle
de estos estilos con nombre.
Representación JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Los estilos con nombre Hay una entrada para cada una de las |
EstiloNombre
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 |
El estilo de texto de este estilo con nombre. |
paragraphStyle |
El estilo de párrafo de este estilo con nombre. |
Estilos con nombre sugeridos
Se sugiere un cambio en NamedStyles
.
Representación JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Un |
namedStylesSuggestionState |
Una máscara que indica cuáles de los campos en el |
EstadodeSugerenciadeEstilosNombre
El estado de sugerencia de un mensaje NamedStyles
.
Representación JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
stylesSuggestionStates[] |
Una máscara que indica cuáles de los campos del El orden de estos estados de sugerencias de estilo con nombre coincide con el del estilo con nombre correspondiente dentro de la sugerencia |
Estado de sugerencia de estilo con nombre
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 es útil para hacer coincidir el elemento NamedStyleSuggestionState con su |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
paragraphStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
Ir a la 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 |
Las propiedades de la lista. |
suggestedListPropertiesChanges |
Los cambios sugeridos para las propiedades de la lista, protegidos por el ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacío, no es una inserción sugerida. |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si está vacío, no hay eliminaciones sugeridas para esta lista. |
ListProperties
Las propiedades de una list
que describen el aspecto de las viñetas que pertenecen a 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 el que el nivel de anidamiento 0 corresponde al nivel superior y el nivel 8 de anidación, que corresponde al nivel más anidado. Los niveles de anidación 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 anidamiento.
Representación JSON |
---|
{ "bulletAlignment": enum ( |
Campos | |
---|---|
bulletAlignment |
La alineación de la viñeta dentro del espacio asignado para renderizarla |
glyphFormat |
Es la string 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 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 superior. Por ejemplo, una lista puede tener un formato de glifo de
En el caso de los niveles de anidación ordenados, la string que reemplaza un marcador de posición en el formato de glifo para un párrafo en particular depende del orden de párrafo dentro de la lista. |
indentFirstLine |
La cantidad de sangría para la primera línea de párrafos en este nivel de anidación. |
indentStart |
La cantidad de sangría para los párrafos en este nivel de anidación. Se aplica en el lado que corresponde al inicio del texto, según la dirección del contenido del párrafo. |
textStyle |
El estilo de texto de las viñetas en este nivel de anidación. |
startNumber |
Es el número del primer elemento de la lista en este nivel de anidación. El valor igual a 0 se considera un valor de 1 en las listas con letras y con 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 niveles de anidación con glifos desordenados. |
Campo de unión glyph_kind . Es el tipo de glifo que usan las viñetas. Esto define el glifo de la viñeta que reemplaza los marcadores de posición en el glyph_format . glyph_kind puede ser solo uno de los siguientes: |
|
glyphType |
Es el tipo de glifo que usan las viñetas cuando los párrafos en este nivel de anidación están ordenados. El tipo de glifo determina el tipo de glifo que se usa para reemplazar los marcadores de posición en |
glyphSymbol |
Es un símbolo de glifo personalizado que utilizan 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 en |
Alineación de viñetas
Los tipos de alineación de una viñeta.
Enumeradores | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
La alineación de viñetas no está especificada. |
START |
La viñeta se alinea con el inicio del espacio asignado para renderizarla. Alineado a la izquierda para texto de izquierda a derecha; de lo contrario, alineado a la derecha |
CENTER |
La viñeta está alineada con el centro del espacio designado para renderizarla. |
END |
La viñeta está alineada con el final del espacio asignado para renderizarla. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda |
Tipo de glifos
Son los tipos de glifos que utilizan las viñetas cuando los párrafos en este nivel de anidación están ordenados.
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 |
Es 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 con más de un dígito no tienen el prefijo cero. |
UPPER_ALPHA |
Una letra mayúscula, como A , B o C |
ALPHA |
Una letra minúscula, como a , b o c . |
UPPER_ROMAN |
Un número romano en mayúsculas, como I , II o III . |
ROMAN |
Un número romano en minúscula, como i , ii o iii . |
SuggestedListProperties
Se sugirió un cambio para ListProperties
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Un |
listPropertiesSuggestionState |
Una máscara que indica cuáles de los campos en el |
Estado de sugerencia de ListProperties
Una máscara que indica cuáles de los campos en el ListProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Campos | |
---|---|
nestingLevelsSuggestionStates[] |
Una máscara que indica cuáles de los campos del Los estados de sugerencias del nivel de anidamiento se muestran en orden ascendente con respecto al nivel de anidación, con el menos anidado que se muestra primero. |
Estado de sugerencia de nivel de anidación
Una máscara que indica cuáles de los campos en el NestingLevel
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
bulletAlignmentSuggested |
Indica si se sugirió un cambio en |
glyphTypeSuggested |
Indica si se sugirió un cambio en |
glyphFormatSuggested |
Indica si se sugirió un cambio en |
glyphSymbolSuggested |
Indica si se sugirió un cambio en |
indentFirstLineSuggested |
Indica si se sugirió un cambio en |
indentStartSuggested |
Indica si se sugirió un cambio en |
textStyleSuggestionState |
Una máscara que indica cuáles de los campos de |
startNumberSuggested |
Indica si se sugirió un cambio en |
RangosNombre
Es una colección de todas las 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 |
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 forma 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 Range
, y el contenido insertado dentro de un rango con nombre generalmente expande ese rango. Sin embargo, ciertos cambios en los documentos pueden hacer que el rango se divida en varios.
Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tienen acceso al documento pueden 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 contiguo de texto.
Representación JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
Campos | |
---|---|
segmentId |
El ID del encabezado, el pie de página o la nota al pie en el que se encuentra 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 un Int32Value para adaptarse a futuros casos de uso con rangos abiertos. |
endIndex |
El índice final basado en cero de este rango, exclusivo, en unidades de código UTF-16. En todos los usos actuales, se debe proporcionar un índice final. Este campo es un Int32Value para adaptarse a futuros casos de uso con rangos abiertos. |
Modo de vista de sugerencias
El modo de vista de sugerencias que se aplica al documento y que indica cómo se representan los cambios sugeridos. Proporciona opciones para leer el documento con todas las sugerencias intercaladas, aceptadas o rechazadas.
Enumeradores | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
El modo 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 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 sugerencias en el documento. |
InlineObject
Un objeto que aparece intercalado con texto. Un InlineObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
objectId |
Es el ID de este objeto intercalado. Se puede usar para actualizar las propiedades de un objeto. |
inlineObjectProperties |
Las propiedades de este objeto intercalado. |
suggestedInlineObjectPropertiesChanges |
Los cambios sugeridos para las propiedades del objeto intercalados, protegidos por el ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacío, no es una inserción sugerida. |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
InlineObjectProperties
Propiedades de un InlineObject
Representación JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
Es el objeto incorporado de este objeto intercalado. |
Objeto incorporado
Es un objeto incorporado en el documento.
Representación JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Campos | |
---|---|
title |
Es el título del objeto incorporado. |
description |
Es la descripción del objeto incorporado. |
embeddedObjectBorder |
Borde del objeto incorporado. |
size |
El tamaño visible de la imagen después del recorte. |
marginTop |
Es el margen superior del objeto incorporado. |
marginBottom |
Es el margen inferior del objeto incorporado. |
marginRight |
El margen derecho del objeto incorporado |
marginLeft |
Es el margen izquierdo del objeto incorporado. |
linkedContentReference |
Una referencia al contenido fuente vinculado externo. Por ejemplo, contiene una referencia al gráfico fuente de Hojas de cálculo de Google cuando el objeto incorporado es un gráfico vinculado. Si no la estableces, el objeto incorporado no se vinculará. |
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 |
Las propiedades de una imagen. |
EmbedDrawingProperties
Este tipo no tiene campos.
Son las propiedades de un dibujo incorporado y se usan para diferenciar el tipo de objeto. Un dibujo incorporado es aquel que se crea y edita dentro de un documento. Ten en cuenta que no se admiten muchos 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 para la imagen con una vida útil predeterminada de 30 minutos. Este URI se etiqueta con la cuenta del solicitante. Cualquier persona con el URI accede de manera efectiva a la imagen como el solicitante original. Si cambia la configuración de uso compartido del documento, es posible que se pierda el acceso a la imagen. |
sourceUri |
El URI de origen es el URI que se usa para insertar la imagen. El URI de origen puede estar vacío. |
brightness |
El efecto de brillo de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], en el que 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], en el que 0 significa que no hay efecto. |
transparency |
El efecto de transparencia de la imagen. El valor debe estar en el intervalo [0.0, 1.0], donde 0 significa sin efecto y 1 significa transparente. |
cropProperties |
Las propiedades de recorte de la imagen. |
angle |
El ángulo de rotación en el sentido de las manecillas del reloj de la imagen, en radianes. |
Propiedades de recorte
Las propiedades de recorte de una imagen.
El rectángulo de recorte 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 qué tan lejos se encuentra el borde izquierdo del rectángulo de recorte desde el borde izquierdo del contenido original como una fracción del ancho del contenido original. |
offsetRight |
El desplazamiento especifica qué tan lejos se encuentra el 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 qué tan lejos se encuentra 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 qué tan lejos se encuentra el 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 sentido horario del rectángulo de recorte alrededor de su centro, en radianes. La rotación se aplica después de las compensaciones. |
EmbedObjectBorder
Es un borde alrededor de una EmbeddedObject
.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
El color del borde |
width |
El ancho del borde. |
dashStyle |
Estilo de guion del borde |
propertyState |
El estado de la propiedad fronteriza. |
Estado de propiedad
Los estados posibles 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, entonces el elemento no tiene la propiedad correspondiente cuando se representa en el documento. |
ReferenciadelContenidoLinked
Una referencia al contenido fuente vinculado externo.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión reference . Es la referencia específica al tipo de contenido vinculado. Las direcciones (reference ) solo pueden ser una de las siguientes opciones: |
|
sheetsChartReference |
Una referencia al gráfico vinculado. |
Referencia de gráficos de Hojas de cálculo
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 Google que contiene el gráfico fuente. |
chartId |
ID del gráfico específico incorporado en la hoja de cálculo de Google. |
SuggestedInlineObjectProperties
Se sugirió un cambio para InlineObjectProperties
.
Representación JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Un |
inlineObjectPropertiesSuggestionState |
Una máscara que indica cuáles de los campos en el |
InlineObjectPropertiesSuggestionState
Una máscara que indica cuáles de los campos en el InlineObjectProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embeddedObjectSuggestionState |
Una máscara que indica cuáles de los campos de |
Estado de sugerencias de objetos incorporados
Una máscara que indica cuáles de los campos en el EmbeddedObject
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Una máscara que indica cuáles de los campos de |
imagePropertiesSuggestionState |
Una máscara que indica cuáles de los campos de |
titleSuggested |
Indica si se sugirió un cambio en |
descriptionSuggested |
Indica si se sugirió un cambio en |
embeddedObjectBorderSuggestionState |
Una máscara que indica cuáles de los campos de |
sizeSuggestionState |
Una máscara que indica cuáles de los campos de |
marginLeftSuggested |
Indica si se sugirió un cambio en |
marginRightSuggested |
Indica si se sugirió un cambio en |
marginTopSuggested |
Indica si se sugirió un cambio en |
marginBottomSuggested |
Indica si se sugirió un cambio en |
linkedContentReferenceSuggestionState |
Una máscara que indica cuáles de los campos de |
EmbedDrawingPropertiesSuggestionState
Este tipo no tiene campos.
Una máscara que indica cuáles de los campos en el EmbeddedDrawingProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Estado de sugerencia de propiedades de la imagen
Una máscara que indica cuáles de los campos en el ImageProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
contentUriSuggested |
Indica si se sugirió un cambio en |
sourceUriSuggested |
Indica si se sugirió un cambio en [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indica si se sugirió un cambio en el [brillo] [google.apps.docs.v1.EmbedObject.brightness]. |
contrastSuggested |
Indica si se sugirió un cambio en [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indica si se sugirió un cambio en la [transparencia] [google.apps.docs.v1.EmbedObject.transparency]. |
cropPropertiesSuggestionState |
Una máscara que indica cuáles de los campos de |
angleSuggested |
Indica si se sugirió un cambio para [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
Estado de sugerencia de propiedades de recorte
Una máscara que indica cuáles de los campos en el CropProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offsetLeftSuggested |
Indica si se sugirió un cambio en |
offsetRightSuggested |
Indica si se sugirió un cambio en |
offsetTopSuggested |
Indica si se sugirió un cambio en |
offsetBottomSuggested |
Indica si se sugirió un cambio en |
angleSuggested |
Indica si se sugirió un cambio en |
EmbedObjectBorderSuggestionState
Una máscara que indica cuáles de los campos en el EmbeddedObjectBorder
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Campos | |
---|---|
colorSuggested |
Indica si se sugirió un cambio para el color [color] [google.apps.docs.v1.EmbedBorderObject.color]. |
widthSuggested |
Indica si se sugirió un cambio para [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indica si se sugirió un cambio en [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indica si se sugirió un cambio en [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
Estado de sugerenciasdereferenciadecontenidovinculado
Una máscara que indica cuáles de los campos en el LinkedContentReference
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Una máscara que indica cuáles de los campos de |
Estado de sugerencias de referencia de Hojas de cálculo
Una máscara que indica cuáles de los campos en el SheetsChartReference
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica si se sugirió un cambio en |
chartIdSuggested |
Indica si se sugirió un cambio en |
PositionedObject
Un objeto que está anclado a un Paragraph
y posicionado 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 |
Es el ID de este objeto posicionado. |
positionedObjectProperties |
Las propiedades de este objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
Los cambios sugeridos para las propiedades de objetos posicionados, protegidos por el ID de sugerencia. |
suggestedInsertionId |
El ID de inserción sugerido. Si está vacío, no es una inserción sugerida. |
suggestedDeletionIds[] |
Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación de este contenido. |
PositionedObjectProperties
Propiedades de un PositionedObject
Representación JSON |
---|
{ "positioning": { object ( |
Campos | |
---|---|
positioning |
Es la posición de este objeto posicionado en relación con el salto de línea del |
embeddedObject |
Es el objeto incorporado de este objeto posicionado. |
PositionedObjectPositioning
Es el posicionamiento de un PositionedObject
. El objeto posicionado se posiciona respecto del comienzo del Paragraph
al que está anclado.
Representación JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
Es el diseño de este objeto posicionado. |
leftOffset |
Desplazamiento del borde izquierdo del objeto posicionado en relación con el comienzo del |
topOffset |
El desplazamiento del borde superior del objeto posicionado en relación con el comienzo del elemento |
PositionedObjectLayout
Los diseños posibles de un [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 esté 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 |
Divide el texto de modo que no haya texto a la izquierda o 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
Se sugirió un cambio para PositionedObjectProperties
.
Representación JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Un |
positionedObjectPropertiesSuggestionState |
Una máscara que indica cuáles de los campos en el |
PositionedObjectPropertiesSuggestionState
Una máscara que indica cuáles de los campos en el PositionedObjectProperties
base se cambiaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.
Representación JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioningSuggestionState |
Una máscara que indica cuáles de los campos de |
embeddedObjectSuggestionState |
Una máscara que indica cuáles de los campos de |
PositionedObjectPositioningSuggestionState
Una máscara que indica cuáles de los campos en el 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 se sugirió un cambio en |
leftOffsetSuggested |
Indica si se sugirió un cambio en |
topOffsetSuggested |
Indica si se sugirió un cambio en |
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 última versión del documento especificado. |