- Recurso: Documento
- Tab
- TabProperties
- DocumentTab
- Cuerpo
- StructuralElement
- Párrafo
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Color
- RgbColor
- Dimensión
- Unidad
- WeightedFontFamily
- BaselineOffset
- Vínculo
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Tipo
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Ecuación
- InlineObjectElement
- Persona
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- Alineación
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- Sombreado
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Viñeta
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Tabla
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- Header
- Pie de página
- Nota al pie
- DocumentStyle
- Antecedentes
- Tamaño
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Lista
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Rango
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- Propiedades de imágenes
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- Métodos
Recurso: Documento
Un documento de Documentos de Google.
Representación JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
Campos | |
---|---|
document |
Solo salida. Es el ID del documento. |
title |
Es el título del documento. |
tabs[] |
Son pestañas que forman parte de un documento. Las pestañas pueden contener pestañas secundarias, una pestaña anidada dentro de otra. Las pestañas secundarias se representan con el campo |
revision |
Solo salida. El ID de la revisión del documento. Se puede usar en solicitudes de actualización para especificar a qué revisión de un documento se deben aplicar las actualizaciones y cómo debe comportarse la solicitud si el documento se editó desde esa revisión. Solo se completa si el usuario tiene acceso de edición al documento. El ID de revisión no es un número secuencial, sino una cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Se garantiza que un ID de revisión devuelto solo será válido durante 24 horas después de que se devuelva y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre llamadas, significa que el documento no cambió. Por el contrario, un ID modificado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un ID cambiado también puede deberse a factores internos, como cambios en el formato del ID. |
suggestions |
Solo salida. Es el modo de vista de sugerencias aplicado al documento. Nota: Cuando edites un documento, los cambios deben basarse en un documento con |
body |
Solo salida. Es el cuerpo principal del documento. Campo heredado: En su lugar, usa |
headers |
Solo salida. Los encabezados del documento, ordenados por ID de encabezado Campo heredado: En su lugar, usa |
footers |
Solo salida. Los pies de página del documento, ordenados por ID de pie de página Campo heredado: En su lugar, usa |
footnotes |
Solo salida. Las notas al pie del documento, ordenadas por ID de nota al pie Campo heredado: En su lugar, usa |
document |
Solo salida. Es el estilo del documento. Campo heredado: En su lugar, usa |
suggested |
Solo salida. Los cambios sugeridos en el estilo del documento, ordenados por ID de sugerencia. Campo heredado: En su lugar, usa |
named |
Solo salida. Los estilos con nombre del documento. Campo heredado: En su lugar, usa |
suggested |
Solo salida. Los cambios sugeridos en los estilos nombrados del documento, ordenados por ID de sugerencia. Campo heredado: En su lugar, usa |
lists |
Solo salida. Las listas del documento, ordenadas por ID de lista Campo heredado: En su lugar, usa |
named |
Solo salida. Los rangos con nombre del documento, ordenados por nombre Campo heredado: En su lugar, usa |
inline |
Solo salida. Los objetos intercalados en el documento, ordenados por ID de objeto. Campo heredado: En su lugar, usa |
positioned |
Solo salida. Los objetos posicionados en el documento, ordenados por ID de objeto Campo heredado: En su lugar, usa |
Tab
Una pestaña en un documento.
Representación JSON |
---|
{ "tabProperties": { object ( |
Campos | |
---|---|
tab |
Las propiedades de la pestaña, como el ID y el título. |
child |
Las pestañas secundarias anidadas dentro de esta pestaña |
Campo de unión content . Es el contenido de la pestaña. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
document |
Es una pestaña con el contenido del documento, como texto e imágenes. |
TabProperties
Propiedades de una pestaña.
Representación JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
Campos | |
---|---|
tab |
Solo salida. Es el ID de la pestaña. No se puede cambiar este campo. |
title |
Es el nombre visible de la pestaña para el usuario. |
parent |
Opcional. Es el ID de la pestaña superior. Está vacío cuando la pestaña actual es de nivel raíz, lo que significa que no tiene ningún elemento superior. |
index |
El índice basado en cero de la pestaña dentro del elemento superior. |
nesting |
Solo salida. Es la profundidad de la pestaña dentro del documento. Las pestañas a nivel de la raíz comienzan en 0. |
DocumentTab
Una pestaña con el contenido del documento.
Representación JSON |
---|
{ "body": { object ( |
Campos | |
---|---|
body |
Es el cuerpo principal de la pestaña del documento. |
headers |
Los encabezados de la pestaña del documento, ordenados por ID de encabezado |
footers |
Los pies de página de la pestaña del documento, ordenados por ID de pie de página |
footnotes |
Las notas al pie de la pestaña del documento, ordenadas por ID de nota al pie |
document |
Es el estilo de la pestaña del documento. |
suggested |
Los cambios sugeridos en el estilo de la pestaña del documento, ordenados por ID de sugerencia |
named |
Los estilos nombrados de la pestaña del documento. |
suggested |
Los cambios sugeridos en los estilos nombrados de la pestaña del documento, ordenados por ID de sugerencia |
lists |
Las listas de la pestaña Documento, ordenadas por ID de lista |
named |
Los rangos con nombre de la pestaña del documento, ordenados por nombre |
inline |
Los objetos intercalados en la pestaña del documento, ordenados por ID de objeto |
positioned |
Los objetos posicionados en la pestaña del documento, ordenados por ID de objeto |
Cuerpo
Es el cuerpo del documento.
Por lo general, el cuerpo contiene el contenido completo del documento, excepto headers
, footers
y footnotes
.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
Es el contenido del cuerpo. Los índices del contenido del cuerpo comienzan en cero. |
StructuralElement
Un elemento estructural describe el contenido que proporciona estructura al documento.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
start |
Es el índice de inicio basado en cero de este elemento estructural, en unidades de código UTF-16. |
end |
Es el índice de finalización basado en cero de este elemento estructural, exclusivo, en unidades de código UTF-16. |
Campo de unión content . Es el contenido del elemento estructural. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
paragraph |
Es un tipo de elemento estructural de párrafo. |
section |
Es un tipo de elemento estructural de pausa de sección. |
table |
Es un tipo de elemento estructural de tabla. |
table |
Un elemento estructural de tipo índice. |
Párrafo
Un StructuralElement
que representa un párrafo. Un párrafo es un rango de contenido que finaliza con un carácter de nueva línea.
Representación JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
El contenido del párrafo, desglosado en sus partes componentes. |
paragraph |
Es el estilo de este párrafo. |
suggested |
El estilo de párrafo sugerido cambia a este párrafo, con clave de ID de sugerencia. |
bullet |
El punto de viñeta de este párrafo. Si no está presente, el párrafo no pertenece a una lista. |
suggested |
Los cambios sugeridos en la viñeta de este párrafo. |
positioned |
Los IDs de los objetos posicionados vinculados a este párrafo. |
suggested |
Los IDs de los objetos posicionados que se sugirió adjuntar a este párrafo, ordenados por ID de sugerencia |
ParagraphElement
Un ParagraphElement describe el contenido dentro de un Paragraph
.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
start |
Es el índice de inicio basado en cero de este elemento de párrafo, en unidades de código UTF-16. |
end |
Es el índice de finalización basado en cero de este elemento de párrafo, exclusivo, en unidades de código UTF-16. |
Campo de unión content . Es el contenido del elemento párrafo. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
text |
Es un elemento de párrafo de texto continuo. |
auto |
Un elemento de párrafo de texto automático. |
page |
Un elemento de párrafo de salto de página. |
column |
Un elemento de párrafo de salto de columna. |
footnote |
Es un elemento de párrafo de referencia de nota al pie. |
horizontal |
Es un elemento de párrafo de línea horizontal. |
equation |
Un elemento de párrafo de ecuación. |
inline |
Un elemento de párrafo de objeto intercalado. |
person |
Es un elemento de párrafo que vincula a una persona o dirección de correo electrónico. |
rich |
Es un elemento de párrafo que vincula a un recurso de Google (como un archivo en Google Drive, un video de YouTube o un evento de Calendario). |
TextRun
Un ParagraphElement
que representa un texto que tiene el mismo estilo.
Representación JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
Es el texto de esta ejecución. Los elementos que no sean de texto en la ejecución se reemplazan por el carácter Unicode U+E907. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de esta ejecución. |
suggested |
El estilo de texto sugerido cambia a esta ejecución, con clave de ID de sugerencia. |
TextStyle
Representa el diseño que se puede aplicar al texto.
Los estilos de texto heredados se representan como campos no establecidos en este mensaje. El elemento superior de un estilo de texto depende de dónde se define:
- El TextStyle del 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 llamado
normal text
hereda del estilo de texto predeterminado en el editor de Documentos. - El TextStyle en un elemento
Paragraph
que se incluye en una tabla puede heredar su estilo de texto del estilo de la tabla.
Si el estilo de texto no hereda de un elemento superior, si no estableces los campos, el estilo volverá a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Indica si el texto se renderiza en negrita o no. |
italic |
Indica si el texto está en cursiva o no. |
underline |
Indica si el texto está subrayado o no. |
strikethrough |
Indica si el texto está tachado o no. |
small |
Indica si el texto está en mayúsculas pequeñas o no. |
background |
Es el color de fondo del texto. Si se establece, el color es RGB o transparente, según el campo |
foreground |
Es el color de primer plano del texto. Si se establece, el color es RGB o transparente, según el campo |
font |
Es el tamaño de la fuente del texto. |
weighted |
La familia de fuentes y el grosor renderizado del texto. Si una solicitud de actualización especifica valores para Si no se establece Si se establece |
baseline |
Es el desplazamiento vertical del texto desde su posición normal. El texto con compensaciones de referencia |
link |
Es el destino del hipervínculo del texto. Si no se establece, no hay vínculo. Los vínculos no se heredan del texto superior. Cambiar el vínculo en una solicitud de actualización provoca otros cambios en el estilo de texto del rango:
|
OptionalColor
Es un color que puede ser 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, representa un color transparente. |
Color
Un color sólido.
Representación JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgb |
Es el valor de color RGB. |
RgbColor
Un color RGB.
Representación JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
Es el componente rojo del color, de 0.0 a 1.0. |
green |
Es el componente verde del color, de 0.0 a 1.0. |
blue |
Es 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 de magnitud. |
Unidad
Unidades de medida.
Enumeraciones | |
---|---|
UNIT_UNSPECIFIED |
Las unidades son desconocidas. |
PT |
Un punto, 1/72 de pulgada. |
WeightedFontFamily
Representa una familia de fuentes y un grosor de texto.
Representación JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
font |
Es la familia de fuentes del texto. La familia de fuentes puede ser cualquier fuente del menú Fuente en Documentos o de Google Fonts. Si no se reconoce el nombre de la fuente, el texto se renderiza en |
weight |
El grosor de la fuente. Este campo puede tener cualquier valor que sea un múltiplo de El valor predeterminado es El grosor de la fuente solo constituye un componente del grosor de la fuente renderizada. Una combinación de
|
BaselineOffset
Son las formas en que el texto se puede desplazar verticalmente desde su posición normal.
Enumeraciones | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
El desplazamiento de la línea base 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. |
tab |
Es el ID de una pestaña en este documento. |
bookmark |
Un favorito en este documento. En los documentos que contienen una sola pestaña, los vínculos a favoritos dentro de la pestaña única siguen mostrando |
heading |
Un encabezado en este documento. En los documentos que contienen una sola pestaña, los vínculos a encabezados dentro de la pestaña única siguen mostrando |
bookmark |
Es el ID de un favorito en este documento. Campo heredado: En su lugar, establece Si se usa este campo en una solicitud de escritura, se considera que el favorito proviene del ID de la pestaña especificado en la solicitud. Si no se especifica un ID de pestaña en la solicitud, se considera que proviene de la primera pestaña del documento. |
heading |
Es el ID de un encabezado en este documento. Campo heredado: En su lugar, establece Si se usa este campo en una solicitud de escritura, se considera que el encabezado proviene del ID de la pestaña especificado en la solicitud. Si no se especifica un ID de pestaña en la solicitud, se considera que proviene de la primera pestaña del documento. |
BookmarkLink
Es una referencia a un favorito en este documento.
Representación JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
Es el ID de un favorito en este documento. |
tab |
Es el ID de la pestaña que contiene este favorito. |
HeadingLink
Es una referencia a un encabezado en este documento.
Representación JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
Es el ID de un encabezado en este documento. |
tab |
Es el ID de la pestaña que contiene este encabezado. |
SuggestedTextStyle
Un cambio sugerido en un TextStyle
.
Representación JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
text |
Un |
text |
Una máscara que indica cuáles de los campos de la |
TextStyleSuggestionState
Una máscara que indica cuáles de los campos de la TextStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Campos | |
---|---|
bold |
Indica si hubo un cambio sugerido en |
italic |
Indica si hubo un cambio sugerido en |
underline |
Indica si hubo un cambio sugerido en |
strikethrough |
Indica si hubo un cambio sugerido en |
small |
Indica si hubo un cambio sugerido en |
background |
Indica si hubo un cambio sugerido en |
foreground |
Indica si hubo un cambio sugerido en |
font |
Indica si hubo un cambio sugerido en |
weighted |
Indica si hubo un cambio sugerido en |
baseline |
Indica si hubo un cambio sugerido en |
link |
Indica si hubo un cambio sugerido en |
AutoText
Un ParagraphElement
que representa un lugar en el texto que se reemplaza de forma dinámica por contenido que puede cambiar con el tiempo, como un número de página.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Es el tipo de texto automático. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de este texto automático. |
suggested |
El estilo de texto sugerido cambia a este texto automático, con clave de ID de sugerencia. |
Tipo
Los tipos de texto automático.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Es un tipo de texto automático no especificado. |
PAGE_NUMBER |
Escribe el texto automático que representa el número de página actual. |
PAGE_COUNT |
Escribe para obtener texto automático que represente la cantidad total de páginas del documento. |
PageBreak
Un 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 | |
---|---|
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de este Salto de página. Al igual que el contenido de texto, como los textos continuos y las referencias de notas al pie, el estilo de texto de un salto de página puede afectar el diseño del contenido, así como el estilo del texto que se inserta junto a él. |
suggested |
El estilo de texto sugerido cambia a este Salto de página, con clave de ID de sugerencia. |
ColumnBreak
Un ParagraphElement
que representa un salto de columna. Un salto de columna hace que el texto siguiente comience en la parte superior de la siguiente columna.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de este ColumnBreak. Al igual que el contenido de texto, como los textos continuos y las referencias de notas al pie, el estilo de texto de un corte de columna puede afectar el diseño del contenido, así como el estilo del texto que se inserta junto a él. |
suggested |
El estilo de texto sugerido cambia a este ColumnBreak, con clave de ID de sugerencia. |
FootnoteReference
Un ParagraphElement
que representa una referencia de nota al pie. Una referencia de nota al pie es el contenido intercalado renderizado con un número y se usa para identificar la nota al pie.
Representación JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnote |
El ID del |
footnote |
El número renderizado de esta nota al pie. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de esta FootnoteReference. |
suggested |
El estilo de texto sugerido cambia a esta FootnoteReference, con clave de ID de sugerencia. |
HorizontalRule
Un ParagraphElement
que representa una línea horizontal.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de esta HorizontalRule. Al igual que el contenido de texto, como los textos continuos y las referencias de notas al pie, el estilo de texto de una línea horizontal puede afectar el diseño del contenido, así como el estilo del texto que se inserta junto a él. |
suggested |
El estilo de texto sugerido cambia a esta HorizontalRule, con clave de ID de sugerencia. |
Ecuación
Un ParagraphElement
que representa una ecuación.
Representación JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
InlineObjectElement
Un ParagraphElement
que contiene un InlineObject
.
Representación JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inline |
Es el ID del |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
text |
Es el estilo de texto de este InlineObjectElement. Al igual que el contenido de texto, como los textos y las referencias de notas al pie, el estilo de texto de un elemento de objeto intercalado puede afectar el diseño del contenido y el estilo del texto que se inserta junto a él. |
suggested |
El estilo de texto sugerido cambia a este InlineObject, con clave de ID de sugerencia. |
Persona
Una persona o 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 | |
---|---|
person |
Solo salida. El ID único de este vínculo. |
suggested |
Son los IDs de las sugerencias que insertan el vínculo de esta persona en el documento. Un |
suggested |
IDs de las sugerencias que quitan el vínculo de esta persona del documento. Un |
text |
Es el estilo de texto de este |
suggested |
El estilo de texto sugerido cambia a este |
person |
Solo salida. Las propiedades de este |
PersonProperties
Son propiedades específicas de un Person
vinculado.
Representación JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
Solo salida. El nombre de la persona si se muestra en el texto del vínculo en lugar de su dirección de correo electrónico. |
email |
Solo salida. Es la dirección de correo electrónico vinculada a esta |
RichLink
Un vínculo a un recurso de Google (como un archivo en Drive, un video de YouTube o un evento de Calendario)
Representación JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
rich |
Solo salida. Es el ID de este vínculo. |
suggested |
Son los IDs de las sugerencias que insertan este vínculo en el documento. Un |
suggested |
IDs de las sugerencias que quitan este vínculo del documento. Un |
text |
Es el estilo de texto de este |
suggested |
El estilo de texto sugerido cambia a este |
rich |
Solo salida. Las propiedades de este |
RichLinkProperties
Propiedades específicas de un RichLink
.
Representación JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Solo salida. Es el título del |
uri |
Solo salida. Es el URI de |
mime |
Solo salida. El tipo de MIME de |
ParagraphStyle
Son los estilos que se aplican a un párrafo completo.
Los estilos de párrafo heredados se representan como campos no establecidos en este mensaje. El elemento superior de un estilo de párrafo depende de dónde se define:
- El ParagraphStyle en un
Paragraph
hereda delnamed style type
correspondiente del párrafo. - El ParagraphStyle en un
named style
hereda del estilo llamadonormal text
. - El ParagraphStyle del estilo llamado
normal text
hereda del estilo de párrafo predeterminado en el editor de Documentos. - El ParagraphStyle en un elemento
Paragraph
que se incluye en una tabla puede heredar su estilo de párrafo del estilo de la tabla.
Si el estilo de párrafo no hereda de un elemento superior, si no se establecen los campos, el estilo volverá a un valor que coincida con los valores predeterminados del editor de Documentos.
Representación JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
heading |
Es el ID del encabezado del párrafo. Si está vacío, significa que este párrafo no es un encabezado. Esta propiedad es de solo lectura. |
named |
Es el tipo de estilo con nombre del párrafo. Dado que la actualización del tipo de estilo con nombre afecta a otras propiedades dentro de ParagraphStyle, el tipo de estilo con nombre se aplica antes de que se actualicen las otras propiedades. |
alignment |
Es la alineación del texto de este párrafo. |
line |
Es la cantidad de espacio entre líneas, como un porcentaje de lo normal, donde lo normal se representa como 100.0. Si no se establece, el valor se hereda del elemento superior. |
direction |
Es la dirección del texto de este párrafo. Si no se establece, el valor predeterminado es |
spacing |
Es el modo de espaciado del párrafo. |
space |
Es la cantidad de espacio adicional sobre el párrafo. Si no se establece, el valor se hereda del elemento superior. |
space |
Es la cantidad de espacio adicional debajo del párrafo. Si no se establece, el valor se hereda del elemento superior. |
border |
El borde entre este párrafo y el siguiente y el anterior. Si no se establece, el valor se hereda del elemento superior. El borde entre párrafos se renderiza cuando el párrafo adyacente tiene las mismas propiedades de borde y sangría. No se pueden actualizar parcialmente los bordes de los párrafos. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad. |
border |
El 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. No se pueden actualizar parcialmente los bordes de los párrafos. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad. |
border |
El borde de 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 que se encuentra debajo tiene diferentes propiedades de borde y sangría. No se pueden actualizar parcialmente los bordes de los párrafos. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad. |
border |
El borde que se encuentra a la izquierda de este párrafo. Si no se establece, el valor se hereda del elemento superior. No se pueden actualizar parcialmente los bordes de los párrafos. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad. |
border |
El borde a la derecha de este párrafo. Si no se establece, el valor se hereda del elemento superior. No se pueden actualizar parcialmente los bordes de los párrafos. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad. |
indent |
Es la cantidad de sangría de la primera línea del párrafo. Si no se establece, el valor se hereda del elemento superior. |
indent |
Es la cantidad de sangría del párrafo en el lado que corresponde al inicio del texto, según la dirección del párrafo actual. Si no se establece, el valor se hereda del elemento superior. |
indent |
Es la cantidad de sangría del párrafo en el lado que corresponde al final del texto, según la dirección del párrafo actual. Si no se establece, el valor se hereda del elemento superior. |
tab |
Es una lista de los puntos de tabulación de este párrafo. La lista de tabulaciones no se hereda. Esta propiedad es de solo lectura. |
keep |
Indica si todas las líneas del párrafo deben estar en la misma página o columna, si es posible. Si no se establece, el valor se hereda del elemento superior. |
keep |
Si es posible, si al menos una parte de este párrafo debe estar en la misma página o columna que el siguiente. Si no se establece, el valor se hereda del elemento superior. |
avoid |
Indica si se deben evitar las viudas y los huérfanos para el párrafo. Si no se establece, el valor se hereda del elemento superior. |
shading |
Es el sombreado del párrafo. Si no se establece, el valor se hereda del elemento superior. |
page |
Indica si el párrafo actual siempre debe comenzar al principio de una página. Si no se establece, el valor se hereda del elemento superior. Si intentas actualizar |
NamedStyleType
Los tipos de estilos con nombre.
Enumeraciones | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
No se especifica el tipo de estilo con nombre. |
NORMAL_TEXT |
Texto normal. |
TITLE |
Título. |
SUBTITLE |
Subtítulo. |
HEADING_1 |
Encabezado 1. |
HEADING_2 |
Título 2. |
HEADING_3 |
Título 3. |
HEADING_4 |
Título 4. |
HEADING_5 |
Título 5. |
HEADING_6 |
Título 6. |
Alineación
Son los tipos de alineación de texto para un párrafo.
Enumeraciones | |
---|---|
ALIGNMENT_UNSPECIFIED |
La alineación del párrafo se hereda del elemento superior. |
START |
El párrafo está alineado con el inicio de la línea. Se alinea a la izquierda para el texto LTR y a la derecha para el resto de los casos. |
CENTER |
El párrafo está centrado. |
END |
El párrafo se alinea con el final de la línea. Se alinea a la derecha para el texto LTR y a la izquierda para el resto de los casos. |
JUSTIFIED |
El párrafo está justificado. |
ContentDirection
El contenido de las instrucciones puede fluir.
Enumeraciones | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
No se especificó la dirección del contenido. |
LEFT_TO_RIGHT |
El contenido va de izquierda a derecha. |
RIGHT_TO_LEFT |
El contenido va de derecha a izquierda. |
SpacingMode
Los diferentes modos de espaciado de párrafos.
Enumeraciones | |
---|---|
SPACING_MODE_UNSPECIFIED |
El modo de espaciado se hereda del elemento superior. |
NEVER_COLLAPSE |
El espaciado de párrafo siempre se renderiza. |
COLLAPSE_LISTS |
Se omite el espaciado de párrafo entre los elementos de la lista. |
ParagraphBorder
Un borde alrededor de un párrafo.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
Es el color del borde. |
width |
Es el ancho del borde. |
padding |
Es el padding del borde. |
dash |
Es el estilo de línea del borde. |
DashStyle
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” que se describe en el artículo 20.1.10.48 de “Office Open XML File Formats - Fundamentals and Markup Language Reference”, parte 1 de la ECMA-376 4ª edición.
Enumeraciones | |
---|---|
DASH_STYLE_UNSPECIFIED |
Estilo de guion no especificado. |
SOLID |
Línea continua. Corresponde al valor "solid" de ST_PresetLineDashVal de ECMA-376. Este es el estilo de guion predeterminado. |
DOT |
Línea punteada. Corresponde al valor "dot" de ST_PresetLineDashVal de ECMA-376. |
DASH |
Línea punteada. Corresponde al valor "dash" de ST_PresetLineDashVal de ECMA-376. |
TabStop
Es un punto de tabulación dentro de un párrafo.
Representación JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
Es el desplazamiento entre este punto de tabulación y el margen de inicio. |
alignment |
La alineación de este punto de tabulación. Si no se establece, el valor predeterminado es |
TabStopAlignment
Es la alineación de la parada de tabulación.
Enumeraciones | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
La alineación del punto de tabulación no está especificada. |
START |
El punto de tabulación está alineado con el inicio de la línea. Esta es la opción predeterminada. |
CENTER |
El punto de tabulación está alineado con el centro de la línea. |
END |
El punto de tabulación está alineado con el final de la línea. |
Sombreado
Es el sombreado de un párrafo.
Representación JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
background |
Es el color de fondo del sombreado de este párrafo. |
SuggestedParagraphStyle
Un cambio sugerido en un ParagraphStyle
.
Representación JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraph |
Un |
paragraph |
Es una máscara que indica cuáles de los campos de la |
ParagraphStyleSuggestionState
Es una máscara que indica cuáles de los campos de la ParagraphStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
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 | |
---|---|
heading |
Indica si hubo un cambio sugerido en |
named |
Indica si hubo un cambio sugerido en |
alignment |
Indica si hubo un cambio sugerido en |
line |
Indica si hubo un cambio sugerido en |
direction |
Indica si hubo un cambio sugerido en |
spacing |
Indica si hubo un cambio sugerido en |
space |
Indica si hubo un cambio sugerido en |
space |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
indent |
Indica si hubo un cambio sugerido en |
indent |
Indica si hubo un cambio sugerido en |
indent |
Indica si hubo un cambio sugerido en |
keep |
Indica si hubo un cambio sugerido en |
keep |
Indica si hubo un cambio sugerido en |
avoid |
Indica si hubo un cambio sugerido en |
shading |
Es una máscara que indica cuáles de los campos de |
page |
Indica si hubo un cambio sugerido en |
ShadingSuggestionState
Es una máscara que indica cuáles de los campos de la base Shading
se modificaron en este cambio sugerido. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
background |
Indica si hubo un cambio sugerido en el |
Viñeta
Describe la viñeta de un párrafo.
Representación JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
list |
Es el ID de la lista a la que pertenece este párrafo. |
nesting |
Es el nivel de anidamiento de este párrafo en la lista. |
text |
Es el estilo de texto específico del párrafo aplicado a esta viñeta. |
SuggestedBullet
Es un cambio sugerido en un Bullet
.
Representación JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Un |
bullet |
Es una máscara que indica cuáles de los campos de la |
BulletSuggestionState
Una máscara que indica cuáles de los campos de la Bullet
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
list |
Indica si hubo un cambio sugerido en el |
nesting |
Indica si hubo un cambio sugerido en el |
text |
Es una máscara que indica cuáles de los campos de |
ObjectReferences
Es una colección de IDs de objetos.
Representación JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
object |
Los IDs de los objetos |
SectionBreak
Un StructuralElement
que representa un salto de sección. Una sección es un rango de contenido que tiene el mismo SectionStyle
. Un salto de sección representa el inicio de una sección nueva, y el estilo de la sección se aplica a la sección después del salto.
El cuerpo del documento siempre comienza con un corte de sección.
Representación JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
Campos | |
---|---|
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
section |
Es el estilo de la sección después de esta pausa. |
SectionStyle
Es el diseño que se aplica a una sección.
Representación JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
column |
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, es necesario establecer un valor concreto. Si no estableces esta propiedad, se generará un error de solicitud incorrecta 400. |
column |
Es 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, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
content |
Es la dirección del contenido de esta sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
margin |
Es el margen superior de la página de la sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
margin |
Es el margen inferior de la página de la sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
margin |
El margen derecho de la página de la sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
margin |
Es el margen izquierdo de la página de la sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
margin |
Es el margen del encabezado de la sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
margin |
Es el margen de pie de página de la sección. Si no se establece, el valor predeterminado es Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
section |
Solo salida. Es el tipo de sección. |
default |
Es el ID del encabezado predeterminado. Si no se establece, el valor hereda del SectionStyle Esta propiedad es de solo lectura. |
default |
Es el ID del pie de página predeterminado. Si no se establece, el valor hereda del SectionStyle Esta propiedad es de solo lectura. |
first |
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. |
first |
Es el ID del pie de página que se usa solo para la primera página de la sección. Si Esta propiedad es de solo lectura. |
even |
Es el ID del encabezado que se usa solo para las páginas pares. Si el valor de Esta propiedad es de solo lectura. |
even |
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. |
use |
Indica si se deben usar los IDs de encabezado o pie de página de la primera página para la primera página de la sección. Si no se establece, hereda de Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
page |
Es el número de página desde el que se debe comenzar a contar la cantidad de páginas de esta sección. Si no se establece, la numeración de páginas continúa desde la sección anterior. Si el valor no se establece en el primer Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
flip |
Opcional. Indica si se deben invertir las dimensiones de Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400. |
SectionColumnProperties
Son propiedades que se aplican a la columna de una sección.
Representación JSON |
---|
{ "width": { object ( |
Campos | |
---|---|
width |
Solo salida. Es el ancho de la columna. |
padding |
Es el padding al final de la columna. |
ColumnSeparatorStyle
Es el estilo de los separadores de columnas entre las columnas.
Enumeraciones | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Un estilo de separador de columnas no especificado. |
NONE |
No hay líneas separadoras de columnas entre ellas. |
BETWEEN_EACH_COLUMN |
Renderiza una línea separadora de columnas entre cada columna. |
SectionType
Representa cómo se posiciona el inicio de la sección actual en relación con la sección anterior.
Enumeraciones | |
---|---|
SECTION_TYPE_UNSPECIFIED |
No se especificó el tipo de sección. |
CONTINUOUS |
La sección comienza inmediatamente después del último párrafo de la sección anterior. |
NEXT_PAGE |
La sección comienza en la página siguiente. |
Tabla
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. |
table |
El contenido y el estilo de cada fila. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
table |
Es el estilo de la tabla. |
Fila de la tabla
El contenido y el estilo de una fila en un Table
.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Campos | |
---|---|
start |
Es el índice de inicio basado en cero de esta fila, en unidades de código UTF-16. |
end |
Es el índice de finalización de esta fila, exclusivo, basado en cero, en unidades de código UTF-16. |
table |
El contenido y el estilo de cada celda de esta fila. Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad diferente de celdas que otras filas de la misma tabla. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
table |
Es el estilo de la fila de la tabla. |
suggested |
El estilo sugerido cambia a esta fila, con clave de ID de sugerencia. |
TableCell
El contenido y el estilo de una celda en un Table
.
Representación JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
start |
El índice de inicio basado en cero de esta celda, en unidades de código UTF-16. |
end |
El índice de finalización basado en cero de esta celda, exclusivo, en unidades de código UTF-16. |
content[] |
Es el contenido de la celda. |
table |
Es el estilo de la celda. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
suggested |
Los cambios sugeridos en el estilo de la celda de la tabla, ordenados por ID de sugerencia. |
TableCellStyle
Es el estilo de un TableCell
.
Los estilos de celda de tabla heredados se representan como campos no establecidos en este mensaje. El estilo de una celda de tabla puede heredar el estilo de la tabla.
Representación JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Campos | |
---|---|
row |
Es el intervalo de filas de la celda. Esta propiedad es de solo lectura. |
column |
Es el intervalo de columnas de la celda. Esta propiedad es de solo lectura. |
background |
Es el color de fondo de la celda. |
border |
Es el borde izquierdo de la celda. |
border |
Es el borde derecho de la celda. |
border |
Es el borde superior de la celda. |
border |
Es el borde inferior de la celda. |
padding |
Es el padding izquierdo de la celda. |
padding |
Es el padding derecho de la celda. |
padding |
Es el padding superior de la celda. |
padding |
Es el padding inferior de la celda. |
content |
Es la alineación del contenido en la celda de la tabla. La alineación predeterminada coincide con la alineación de las celdas de tablas recién creadas en el editor de Documentos. |
TableCellBorder
Un borde alrededor de una celda de tabla.
Los bordes de las celdas de la tabla no pueden ser transparentes. Para ocultar el borde de una celda de tabla, establece su ancho en 0.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
Es el color del borde. Este color no puede ser transparente. |
width |
Es el ancho del borde. |
dash |
Es el estilo de línea del borde. |
ContentAlignment
Los tipos de alineación de contenido
Se deriva de un subconjunto de los 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 4ª edición.
Enumeraciones | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Una alineación de contenido no especificada La alineación del contenido se hereda del elemento superior, si existe uno. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Una alineación de contenido no admitida |
TOP |
Es una alineación que alinea el contenido con la parte superior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "t". |
MIDDLE |
Es una alineación que alinea el contenido en el medio del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "ctr". |
BOTTOM |
Es una alineación que alinea el contenido con la parte inferior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "b". |
SuggestedTableCellStyle
Un cambio sugerido en un TableCellStyle
.
Representación JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
table |
Un |
table |
Es una máscara que indica cuáles de los campos de la |
TableCellStyleSuggestionState
Una máscara que indica cuáles de los campos de la TableCellStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Campos | |
---|---|
row |
Indica si hubo un cambio sugerido en |
column |
Indica si hubo un cambio sugerido en |
background |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
border |
Indica si hubo un cambio sugerido en |
padding |
Indica si hubo un cambio sugerido en |
padding |
Indica si hubo un cambio sugerido en |
padding |
Indica si hubo un cambio sugerido en |
padding |
Indica si hubo un cambio sugerido en |
content |
Indica si hubo un cambio sugerido en |
TableRowStyle
Son los diseños que se aplican a una fila de la tabla.
Representación JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
min |
Es la altura mínima de la fila. La fila se renderizará en el editor de Documentos con una altura igual o superior a este valor para mostrar todo el contenido de las celdas de la fila. |
table |
Indica si la fila es un encabezado de tabla. |
prevent |
Indica si la fila no puede desbordarse en los límites de la página o la columna. |
SuggestedTableRowStyle
Un cambio sugerido en un TableRowStyle
.
Representación JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
table |
Un |
table |
Una máscara que indica cuáles de los campos de la |
TableRowStyleSuggestionState
Una máscara que indica cuáles de los campos de la TableRowStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
min |
Indica si hubo un cambio sugerido en |
TableStyle
Son los diseños que se aplican a una tabla.
Representación JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
table |
Las propiedades de cada columna. Ten en cuenta que, en Documentos, las tablas contienen filas y las filas contienen celdas, al igual que en HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el |
TableColumnProperties
Son las propiedades de una columna en una tabla.
Representación JSON |
---|
{ "widthType": enum ( |
Campos | |
---|---|
width |
Es el tipo de ancho de la columna. |
width |
Es el ancho de la columna. Se establece cuando el |
WidthType
Es el tipo de ancho de la columna.
Enumeraciones | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
No se especificó el tipo de ancho de columna. |
EVENLY_DISTRIBUTED |
El ancho de la columna se distribuye de manera uniforme entre las otras columnas distribuidas de manera uniforme. El ancho de la columna se determina automáticamente y tendrá una parte igual del ancho restante para la tabla después de tener en cuenta todas las columnas con anchos especificados. |
FIXED_WIDTH |
Un ancho de columna fijo. La propiedad [width][google.apps.docs.v1.TableColumnProperties.width contiene el ancho de la columna. |
TableOfContents
Un StructuralElement
que representa un índice.
Representación JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
Es el contenido del índice. |
suggested |
Los IDs de inserción sugeridos Un |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
Encabezado
Un encabezado de documento.
Representación JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
header |
Es el ID del encabezado. |
content[] |
Es el contenido del encabezado. Los índices del contenido de un encabezado comienzan en cero. |
Nota a pie de página
Una nota al pie de un documento.
Representación JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Campos | |
---|---|
footnote |
Es el ID de la nota al pie. |
content[] |
Es el contenido de la nota a pie de página. Los índices del contenido de una nota al pie comienzan en cero. |
DocumentStyle
Es el estilo del documento.
Representación JSON |
---|
{ "background": { object ( |
Campos | |
---|---|
background |
Es el fondo del documento. Los documentos no pueden tener un color de fondo transparente. |
default |
El ID del encabezado predeterminado. Si no se establece, no hay encabezado predeterminado. Esta propiedad es de solo lectura. |
default |
Es el ID del pie de página predeterminado. Si no se establece, no hay un pie de página predeterminado. Esta propiedad es de solo lectura. |
even |
Es el ID del encabezado que se usa solo para las páginas pares. El valor de Esta propiedad es de solo lectura. |
even |
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. |
first |
Es el ID del encabezado que se usa solo para la primera página. Si no se establece, no existe un encabezado único para la primera página. El valor de Esta propiedad es de solo lectura. |
first |
Es el ID del pie de página que se usa solo para la primera página. Si no se establece, no existe un pie de página único para la primera página. El valor de Esta propiedad es de solo lectura. |
use |
Indica si se deben usar los IDs de encabezado o pie de página de la primera página. |
use |
Indica si se deben usar los IDs de encabezado o pie de página para las páginas pares. |
page |
Es el número de página desde el que se comienza a contar la cantidad de páginas. |
margin |
Es el margen superior de la página. Si actualizas el margen superior de la página en el estilo del documento, se borrará el margen superior de la página en todos los estilos de sección. |
margin |
Es el margen inferior de la página. Si actualizas el margen inferior de la página en el estilo del documento, se borrará el margen inferior de la página en todos los estilos de sección. |
margin |
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 el tamaño de las columnas cambie en todas las secciones. |
margin |
Es el margen izquierdo de la página. Si actualizas el margen izquierdo de la página en el estilo del documento, se borrará el margen izquierdo de la página en todos los estilos de sección. También puede hacer que el tamaño de las columnas cambie en todas las secciones. |
page |
Es el tamaño de una página en el documento. |
margin |
Es la cantidad de espacio entre la parte superior de la página y el contenido del encabezado. |
margin |
Es la cantidad de espacio entre la parte inferior de la página y el contenido del pie de página. |
use |
Indica si se respetan DocumentStyle Esta propiedad es de solo lectura. |
flip |
Opcional. Indica si se deben invertir las dimensiones de |
Segundo plano
Representa el fondo de un documento.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Es el color de fondo. |
Tamaño
Un ancho y una altura.
Representación JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
Es la altura del objeto. |
width |
Es el ancho del objeto. |
SuggestedDocumentStyle
Un cambio sugerido en el DocumentStyle
.
Representación JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
document |
Un |
document |
Una máscara que indica cuáles de los campos de la |
DocumentStyleSuggestionState
Una máscara que indica cuáles de los campos de la DocumentStyle
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
background |
Es una máscara que indica cuáles de los campos de |
default |
Indica si hubo un cambio sugerido en |
default |
Indica si hubo un cambio sugerido en |
even |
Indica si hubo un cambio sugerido en |
even |
Indica si hubo un cambio sugerido en |
first |
Indica si hubo un cambio sugerido en |
first |
Indica si hubo un cambio sugerido en |
use |
Indica si hubo un cambio sugerido en |
use |
Indica si hubo un cambio sugerido en |
page |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
page |
Es una máscara que indica cuáles de los campos en [size] [google.apps.docs.v1.DocumentStyle.size] se cambiaron en esta sugerencia. |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
use |
Indica si hubo un cambio sugerido en |
flip |
Opcional. Indica si hubo un cambio sugerido en |
BackgroundSuggestionState
Es una máscara que indica cuáles de los campos de la Background
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, Backgound
tiene un valor sugerido nuevo.
Representación JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
background |
Indica si se modificó el color de fondo actual en esta sugerencia. |
SizeSuggestionState
Es una máscara que indica cuáles de los campos de la Size
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, Size
tiene un valor sugerido nuevo.
Representación JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
height |
Indica si hubo un cambio sugerido en |
width |
Indica si hubo un cambio sugerido en |
NamedStyles
Los estilos nombrados Los párrafos del documento pueden heredar sus TextStyle
y ParagraphStyle
de estos estilos nombrados.
Representación JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Los estilos nombrados Hay una entrada para cada uno de los |
NamedStyle
Un estilo con nombre. Los párrafos del documento pueden heredar sus TextStyle
y ParagraphStyle
de este estilo con nombre cuando tienen el mismo tipo de estilo con nombre.
Representación JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
named |
Es el tipo de este estilo con nombre. |
text |
Es el estilo de texto de este estilo con nombre. |
paragraph |
Es el estilo de párrafo de este estilo con nombre. |
SuggestedNamedStyles
Un cambio sugerido en el NamedStyles
.
Representación JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
named |
Un |
named |
Una máscara que indica cuáles de los campos de la |
NamedStylesSuggestionState
Es el estado de la sugerencia de un mensaje NamedStyles
.
Representación JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
styles |
Es una máscara que indica cuáles de los campos del El orden de estos estados de sugerencia de diseño con nombre coincide con el orden del diseño con nombre correspondiente dentro de la sugerencia |
NamedStyleSuggestionState
Es un estado de sugerencia de un mensaje NamedStyle
.
Representación JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
named |
Es el tipo de diseño nombrado al que corresponde este estado de sugerencia. Este campo se proporciona para facilitar la coincidencia de NamedStyleSuggestionState con su |
text |
Es una máscara que indica cuáles de los campos de |
paragraph |
Es una máscara que indica cuáles de los campos de |
Lista
Una lista representa los atributos de lista para un grupo de párrafos que pertenecen a la misma lista. Un párrafo que forma parte de una lista tiene una referencia al ID de la lista en su bullet
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
list |
Las propiedades de la lista. |
suggested |
Los cambios sugeridos en las propiedades de la lista, ordenados por ID de sugerencia |
suggested |
El ID de inserción sugerido. Si está vacío, significa que no se trata de una inserción sugerida. |
suggested |
Los IDs de eliminación sugeridos Si está vacía, significa que no hay eliminaciones sugeridas de esta lista. |
ListProperties
Son las propiedades de un list
que describen el aspecto de los viñetas que pertenecen a párrafos asociados con una lista.
Representación JSON |
---|
{
"nestingLevels": [
{
object ( |
Campos | |
---|---|
nesting |
Describe las propiedades de los viñetas en el nivel asociado. Una lista tiene como máximo 9 niveles de anidamiento, en los que el nivel 0 corresponde al nivel superior y el nivel 8 corresponde al nivel más anidado. Los niveles de anidación se muestran en orden ascendente, y el menos anidado se muestra primero. |
NestingLevel
Contiene propiedades que describen el aspecto de una viñeta de lista en un nivel determinado de anidación.
Representación JSON |
---|
{ "bulletAlignment": enum ( |
Campos | |
---|---|
bullet |
Es la alineación de la viñeta dentro del espacio asignado para renderizarla. |
glyph |
Es la cadena de formato que usan los viñetas en este nivel de anidación. El formato de glifo contiene uno o más marcadores de posición, que se reemplazan por los valores adecuados según el Por ejemplo, el formato de glifo
El formato de glifo puede contener marcadores de posición para el nivel de anidación actual, así como marcadores de posición para los niveles de anidación superiores. Por ejemplo, una lista puede tener un formato de glifo de
En el caso de los niveles de anidación ordenados, la cadena que reemplaza un marcador de posición en el formato de glifo de un párrafo en particular depende del orden del párrafo dentro de la lista. |
indent |
Es la cantidad de sangría de la primera línea de los párrafos en este nivel de anidación. |
indent |
Es la cantidad de sangría de los párrafos en este nivel de anidación. Se aplica al lado que corresponde al comienzo del texto, según la dirección del contenido del párrafo. |
text |
Es el estilo de texto de las viñetas en este nivel de anidación. |
start |
Es el número del primer elemento de lista en este nivel de anidamiento. Un valor de 0 se considera como un valor de 1 para las listas de letras y números romanos. Para los valores de 0 y 1, las listas de letras y números romanos comenzarán en Este valor se ignora para los niveles de anidación con glifos no ordenados. |
Campo de unión glyph_kind . Es el tipo de glifo que usan las viñetas. Esto define el glifo de viñeta que reemplaza los marcadores de posición en glyph_format . glyph_kind puede ser solo uno de los siguientes: |
|
glyph |
Es el tipo de glifo que usan las viñetas cuando se ordenan los párrafos en este nivel de anidación. El tipo de glifo determina el tipo de glifo que se usa para reemplazar los marcadores de posición dentro de |
glyph |
Es 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 |
BulletAlignment
Son los tipos de alineación para una viñeta.
Enumeraciones | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
La alineación de viñetas no está especificada. |
START |
El viñeta se alinea con el comienzo del espacio asignado para renderizarlo. Se alinea a la izquierda para el texto LTR y a la derecha para el resto de los casos. |
CENTER |
El viñeta se alinea con el centro del espacio asignado para renderizarlo. |
END |
El viñeta se alinea con el final del espacio asignado para renderizarlo. Se alinea a la derecha para el texto LTR y a la izquierda para el resto de los casos. |
GlyphType
Son los tipos de glifos que usan las viñetas cuando se ordenan los párrafos en este nivel de anidación.
Enumeraciones | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
El tipo de glifo no se especificó o no es compatible. |
NONE |
Una string vacía. |
DECIMAL |
Un número, como 1 , 2 o 3 . |
ZERO_DECIMAL |
Un número en el que los números de un solo dígito tienen un cero como prefijo, como 01 , 02 o 03 . Los números con más de un dígito no tienen un cero como prefijo. |
UPPER_ALPHA |
Una letra mayúscula, como A , B o C . |
ALPHA |
Una letra en minúscula, como a , b o c . |
UPPER_ROMAN |
Un número romano en mayúsculas, como I , II o III . |
ROMAN |
Un número romano en minúsculas, como i , ii o iii . |
SuggestedListProperties
Un cambio sugerido para ListProperties
.
Representación JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
list |
Un |
list |
Es una máscara que indica cuáles de los campos de la |
ListPropertiesSuggestionState
Es una máscara que indica cuáles de los campos de la ListProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Campos | |
---|---|
nesting |
Es una máscara que indica cuáles de los campos del Los estados de sugerencia de nivel de anidación se muestran en orden ascendente del nivel de anidación, y el menos anidado se muestra primero. |
NestingLevelSuggestionState
Una máscara que indica cuáles de los campos de la NestingLevel
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
bullet |
Indica si hubo un cambio sugerido en |
glyph |
Indica si hubo un cambio sugerido en |
glyph |
Indica si hubo un cambio sugerido en |
glyph |
Indica si hubo un cambio sugerido en |
indent |
Indica si hubo un cambio sugerido en |
indent |
Indica si hubo un cambio sugerido en |
text |
Es una máscara que indica cuáles de los campos de |
start |
Indica si hubo un cambio sugerido en |
NamedRanges
Es una colección de todos los NamedRange
del documento que comparten un nombre determinado.
Representación JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
Es el nombre que comparten todos los |
named |
Los |
NamedRange
Es una colección de Range
con el mismo ID de rango con nombre.
Los rangos nombrados 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 adelante. Un documento puede contener varios rangos con el mismo nombre, pero cada uno tiene un ID único.
Un rango con nombre se crea con un solo Range
, y el contenido que se inserta dentro de un rango con nombre suele expandir ese rango. Sin embargo, ciertos cambios en el documento pueden hacer que el rango se divida en varios.
Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tengan acceso al documento pueden ver sus rangos con nombre.
Representación JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
named |
Es el ID del rango con nombre. |
name |
Es 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, "tabId": string } |
Campos | |
---|---|
segment |
Es 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. |
start |
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 admitir casos de uso futuros con rangos abiertos. |
end |
El índice de finalización de este rango, basado en cero, exclusivo, en unidades de código UTF-16. En todos los usos actuales, se debe proporcionar un índice final. Este campo es un Int32Value para admitir casos de uso futuros con rangos abiertos. |
tab |
La pestaña que contiene este rango. Si se omite, la solicitud se aplica a la primera pestaña. En un documento que contiene una sola pestaña:
En un documento que contiene varias pestañas:
|
InlineObject
Es un objeto que aparece intercalado con el texto. Un InlineObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
object |
Es el ID de este objeto intercalado. Se puede usar para actualizar las propiedades de un objeto. |
inline |
Las propiedades de este objeto intercalado. |
suggested |
Los cambios sugeridos en las propiedades de los objetos intercalados, ordenados por ID de sugerencia |
suggested |
Es el ID de inserción sugerido. Si está vacío, significa que no se trata de una inserción sugerida. |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de este contenido. |
InlineObjectProperties
Propiedades de un InlineObject
.
Representación JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embedded |
Es el objeto incorporado de este objeto intercalado. |
EmbeddedObject
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. |
embedded |
Es el borde del objeto incorporado. |
size |
Es el tamaño visible de la imagen después de recortarla. |
margin |
Es el margen superior del objeto incorporado. |
margin |
Es el margen inferior del objeto incorporado. |
margin |
Es el margen derecho del objeto incorporado. |
margin |
Es el margen izquierdo del objeto incorporado. |
linked |
Es una referencia al contenido de la fuente externa vinculada. Por ejemplo, contiene una referencia al gráfico de Hojas de cálculo de Google de origen cuando el objeto incorporado es un gráfico vinculado. Si no se establece, 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: |
|
embedded |
Son las propiedades de un dibujo incorporado. |
image |
Son las propiedades de una imagen. |
EmbeddedDrawingProperties
Este tipo no tiene campos.
Son las propiedades de un dibujo incorporado y se usan para diferenciar el tipo de objeto. Un dibujo incorporado es aquel que se crea y edita dentro de un documento. Ten en cuenta que no se admiten detalles extensos.
ImageProperties
Son las propiedades de una imagen.
Representación JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
content |
Un URI a la imagen con una vida útil predeterminada de 30 minutos. Este URI está etiquetado con la cuenta del solicitante. Cualquier persona que tenga el URI accede a la imagen de manera efectiva como el solicitante original. Es posible que se pierda el acceso a la imagen si cambia la configuración de uso compartido del documento. |
source |
El URI de origen es el que se usa para insertar la imagen. El URI de origen puede estar vacío. |
brightness |
Es el efecto de brillo de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa que no hay efecto. |
contrast |
El efecto de contraste de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa que no hay efecto. |
transparency |
Es el efecto de transparencia de la imagen. El valor debe estar en el intervalo [0.0, 1.0], donde 0 significa que no hay efecto y 1 significa transparente. |
crop |
Las propiedades de recorte de la imagen. |
angle |
Es el ángulo de rotación de la imagen en el sentido de las manecillas del reloj, expresado en radianes. |
CropProperties
Son las propiedades de recorte de una imagen.
El rectángulo de recorte se representa con compensaciones fraccionarias de los 4 bordes del contenido original.
- Si el desplazamiento está en el intervalo (0, 1), el borde correspondiente del rectángulo de recorte se coloca dentro del rectángulo de límite original de la imagen.
- Si el desplazamiento es negativo o superior a 1, el borde correspondiente del rectángulo de recorte se coloca fuera del rectángulo de límite original de la imagen.
- Si 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 | |
---|---|
offset |
El desplazamiento especifica qué tan lejos está el borde izquierdo del rectángulo de recorte del borde izquierdo del contenido original como una fracción del ancho del contenido original. |
offset |
El desplazamiento especifica qué tan hacia adentro está el borde derecho del rectángulo de recorte del borde derecho del contenido original como una fracción del ancho del contenido original. |
offset |
El desplazamiento especifica qué tan hacia adentro está el borde superior del rectángulo de recorte del borde superior del contenido original como una fracción de la altura del contenido original. |
offset |
El desplazamiento especifica qué tan lejos está el borde inferior del rectángulo de recorte del borde inferior del contenido original como una fracción de la altura del contenido original. |
angle |
Es el ángulo de rotación en el sentido de las manecillas del reloj del rectángulo de recorte alrededor de su centro, en radianes. La rotación se aplica después de los desplazamientos. |
EmbeddedObjectBorder
Un borde alrededor de un EmbeddedObject
.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
Es el color del borde. |
width |
Es el ancho del borde. |
dash |
Es el estilo de línea del borde. |
property |
Es el estado de la propiedad de borde. |
PropertyState
Son los estados posibles de una propiedad.
Enumeraciones | |
---|---|
RENDERED |
Si el estado de una propiedad es RENDERED, el elemento tiene la propiedad correspondiente cuando se renderiza en el documento. Este es el valor predeterminado. |
NOT_RENDERED |
Si el estado de una propiedad es NOT_RENDERED, el elemento no tiene la propiedad correspondiente cuando se renderiza en el documento. |
LinkedContentReference
Es una referencia al contenido de la fuente 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: |
|
sheets |
Es una referencia al gráfico vinculado. |
SheetsChartReference
Es una referencia a un gráfico vinculado incorporado desde Hojas de cálculo de Google.
Representación JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
Campos | |
---|---|
spreadsheet |
El ID de la hoja de cálculo de Hojas de cálculo de Google que contiene el gráfico de origen |
chart |
Es el ID del gráfico específico en la hoja de cálculo de Hojas de cálculo de Google que se incorpora. |
SuggestedInlineObjectProperties
Un cambio sugerido para InlineObjectProperties
.
Representación JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inline |
Un |
inline |
Una máscara que indica cuáles de los campos de la |
InlineObjectPropertiesSuggestionState
Una máscara que indica cuáles de los campos de la InlineObjectProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embedded |
Es una máscara que indica cuáles de los campos de |
EmbeddedObjectSuggestionState
Es una máscara que indica cuáles de los campos de la EmbeddedObject
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embedded |
Es una máscara que indica cuáles de los campos de |
image |
Es una máscara que indica cuáles de los campos de |
title |
Indica si hubo un cambio sugerido en |
description |
Indica si hubo un cambio sugerido en |
embedded |
Es una máscara que indica cuáles de los campos de |
size |
Es una máscara que indica cuáles de los campos de |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
margin |
Indica si hubo un cambio sugerido en |
linked |
Es una máscara que indica cuáles de los campos de |
EmbeddedDrawingPropertiesSuggestionState
Este tipo no tiene campos.
Es una máscara que indica cuáles de los campos de la EmbeddedDrawingProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
ImagePropertiesSuggestionState
Una máscara que indica cuáles de los campos de la ImageProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
content |
Indica si hubo un cambio sugerido en |
source |
Indica si hubo un cambio sugerido en [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightness |
Indica si hubo un cambio sugerido en [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrast |
Indica si hubo un cambio sugerido en [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparency |
Indica si hubo un cambio sugerido en [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
crop |
Es una máscara que indica cuáles de los campos de |
angle |
Indica si hubo un cambio sugerido en [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
Una máscara que indica cuáles de los campos de la CropProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offset |
Indica si hubo un cambio sugerido en |
offset |
Indica si hubo un cambio sugerido en |
offset |
Indica si hubo un cambio sugerido en |
offset |
Indica si hubo un cambio sugerido en |
angle |
Indica si hubo un cambio sugerido en |
EmbeddedObjectBorderSuggestionState
Una máscara que indica cuáles de los campos de la EmbeddedObjectBorder
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Campos | |
---|---|
color |
Indica si hubo un cambio sugerido en [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
width |
Indica si hubo un cambio sugerido en [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dash |
Indica si hubo un cambio sugerido en [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
property |
Indica si hubo un cambio sugerido en [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Una máscara que indica cuáles de los campos de la LinkedContentReference
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheets |
Es una máscara que indica cuáles de los campos de |
SheetsChartReferenceSuggestionState
Una máscara que indica cuáles de los campos de la SheetsChartReference
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheet |
Indica si hubo un cambio sugerido en |
chart |
Indica si hubo un cambio sugerido en |
PositionedObject
Es un objeto que está conectado a un Paragraph
y se posiciona en relación con el comienzo del párrafo. Un objeto PositionedObject contiene un EmbeddedObject
, como una imagen.
Representación JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
object |
Es el ID de este objeto posicionado. |
positioned |
Las propiedades de este objeto posicionado. |
suggested |
Los cambios sugeridos en las propiedades de los objetos posicionados, ordenados por ID de sugerencia |
suggested |
El ID de inserción sugerido. Si está vacío, significa que no se trata de una inserción sugerida. |
suggested |
Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación 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 línea nueva de la |
embedded |
Es el objeto incorporado de este objeto posicionado. |
PositionedObjectPositioning
Es el posicionamiento de un PositionedObject
. El objeto posicionado se ubica en relación con el principio del Paragraph
al que está conectado.
Representación JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
Es el diseño de este objeto posicionado. |
left |
Es el desplazamiento del borde izquierdo del objeto posicionado en relación con el comienzo del |
top |
Es la compensación del borde superior del objeto posicionado en relación con el comienzo del |
PositionedObjectLayout
Los diseños posibles de un [PositionedObject][google.aps.docs.v1.PositionedObject].
Enumeraciones | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
El diseño no se especifica. |
WRAP_TEXT |
El texto se une al objeto posicionado. |
BREAK_LEFT |
Divide el texto de modo que el objeto posicionado esté a la izquierda y el texto a la derecha. |
BREAK_RIGHT |
Divide el texto de modo que el objeto posicionado esté a la derecha y el texto a la izquierda. |
BREAK_LEFT_RIGHT |
Corta el texto de modo que no haya texto a la izquierda ni a la derecha del objeto posicionado. |
IN_FRONT_OF_TEXT |
El objeto posicionado está delante del texto. |
BEHIND_TEXT |
El objeto posicionado está detrás del texto. |
SuggestedPositionedObjectProperties
Un cambio sugerido para PositionedObjectProperties
.
Representación JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positioned |
Un |
positioned |
Una máscara que indica cuáles de los campos de la |
PositionedObjectPropertiesSuggestionState
Una máscara que indica cuáles de los campos de la PositionedObjectProperties
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioning |
Es una máscara que indica cuáles de los campos de |
embedded |
Es una máscara que indica cuáles de los campos de |
PositionedObjectPositioningSuggestionState
Una máscara que indica cuáles de los campos de la PositionedObjectPositioning
base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.
Representación JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Campos | |
---|---|
layout |
Indica si hubo un cambio sugerido en |
left |
Indica si hubo un cambio sugerido en |
top |
Indica si hubo un cambio sugerido en |
SuggestionsViewMode
Es el modo de vista de sugerencias aplicado al documento que indica cómo se representan los cambios sugeridos. Proporciona opciones para leer el documento con todas las sugerencias intercaladas, aceptadas o rechazadas.
Enumeraciones | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
El SuggestionsViewMode aplicado al documento que se muestra depende del nivel de acceso actual del usuario. Si el usuario solo tiene acceso de lectura, se aplica PREVIEW_WITHOUT_SUGGESTIONS . De lo contrario, se aplica SUGGESTIONS_INLINE . Este es el modo de vista de sugerencias predeterminado. |
SUGGESTIONS_INLINE |
El documento que se muestra tiene sugerencias intercaladas. Los cambios sugeridos se diferenciarán del contenido base 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 alguno. |
Métodos |
|
---|---|
|
Aplica una o más actualizaciones al documento. |
|
Crea un documento en blanco con el título que se proporcionó en la solicitud. |
|
Obtiene la versión más reciente del documento especificado. |