REST Resource: documents

Recurso: Document

Un documento de Documentos de Google

Representación JSON
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Campos
documentId

string

Solo salida. Es el ID del documento.

title

string

Es el título del documento.

tabs[]

object (Tab)

Son las pestañas que forman parte de un documento.

Las pestañas pueden contener pestañas secundarias, es decir, una pestaña anidada dentro de otra. Las pestañas secundarias se representan con el campo Tab.childTabs.

revisionId

string

Solo salida. Es el ID de revisión del documento. Se puede usar en solicitudes de actualización para especificar qué revisión de un documento se debe actualizar y cómo se debe comportar la solicitud si el documento se editó desde esa revisión. Solo se propaga si el usuario tiene acceso de edición al documento.

El ID de revisión no es un número secuencial, sino una cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Se garantiza que un ID de revisión devuelto solo es válido durante 24 horas después de que se devolvió y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre las llamadas, significa que el documento no se modificó. Por el contrario, un ID cambiado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un cambio de ID también puede deberse a factores internos, como cambios en el formato del ID.

suggestionsViewMode

enum (SuggestionsViewMode)

Solo salida. Es el modo de vista de sugerencias que se aplica al documento.

Nota: Cuando edites un documento, los cambios deben basarse en un documento con SUGGESTIONS_INLINE.

body

object (Body)

Solo salida. Es el cuerpo principal del documento.

Campo heredado: En su lugar, usa Document.tabs.documentTab.body, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

headers

map (key: string, value: object (Header))

Solo salida. Encabezados del documento, con el ID del encabezado como clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.headers, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

footers

map (key: string, value: object (Footer))

Solo salida. Son los pies de página del documento, con clave según el ID del pie de página.

Campo heredado: En su lugar, usa Document.tabs.documentTab.footers, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

footnotes

map (key: string, value: object (Footnote))

Solo salida. Son las notas al pie del documento, organizadas por ID.

Campo heredado: En su lugar, usa Document.tabs.documentTab.footnotes, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

documentStyle

object (DocumentStyle)

Solo salida. Es el estilo del documento.

Campo heredado: En su lugar, usa Document.tabs.documentTab.documentStyle, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Solo salida. Son los cambios sugeridos en el estilo del documento, con la clave del ID de sugerencia.

Campo heredado: En su lugar, usa Document.tabs.documentTab.suggestedDocumentStyleChanges, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

namedStyles

object (NamedStyles)

Solo salida. Son los estilos con nombre del documento.

Campo heredado: En su lugar, usa Document.tabs.documentTab.namedStyles, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Solo salida. Son los cambios sugeridos en los estilos con nombre del documento, organizados por ID de sugerencia.

Campo heredado: En su lugar, usa Document.tabs.documentTab.suggestedNamedStylesChanges, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

lists

map (key: string, value: object (List))

Solo salida. Son las listas del documento, con el ID de la lista como clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.lists, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

namedRanges

map (key: string, value: object (NamedRanges))

Solo salida. Son los rangos con nombre del documento, con el nombre como clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.namedRanges, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

inlineObjects

map (key: string, value: object (InlineObject))

Solo salida. Son los objetos intercalados en el documento, con el ID del objeto como clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.inlineObjects, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

positionedObjects

map (key: string, value: object (PositionedObject))

Solo salida. Objetos posicionados en el documento, con el ID del objeto como clave.

Campo heredado: En su lugar, usa Document.tabs.documentTab.positionedObjects, que expone el contenido real del documento de todas las pestañas cuando el parámetro includeTabsContent se establece en true. Si es false o no está configurado, este campo contiene información sobre la primera pestaña del documento.

Pestaña

Es una pestaña en un documento.

Representación JSON
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
Campos
tabProperties

object (TabProperties)

Son las propiedades de la pestaña, como el ID y el título.

childTabs[]

object (Tab)

Son las pestañas secundarias anidadas dentro de esta pestaña.

Campo de unión content. Es el contenido de la pestaña. Las direcciones (content) solo pueden ser una de las siguientes opciones:
documentTab

object (DocumentTab)

Una pestaña con el contenido del documento, como texto e imágenes

TabProperties

Son las propiedades de una pestaña.

Representación JSON
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
Campos
tabId

string

Solo salida. Es el ID de la pestaña. No se puede cambiar este campo.

title

string

Es el nombre visible para el usuario de la pestaña.

parentTabId

string

Opcional. Es el ID de la pestaña principal. Está vacío cuando la pestaña actual es de nivel raíz, lo que significa que no tiene elementos superiores.

index

integer

Índice basado en cero de la pestaña dentro del elemento principal.

nestingLevel

integer

Solo salida. Profundidad de la pestaña dentro del documento. Las pestañas de nivel raíz comienzan en 0.

DocumentTab

Es una pestaña con el contenido del documento.

Representación JSON
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Campos
body

object (Body)

Es el cuerpo principal de la pestaña del documento.

headers

map (key: string, value: object (Header))

Encabezados en la pestaña del documento, con la clave del ID del encabezado.

footers

map (key: string, value: object (Footer))

Son los pies de página de la pestaña del documento, con la clave del ID del pie de página.

footnotes

map (key: string, value: object (Footnote))

Son las notas al pie de la pestaña del documento, con la clave del ID de la nota al pie.

documentStyle

object (DocumentStyle)

Es el estilo de la pestaña del documento.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Son los cambios sugeridos en el estilo de la pestaña del documento, con la clave del ID de sugerencia.

namedStyles

object (NamedStyles)

Son los estilos con nombre de la pestaña del documento.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Son los cambios sugeridos en los estilos con nombre de la pestaña del documento, con la clave del ID de sugerencia.

lists

map (key: string, value: object (List))

Son las listas de la pestaña del documento, con el ID de la lista como clave.

namedRanges

map (key: string, value: object (NamedRanges))

Son los rangos con nombre en la pestaña del documento, organizados por nombre.

inlineObjects

map (key: string, value: object (InlineObject))

Son los objetos intercalados en la pestaña del documento, con el ID del objeto como clave.

positionedObjects

map (key: string, value: object (PositionedObject))

Son los objetos posicionados en la pestaña del documento, con el ID del objeto como clave.

Cuerpo

Es el cuerpo del documento.

Por lo general, el cuerpo contiene el contenido completo del documento, excepto headers, footers y footnotes.

Representación JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Campos
content[]

object (StructuralElement)

Es el contenido del cuerpo.

Los índices del contenido del cuerpo comienzan en cero.

StructuralElement

Un StructuralElement describe el contenido que proporciona estructura al documento.

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
Campos
startIndex

integer

Índice de inicio basado en cero de este elemento estructural, en unidades de código UTF-16.

endIndex

integer

Índice final basado en cero de este elemento estructural, exclusivo, en unidades de código UTF-16.

Campo de unión content. Es el contenido del elemento estructural. Las direcciones (content) solo pueden ser una de las siguientes opciones:
paragraph

object (Paragraph)

Es un tipo de párrafo de elemento estructural.

sectionBreak

object (SectionBreak)

Es un tipo de salto de sección de elemento estructural.

table

object (Table)

Es un tipo de tabla de elemento estructural.

tableOfContents

object (TableOfContents)

Es un tipo de elemento estructural de índice.

Párrafo

Es un objeto StructuralElement que representa un párrafo. Un párrafo es un rango de contenido que termina con un carácter de salto de línea.

Representación JSON
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
Campos
elements[]

object (ParagraphElement)

Es el contenido del párrafo, desglosado en sus partes componentes.

paragraphStyle

object (ParagraphStyle)

Es el estilo de este párrafo.

suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

Es el estilo de párrafo sugerido que se aplica a este párrafo, con la clave del ID de sugerencia.

bullet

object (Bullet)

Viñeta de este párrafo. Si no está presente, el párrafo no pertenece a una lista.

suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

Son los cambios sugeridos en la viñeta de este párrafo.

positionedObjectIds[]

string

Son los IDs de los objetos posicionados que están vinculados a este párrafo.

suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

Son los IDs de los objetos posicionados que se sugieren para adjuntarse a este párrafo, con el ID de sugerencia como clave.

ParagraphElement

Un ParagraphElement describe el contenido dentro de un Paragraph.

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
Campos
startIndex

integer

Es el índice de inicio basado en cero de este elemento de párrafo, en unidades de código UTF-16.

endIndex

integer

Índice final basado en cero de este elemento de párrafo, exclusivo, en unidades de código UTF-16.

Campo de unión content. Es el contenido del elemento de párrafo. Las direcciones (content) solo pueden ser una de las siguientes opciones:
textRun

object (TextRun)

Es un elemento de párrafo de ejecución de texto.

autoText

object (AutoText)

Es un elemento de párrafo de texto automático.

pageBreak

object (PageBreak)

Es un elemento de párrafo de salto de página.

columnBreak

object (ColumnBreak)

Es un elemento de párrafo de salto de columna.

footnoteReference

object (FootnoteReference)

Es un elemento de párrafo de referencia de nota al pie.

horizontalRule

object (HorizontalRule)

Es un elemento de párrafo de regla horizontal.

equation

object (Equation)

Es un elemento de párrafo de ecuación.

inlineObjectElement

object (InlineObjectElement)

Es un elemento de párrafo de objeto intercalado.

person

object (Person)

Es un elemento de párrafo que vincula a una persona o dirección de correo electrónico.

TextRun

Un ParagraphElement que representa una ejecución de texto que tiene el mismo diseño.

Representación JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
content

string

Es el texto de esta ejecución.

Los elementos que no son de texto en la ejecución se reemplazan por el carácter Unicode U+E907.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un TextRun puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de esta ejecución.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Es el estilo de texto sugerido que cambia en esta ejecución, con la clave del ID de sugerencia.

TextStyle

Representa el diseño que se puede aplicar al texto.

Los estilos de texto heredados se representan como campos no establecidos en este mensaje. El elemento superior de un estilo de texto depende de dónde se defina el estilo de texto:

  • El TextStyle del texto en un Paragraph hereda el named style type correspondiente del párrafo.
  • El TextStyle en un named style hereda del estilo con nombre normal text.
  • El TextStyle del estilo con nombre normal text hereda del estilo de texto predeterminado en el editor de Documentos.
  • El TextStyle en un elemento Paragraph que se encuentra en una tabla puede heredar su estilo de texto del estilo de la tabla.

Si el estilo de texto no hereda de un elemento superior, anular la configuración de los campos restablecerá el estilo a un valor que coincida con los valores predeterminados en el editor de Documentos.

Representación JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
Campos
bold

boolean

Indica si el texto se renderiza en negrita o no.

italic

boolean

Indica si el texto está en cursiva o no.

underline

boolean

Indica si el texto está subrayado o no.

strikethrough

boolean

Indica si el texto está tachado o no.

smallCaps

boolean

Indica si el texto está en letras pequeñas capitalizadas.

backgroundColor

object (OptionalColor)

Es el color de fondo del texto. Si se configura, el color es RGB o transparente, según el campo color.

foregroundColor

object (OptionalColor)

Es el color de primer plano del texto. Si se configura, el color es RGB o transparente, según el campo color.

fontSize

object (Dimension)

Tamaño de la fuente del texto

weightedFontFamily

object (WeightedFontFamily)

Familia de fuentes y grosor renderizado del texto.

Si una solicitud de actualización especifica valores para weightedFontFamily y bold, primero se aplica weightedFontFamily y, luego, bold.

Si no se establece weightedFontFamily#weight, el valor predeterminado es 400.

Si se establece weightedFontFamily, también se debe establecer weightedFontFamily#fontFamily con un valor no vacío. De lo contrario, se muestra un error 400 de solicitud incorrecta.

baselineOffset

enum (BaselineOffset)

Es el desplazamiento vertical del texto desde su posición normal.

El texto con desplazamientos de la línea de base SUPERSCRIPT o SUBSCRIPT se renderiza automáticamente con un tamaño de fuente más pequeño, que se calcula según el campo fontSize. Los cambios en este campo no afectan el fontSize.

OptionalColor

Es un color que puede ser completamente opaco o completamente transparente.

Representación JSON
{
  "color": {
    object (Color)
  }
}
Campos
color

object (Color)

Si se configura, se usará como un color opaco. Si no se configura, representa un color transparente.

Color

Un color sólido.

Representación JSON
{
  "rgbColor": {
    object (RgbColor)
  }
}
Campos
rgbColor

object (RgbColor)

Es el valor de color RGB.

RgbColor

Es un color RGB.

Representación JSON
{
  "red": number,
  "green": number,
  "blue": number
}
Campos
red

number

Es el componente rojo del color, de 0.0 a 1.0.

green

number

Componente verde del color, de 0.0 a 1.0.

blue

number

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 (Unit)
}
Campos
magnitude

number

Es la magnitud.

unit

enum (Unit)

Unidades de magnitud.

Unidad

Unidades de medida.

Enums
UNIT_UNSPECIFIED Se desconocen las unidades.
PT Un punto, 1/72 de pulgada.

WeightedFontFamily

Representa una familia y un peso de fuente de texto.

Representación JSON
{
  "fontFamily": string,
  "weight": integer
}
Campos
fontFamily

string

Es la familia de fuentes del texto.

La familia de fuentes puede ser cualquiera del menú Fuente en Documentos o de Google Fonts. Si no se reconoce el nombre de la fuente, el texto se renderiza en Arial.

weight

integer

El grosor de la fuente. Este campo puede tener cualquier valor que sea un múltiplo de 100 entre 100 y 900, inclusive. Este rango corresponde a los valores numéricos que se describen en la especificación de CSS 2.1, sección 15.6, y no se permiten valores no numéricos.

El valor predeterminado es 400 (“normal”).

El grosor de la fuente constituye solo un componente del grosor de la fuente renderizada. Una combinación del valor weight y el valor bold resuelto del estilo de texto determina el peso renderizado, después de tener en cuenta la herencia:

  • Si el texto está en negrita y el peso es inferior a 400, el peso renderizado es 400.
  • Si el texto está en negrita y el peso es mayor o igual que 400, pero menor que 700, el peso renderizado es 700.
  • Si el peso es mayor o igual que 700, el peso renderizado es igual al peso.
  • Si el texto no está en negrita, el peso renderizado es igual al peso.

BaselineOffset

Son las formas en que el texto se puede desplazar verticalmente desde su posición normal.

Enums
BASELINE_OFFSET_UNSPECIFIED El desplazamiento de la línea base del texto se hereda del elemento principal.
NONE El texto no tiene un desplazamiento vertical.
SUPERSCRIPT El texto se desplaza verticalmente hacia arriba (superíndice).
SUBSCRIPT El texto se desplaza verticalmente hacia abajo (subíndice).

SuggestedTextStyle

Es un cambio sugerido en un TextStyle.

Representación JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Campos
textStyle

object (TextStyle)

Es un objeto TextStyle que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con textStyleSuggestionState para ver qué campos cambiaron y sus valores nuevos.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuáles de los campos del TextStyle base se modificaron en esta sugerencia.

TextStyleSuggestionState

Es una máscara que indica cuáles de los campos del TextStyle base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
Campos
boldSuggested

boolean

Indica si hubo un cambio sugerido en bold.

italicSuggested

boolean

Indica si hubo un cambio sugerido en italic.

underlineSuggested

boolean

Indica si hubo un cambio sugerido en underline.

strikethroughSuggested

boolean

Indica si hubo un cambio sugerido en strikethrough.

smallCapsSuggested

boolean

Indica si hubo un cambio sugerido en smallCaps.

backgroundColorSuggested

boolean

Indica si hubo un cambio sugerido en backgroundColor.

foregroundColorSuggested

boolean

Indica si hubo un cambio sugerido en foregroundColor.

fontSizeSuggested

boolean

Indica si hubo un cambio sugerido en fontSize.

weightedFontFamilySuggested

boolean

Indica si hubo un cambio sugerido en weightedFontFamily.

baselineOffsetSuggested

boolean

Indica si hubo un cambio sugerido en baselineOffset.

AutoText

Un ParagraphElement que representa un punto en el texto que se reemplaza de forma dinámica por contenido que puede cambiar con el tiempo, como un número de página.

Representación JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
type

enum (Type)

Es el tipo de texto automático.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un AutoText puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de este AutoText.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Es el estilo de texto sugerido que cambia a este AutoText, con la clave del ID de sugerencia.

Tipo

Son los tipos de texto automático.

Enums
TYPE_UNSPECIFIED Es un tipo de texto automático sin especificar.
PAGE_NUMBER Es el tipo de texto automático que representa el número de página actual.
PAGE_COUNT Es el tipo de texto automático que representa la cantidad total de páginas del documento.

PageBreak

Un ParagraphElement que representa un salto de página. Un salto de página hace que el texto siguiente comience en la parte superior de la página siguiente.

Representación JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un PageBreak puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de este PageBreak.

Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de página puede afectar el diseño del contenido, así como el estilo del texto insertado junto a él.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Es el estilo de texto sugerido que cambia a este PageBreak, con la clave del ID de sugerencia.

ColumnBreak

Es un objeto ParagraphElement que representa un salto de columna. Un salto de columna hace que el texto siguiente comience en la parte superior de la columna siguiente.

Representación JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un ColumnBreak puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de este ColumnBreak.

Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de columna puede afectar el diseño del contenido, así como el diseño del texto insertado junto a él.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

El estilo de texto sugerido cambia a este ColumnBreak, con la clave del ID de sugerencia.

FootnoteReference

Un objeto ParagraphElement que representa una referencia de nota al pie. Una referencia de nota al pie es el contenido intercalado que se renderiza con un número y se usa para identificar la nota al pie.

Representación JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
footnoteId

string

ID del objeto footnote que contiene el contenido de esta referencia de nota al pie.

footnoteNumber

string

Es el número renderizado de esta nota al pie.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un FootnoteReference puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de este FootnoteReference.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Es el estilo de texto sugerido que cambia a esta FootnoteReference, con la clave del ID de sugerencia.

HorizontalRule

Un ParagraphElement que representa una línea horizontal.

Representación JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un HorizontalRule puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de este HorizontalRule.

Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de una regla horizontal puede afectar el diseño del contenido, así como el diseño del texto insertado junto a ella.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Es el estilo de texto sugerido que cambia a este HorizontalRule, con la clave del ID de sugerencia.

Ecuación

Es un objeto ParagraphElement que representa una ecuación.

Representación JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Campos
suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un Equation puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

InlineObjectElement

Un ParagraphElement que contiene un InlineObject.

Representación JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
inlineObjectId

string

Es el ID del InlineObject que contiene este elemento.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un InlineObjectElement puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

textStyle

object (TextStyle)

Es el estilo de texto de este InlineObjectElement.

Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un elemento de objeto intercalado puede afectar el diseño del contenido, así como el diseño del texto insertado junto a él.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

El estilo de texto sugerido cambia a este InlineObject, con la clave del ID de sugerencia.

Persona

Es una persona o una dirección de correo electrónico mencionada en un documento. Estas menciones se comportan como un solo elemento inmutable que contiene el nombre o la dirección de correo electrónico de la persona.

Representación JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
Campos
personId

string

Solo salida. Es el ID único de este vínculo.

suggestedInsertionIds[]

string

Son los IDs de las sugerencias que insertan este vínculo de persona en el documento. Un Person puede tener varios IDs de inserción si se trata de un cambio sugerido anidado (por ejemplo, una sugerencia dentro de una sugerencia hecha por otro usuario). Si está vacío, este vínculo de persona no es una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de las sugerencias que quitan la vinculación de esta persona del documento. Un Person puede tener varios IDs de eliminación si, por ejemplo, varios usuarios sugieren que se borre. Si está vacío, no se sugiere la eliminación de este vínculo de persona.

textStyle

object (TextStyle)

Es el estilo de texto de este Person.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

El estilo de texto sugerido cambia a este Person, que se indexa por ID de sugerencia.

personProperties

object (PersonProperties)

Solo salida. Son las propiedades de este Person. Este campo siempre está presente.

PersonProperties

Son las propiedades específicas de un objeto Person vinculado.

Representación JSON
{
  "name": string,
  "email": string
}
Campos
name

string

Es el nombre de la persona si se muestra en el texto del vínculo en lugar de la dirección de correo electrónico.

email

string

Es la dirección de correo electrónico vinculada a este Person. Este campo siempre está presente.

RichLinkProperties

Son las propiedades específicas de un RichLink.

Representación JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
Campos
title

string

Solo salida. Es el título del RichLink tal como se muestra en el vínculo. Este título coincide con el del recurso vinculado en el momento de la inserción o la última actualización del vínculo. Este campo siempre está presente.

uri

string

Solo salida. Es el URI del RichLink. Siempre está presente.

mimeType

string

Solo salida. Tipo de MIME del RichLink, si hay uno (por ejemplo, cuando es un archivo en Drive).

ParagraphStyle

Son los estilos que se aplican a un párrafo completo.

Los estilos de párrafo heredados se representan como campos no establecidos en este mensaje. El elemento superior de un estilo de párrafo depende de dónde se defina el estilo de párrafo:

  • El objeto ParagraphStyle de un objeto Paragraph hereda del objeto named style type correspondiente del párrafo.
  • El objeto ParagraphStyle en un named style hereda del estilo con nombre normal text.
  • El objeto ParagraphStyle del estilo con nombre normal text hereda del estilo de párrafo predeterminado en el editor de Documentos.
  • El objeto ParagraphStyle de un elemento Paragraph que se incluye en una tabla puede heredar su estilo de párrafo del estilo de la tabla.

Si el estilo de párrafo no hereda de un elemento superior, al anular la configuración de los campos, el estilo volverá a un valor que coincida con los valores predeterminados del editor de Documentos.

Representación JSON
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
Campos
headingId

string

Es el ID del encabezado del párrafo. Si está vacío, este párrafo no es un encabezado.

Esta propiedad es de solo lectura.

namedStyleType

enum (NamedStyleType)

Es el tipo de estilo con nombre del párrafo.

Dado que la actualización del tipo de estilo con nombre afecta a otras propiedades dentro de ParagraphStyle, el tipo de estilo con nombre se aplica antes de que se actualicen las demás propiedades.

alignment

enum (Alignment)

Es la alineación del texto de este párrafo.

lineSpacing

number

Es la cantidad de espacio entre las líneas, expresada como un porcentaje de lo normal, donde lo normal se representa como 100.0. Si no se configura, el valor se hereda del elemento superior.

direction

enum (ContentDirection)

Es la dirección del texto de este párrafo. Si no se configura, el valor predeterminado es LEFT_TO_RIGHT, ya que la dirección del párrafo no se hereda.

spacingMode

enum (SpacingMode)

Es el modo de espaciado del párrafo.

spaceAbove

object (Dimension)

Cantidad de espacio adicional sobre el párrafo. Si no se configura, el valor se hereda del elemento superior.

spaceBelow

object (Dimension)

Cantidad de espacio adicional debajo del párrafo. Si no se configura, el valor se hereda del elemento superior.

borderBetween

object (ParagraphBorder)

Borde entre este párrafo y los párrafos anterior y siguiente. Si no se configura, el valor se hereda del elemento superior.

El borde intermedio se renderiza cuando el párrafo adyacente tiene las mismas propiedades de borde y sangría.

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad.

borderTop

object (ParagraphBorder)

Es el borde en la parte superior de este párrafo. Si no se configura, el valor se hereda del elemento superior.

El borde superior se renderiza cuando el párrafo anterior tiene diferentes propiedades de borde y sangría.

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad.

borderBottom

object (ParagraphBorder)

El borde en la parte inferior de este párrafo. Si no se configura, el valor se hereda del elemento superior.

El borde inferior se renderiza cuando el párrafo siguiente tiene diferentes propiedades de borde y sangría.

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad.

borderLeft

object (ParagraphBorder)

Es el borde a la izquierda de este párrafo. Si no se configura, el valor se hereda del elemento superior.

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad.

borderRight

object (ParagraphBorder)

Es el borde a la derecha de este párrafo. Si no se configura, el valor se hereda del elemento superior.

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando cambias el borde de un párrafo, el borde nuevo debe especificarse en su totalidad.

indentFirstLine

object (Dimension)

Es la cantidad de sangría de la primera línea del párrafo. Si no se configura, el valor se hereda del elemento superior.

indentStart

object (Dimension)

Es la cantidad de sangría del párrafo en el lado que corresponde al inicio del texto, según la dirección actual del párrafo. Si no se configura, el valor se hereda del elemento superior.

indentEnd

object (Dimension)

Es la cantidad de sangría del párrafo en el lado que corresponde al final del texto, según la dirección actual del párrafo. Si no se configura, el valor se hereda del elemento superior.

tabStops[]

object (TabStop)

Es una lista de las tabulaciones de este párrafo. La lista de tabulaciones no se hereda.

Esta propiedad es de solo lectura.

keepLinesTogether

boolean

Indica si todas las líneas del párrafo deben diseñarse en la misma página o columna, si es posible. Si no se configura, el valor se hereda del elemento superior.

keepWithNext

boolean

Indica si, de ser posible, al menos una parte de este párrafo debe diseñarse en la misma página o columna que el siguiente. Si no se configura, el valor se hereda del elemento superior.

avoidWidowAndOrphan

boolean

Indica si se deben evitar las viudas y los huérfanos en el párrafo. Si no se configura, el valor se hereda del elemento superior.

shading

object (Shading)

Es el sombreado del párrafo. Si no se configura, el valor se hereda del elemento superior.

pageBreakBefore

boolean

Indica si el párrafo actual siempre debe comenzar al principio de una página. Si no se configura, el valor se hereda del elemento superior.

Si intentas actualizar pageBreakBefore para los párrafos en regiones no admitidas, como Table, Header, Footer y Footnote, es posible que se genere un estado de documento no válido que muestre un error de solicitud incorrecta 400.

NamedStyleType

Son los tipos de estilos con nombre.

Enums
NAMED_STYLE_TYPE_UNSPECIFIED No se especifica el tipo de estilo con nombre.
NORMAL_TEXT Texto normal.
TITLE Título.
SUBTITLE Subtítulo.
HEADING_1 Encabezado 1.
HEADING_2 Título 2.
HEADING_3 Título 3.
HEADING_4 Título 4.
HEADING_5 Encabezado 5.
HEADING_6 Título 6.

Alineación

Son los tipos de alineación de texto para un párrafo.

Enums
ALIGNMENT_UNSPECIFIED La alineación del párrafo se hereda del elemento superior.
START El párrafo está alineado con el inicio de la línea. Alineado a la izquierda para texto LTR y a la derecha en otros casos.
CENTER El párrafo está centrado.
END El párrafo está alineado con el final de la línea. Alineado a la derecha para el texto LTR y alineado a la izquierda en otros casos.
JUSTIFIED El párrafo está justificado.

ContentDirection

El contenido de las instrucciones sobre cómo llegar puede fluir.

Enums
CONTENT_DIRECTION_UNSPECIFIED No se especificó la dirección del contenido.
LEFT_TO_RIGHT El contenido va de izquierda a derecha.
RIGHT_TO_LEFT El contenido va de derecha a izquierda.

SpacingMode

Son los diferentes modos de espaciado entre párrafos.

Enums
SPACING_MODE_UNSPECIFIED El modo de espaciado se hereda del elemento principal.
NEVER_COLLAPSE El espaciado de párrafo siempre se renderiza.
COLLAPSE_LISTS Se omite el espaciado entre párrafos entre los elementos de la lista.

ParagraphBorder

Es un borde alrededor de un párrafo.

Representación JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Campos
color

object (OptionalColor)

Es el color del borde.

width

object (Dimension)

Es el ancho del borde.

padding

object (Dimension)

Padding del borde.

dashStyle

enum (DashStyle)

Es el estilo de guiones del borde.

DashStyle

Tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el tipo simple "ST_PresetLineDashVal" que se describe en la sección 20.1.10.49 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de ECMA-376, 5ª edición.

Enums
DASH_STYLE_UNSPECIFIED Es un estilo de guion sin especificar.
SOLID Línea continua. Corresponde al valor "solid" de ST_PresetLineDashVal de ECMA-376. Este es el estilo de guion predeterminado.
DOT Línea punteada. Corresponde al valor "dot" de ECMA-376 ST_PresetLineDashVal.
DASH Línea punteada. Corresponde al valor "dash" de ECMA-376 ST_PresetLineDashVal.

TabStop

Es una parada de tabulación dentro de un párrafo.

Representación JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
Campos
offset

object (Dimension)

Es el desplazamiento entre esta parada de tabulación y el margen inicial.

alignment

enum (TabStopAlignment)

Es la alineación de esta parada de tabulación. Si no se establece, el valor predeterminado es START.

TabStopAlignment

Es la alineación de la parada de tabulación.

Enums
TAB_STOP_ALIGNMENT_UNSPECIFIED La alineación de la parada de tabulación no está especificada.
START La parada de tabulación se alinea con el inicio de la línea. Esta es la opción predeterminada.
CENTER El tabulador está alineado con el centro de la línea.
END La parada de tabulación está alineada con el final de la línea.

Sombreado

Es el sombreado de un párrafo.

Representación JSON
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
Campos
backgroundColor

object (OptionalColor)

Es el color de fondo del sombreado de este párrafo.

SuggestedParagraphStyle

Es un cambio sugerido en un ParagraphStyle.

Representación JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Campos
paragraphStyle

object (ParagraphStyle)

Es un objeto ParagraphStyle que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con paragraphStyleSuggestionState para ver qué campos cambiaron y sus valores nuevos.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Es una máscara que indica cuáles de los campos del ParagraphStyle base se modificaron en esta sugerencia.

ParagraphStyleSuggestionState

Es una máscara que indica cuáles de los campos del ParagraphStyle base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Campos
headingIdSuggested

boolean

Indica si hubo un cambio sugerido en headingId.

namedStyleTypeSuggested

boolean

Indica si hubo un cambio sugerido en namedStyleType.

alignmentSuggested

boolean

Indica si hubo un cambio sugerido en alignment.

lineSpacingSuggested

boolean

Indica si hubo un cambio sugerido en lineSpacing.

directionSuggested

boolean

Indica si hubo un cambio sugerido en direction.

spacingModeSuggested

boolean

Indica si hubo un cambio sugerido en spacingMode.

spaceAboveSuggested

boolean

Indica si hubo un cambio sugerido en spaceAbove.

spaceBelowSuggested

boolean

Indica si hubo un cambio sugerido en spaceBelow.

borderBetweenSuggested

boolean

Indica si hubo un cambio sugerido en borderBetween.

borderTopSuggested

boolean

Indica si hubo un cambio sugerido en borderTop.

borderBottomSuggested

boolean

Indica si hubo un cambio sugerido en borderBottom.

borderLeftSuggested

boolean

Indica si hubo un cambio sugerido en borderLeft.

borderRightSuggested

boolean

Indica si hubo un cambio sugerido en borderRight.

indentFirstLineSuggested

boolean

Indica si hubo un cambio sugerido en indentFirstLine.

indentStartSuggested

boolean

Indica si hubo un cambio sugerido en indentStart.

indentEndSuggested

boolean

Indica si hubo un cambio sugerido en indentEnd.

keepLinesTogetherSuggested

boolean

Indica si hubo un cambio sugerido en keepLinesTogether.

keepWithNextSuggested

boolean

Indica si hubo un cambio sugerido en keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indica si hubo un cambio sugerido en avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Es una máscara que indica cuáles de los campos de shading se modificaron en esta sugerencia.

pageBreakBeforeSuggested

boolean

Indica si hubo un cambio sugerido en pageBreakBefore.

ShadingSuggestionState

Es una máscara que indica cuáles de los campos del objeto Shading base se modificaron en este cambio sugerido. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "backgroundColorSuggested": boolean
}
Campos
backgroundColorSuggested

boolean

Indica si hubo un cambio sugerido en Shading.

Viñeta

Describe la viñeta de un párrafo.

Representación JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
Campos
listId

string

ID de la lista a la que pertenece este párrafo.

nestingLevel

integer

Es el nivel de anidación de este párrafo en la lista.

textStyle

object (TextStyle)

Es el estilo de texto específico del párrafo que se aplica a esta viñeta.

SuggestedBullet

Es un cambio sugerido en un Bullet.

Representación JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Campos
bullet

object (Bullet)

Es un objeto Bullet que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con bulletSuggestionState para ver qué campos cambiaron y sus valores nuevos.

bulletSuggestionState

object (BulletSuggestionState)

Es una máscara que indica cuáles de los campos del Bullet base se modificaron en esta sugerencia.

BulletSuggestionState

Es una máscara que indica cuáles de los campos del Bullet base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Campos
listIdSuggested

boolean

Indica si hubo un cambio sugerido en listId.

nestingLevelSuggested

boolean

Indica si hubo un cambio sugerido en nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuáles de los campos de text style se modificaron en esta sugerencia.

ObjectReferences

Es una colección de IDs de objetos.

Representación JSON
{
  "objectIds": [
    string
  ]
}
Campos
objectIds[]

string

Son los IDs de los objetos.

SectionBreak

Es un StructuralElement que representa un salto de sección. Una sección es un rango de contenido que tiene el mismo SectionStyle. Un salto de sección representa el inicio de una nueva sección, y el estilo de sección se aplica a la sección después del salto de sección.

El cuerpo del documento siempre comienza con un salto de sección.

Representación JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
Campos
suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un SectionBreak puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

sectionStyle

object (SectionStyle)

Es el estilo de la sección posterior a este salto de sección.

SectionStyle

Es el diseño que se aplica a una sección.

Representación JSON
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
Campos
columnProperties[]

object (SectionColumnProperties)

Son las propiedades de las columnas de la sección.

Si está vacío, la sección contiene una columna con las propiedades predeterminadas en el editor de Documentos. Se puede actualizar una sección para que tenga no más de 3 columnas.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si no se configura esta propiedad, se generará un error 400 de solicitud incorrecta.

columnSeparatorStyle

enum (ColumnSeparatorStyle)

Es el estilo de los separadores de columnas.

Este estilo se puede establecer incluso cuando hay una columna en la sección.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

contentDirection

enum (ContentDirection)

Es la dirección del contenido de esta sección. Si no se establece, el valor predeterminado es LEFT_TO_RIGHT.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

marginTop

object (Dimension)

Es el margen superior de la página de la sección. Si no se establece, el valor predeterminado es marginTop de DocumentStyle.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

marginBottom

object (Dimension)

Es el margen inferior de la página de la sección. Si no se establece, el valor predeterminado es marginBottom de DocumentStyle.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

marginRight

object (Dimension)

Es el margen derecho de la página de la sección. Si no se establece, el valor predeterminado es marginRight de DocumentStyle. Actualizar el margen derecho hace que se cambie el tamaño de las columnas de esta sección. Dado que el margen afecta el ancho de la columna, se aplica antes de las propiedades de la columna.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

marginLeft

object (Dimension)

Es el margen izquierdo de la página de la sección. Si no se establece, el valor predeterminado es marginLeft de DocumentStyle. Si actualizas el margen izquierdo, se cambiará el tamaño de las columnas de esta sección. Dado que el margen afecta el ancho de la columna, se aplica antes de las propiedades de la columna.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

marginHeader

object (Dimension)

Es el margen del encabezado de la sección. Si no se establece, el valor predeterminado es marginHeader de DocumentStyle. Si se actualiza, useCustomHeaderFooterMargins se establece como verdadero en DocumentStyle. El valor de useCustomHeaderFooterMargins en DocumentStyle indica si se respeta un margen de encabezado para esta sección.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

sectionType

enum (SectionType)

Solo salida. Es el tipo de sección.

defaultHeaderId

string

Es el ID del encabezado predeterminado. Si no se configura, el valor se hereda del SectionBreak's SectionStyle anterior. Si el valor no se establece en el primer SectionBreak, se hereda del defaultHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

firstPageHeaderId

string

Es el ID del encabezado que se usa solo para la primera página de la sección. Si useFirstPageHeaderFooter es verdadero, este valor se usa para el encabezado de la primera página de la sección. Si es falso, el encabezado de la primera página de la sección usa defaultHeaderId. Si no se configura, el valor se hereda del SectionBreak's SectionStyle anterior. Si el valor no se establece en el primer SectionBreak, se hereda del firstPageHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

Es el ID del encabezado que se usa solo para las páginas pares. Si el valor de useEvenPageHeaderFooter de DocumentStyle es verdadero, este valor se usa para los encabezados de las páginas pares de la sección. Si es falso, los encabezados de las páginas pares usan defaultHeaderId. Si no se configura, el valor se hereda del SectionBreak's SectionStyle anterior. Si el valor no se establece en el primer SectionBreak, se hereda del evenPageHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

pageNumberStart

integer

Número de página desde el que se comienza a contar la cantidad de páginas de esta sección. Si no se configura, la numeración de página continúa desde la sección anterior. Si el valor no está establecido en el primer SectionBreak, consulta pageNumberStart de DocumentStyle.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

flipPageOrientation

boolean

Opcional. Indica si se deben invertir las dimensiones de pageSize de DocumentStyle para esta sección, lo que permite cambiar la orientación de la página entre vertical y horizontal. Si no se establece, el valor se hereda del flipPageOrientation de DocumentStyle.

Cuando actualices esta propiedad, deberás establecer un valor concreto. Si se anula la configuración de esta propiedad, se produce un error 400 de solicitud incorrecta.

SectionColumnProperties

Son las propiedades que se aplican a la columna de una sección.

Representación JSON
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
Campos
width

object (Dimension)

Solo salida. Es el ancho de la columna.

paddingEnd

object (Dimension)

Es el padding al final de la columna.

ColumnSeparatorStyle

Es el estilo de los separadores de columnas.

Enums
COLUMN_SEPARATOR_STYLE_UNSPECIFIED Es un estilo de separador de columnas no especificado.
NONE No hay líneas de separación entre las columnas.
BETWEEN_EACH_COLUMN Renderiza una línea de separación entre cada columna.

SectionType

Representa la posición del inicio de la sección actual en relación con la sección anterior.

Enums
SECTION_TYPE_UNSPECIFIED No se especificó el tipo de sección.
CONTINUOUS La sección comienza inmediatamente después del último párrafo de la sección anterior.
NEXT_PAGE La sección comienza en la página siguiente.

Tabla

Es un objeto StructuralElement que representa una tabla.

Representación JSON
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
Campos
rows

integer

Cantidad de filas en la tabla.

columns

integer

Cantidad de columnas en la tabla.

Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad diferente de celdas.

tableRows[]

object (TableRow)

Contenido y estilo de cada fila.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un Table puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

tableStyle

object (TableStyle)

Es el estilo de la tabla.

Fila de la tabla

Es el contenido y el estilo de una fila en un Table.

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
Campos
startIndex

integer

Es el índice de inicio basado en cero de esta fila, en unidades de código UTF-16.

endIndex

integer

Índice final basado en cero de esta fila, exclusivo, en unidades de código UTF-16.

tableCells[]

object (TableCell)

El contenido y el estilo de cada celda de esta fila.

Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener una cantidad diferente de celdas que otras filas de la misma tabla.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un TableRow puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

tableRowStyle

object (TableRowStyle)

Es el estilo de la fila de la tabla.

suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

Cambios de diseño sugeridos para esta fila, con la clave del ID de sugerencia.

TableCell

Es el contenido y el estilo de una celda en un Table.

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Campos
startIndex

integer

Índice de inicio basado en cero de esta celda, en unidades de código UTF-16.

endIndex

integer

Índice final basado en cero de esta celda, exclusivo, en unidades de código UTF-16.

content[]

object (StructuralElement)

Es el contenido de la celda.

tableCellStyle

object (TableCellStyle)

Es el estilo de la celda.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un TableCell puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

Son los cambios sugeridos en el estilo de la celda de la tabla, con el ID de sugerencia como clave.

TableCellStyle

Es el estilo de un TableCell.

Los estilos de celdas de tablas heredados se representan como campos no establecidos en este mensaje. El estilo de una celda de la tabla puede heredarse del estilo de la tabla.

Representación JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
Campos
rowSpan

integer

Es el tramo de filas de la celda.

Esta propiedad es de solo lectura.

columnSpan

integer

Es la extensión de la columna de la celda.

Esta propiedad es de solo lectura.

backgroundColor

object (OptionalColor)

Es el color de fondo de la celda.

borderLeft

object (TableCellBorder)

Es el borde izquierdo de la celda.

borderRight

object (TableCellBorder)

Es el borde derecho de la celda.

borderTop

object (TableCellBorder)

Es el borde superior de la celda.

borderBottom

object (TableCellBorder)

Es el borde inferior de la celda.

paddingLeft

object (Dimension)

Es el padding izquierdo de la celda.

paddingRight

object (Dimension)

Es el padding derecho de la celda.

paddingTop

object (Dimension)

Es el padding superior de la celda.

paddingBottom

object (Dimension)

Es el padding inferior de la celda.

contentAlignment

enum (ContentAlignment)

Es la alineación del contenido en la celda de la tabla. La alineación predeterminada coincide con la alineación de las celdas de tabla recién creadas en el editor de Documentos.

TableCellBorder

Es un borde alrededor de una celda de la tabla.

Los bordes de las celdas de la tabla no pueden ser transparentes. Para ocultar el borde de una celda de la tabla, establece su ancho en 0.

Representación JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Campos
color

object (OptionalColor)

Es el color del borde.

Este color no puede ser transparente.

width

object (Dimension)

Es el ancho del borde.

dashStyle

enum (DashStyle)

Es el estilo de guiones del borde.

ContentAlignment

Son los tipos de alineación del contenido.

Se deriva de un subconjunto de los valores del tipo simple "ST_TextAnchoringType" en la sección 20.1.10.60 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de ECMA-376, 5ª edición.

Enums
CONTENT_ALIGNMENT_UNSPECIFIED Es una alineación de contenido no especificada. La alineación del contenido se hereda del elemento principal, si existe.
CONTENT_ALIGNMENT_UNSUPPORTED Es una alineación de contenido no admitida.
TOP Es una alineación que alinea el contenido con la parte superior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "t".
MIDDLE Es una alineación que alinea el contenido al centro del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "ctr".
BOTTOM Es una alineación que alinea el contenido a la parte inferior del contenedor de contenido. Corresponde a ECMA-376 ST_TextAnchoringType "b".

SuggestedTableCellStyle

Es un cambio sugerido en un TableCellStyle.

Representación JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Campos
tableCellStyle

object (TableCellStyle)

Es un objeto TableCellStyle que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con tableCellStyleSuggestionState para ver qué campos cambiaron y sus valores nuevos.

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

Es una máscara que indica cuáles de los campos del TableCellStyle base se modificaron en esta sugerencia.

TableCellStyleSuggestionState

Es una máscara que indica cuáles de los campos del TableCellStyle base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
Campos
rowSpanSuggested

boolean

Indica si hubo un cambio sugerido en rowSpan.

columnSpanSuggested

boolean

Indica si hubo un cambio sugerido en columnSpan.

backgroundColorSuggested

boolean

Indica si hubo un cambio sugerido en backgroundColor.

borderLeftSuggested

boolean

Indica si hubo un cambio sugerido en borderLeft.

borderRightSuggested

boolean

Indica si hubo un cambio sugerido en borderRight.

borderTopSuggested

boolean

Indica si hubo un cambio sugerido en borderTop.

borderBottomSuggested

boolean

Indica si hubo un cambio sugerido en borderBottom.

paddingLeftSuggested

boolean

Indica si hubo un cambio sugerido en paddingLeft.

paddingRightSuggested

boolean

Indica si hubo un cambio sugerido en paddingRight.

paddingTopSuggested

boolean

Indica si hubo un cambio sugerido en paddingTop.

paddingBottomSuggested

boolean

Indica si hubo un cambio sugerido en paddingBottom.

contentAlignmentSuggested

boolean

Indica si hubo un cambio sugerido en contentAlignment.

TableRowStyle

Son los diseños que se aplican a una fila de la tabla.

Representación JSON
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
Campos
minRowHeight

object (Dimension)

Es la altura mínima de la fila. La fila se renderizará en el editor de Documentos con una altura igual o superior a este valor para mostrar todo el contenido de las celdas de la fila.

tableHeader

boolean

Indica si la fila es un encabezado de tabla.

preventOverflow

boolean

Indica si la fila no puede desbordarse más allá de los límites de la página o la columna.

SuggestedTableRowStyle

Es un cambio sugerido en un TableRowStyle.

Representación JSON
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Campos
tableRowStyle

object (TableRowStyle)

Es un objeto TableRowStyle que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con tableRowStyleSuggestionState para ver qué campos cambiaron y sus valores nuevos.

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

Es una máscara que indica cuáles de los campos del TableRowStyle base se modificaron en esta sugerencia.

TableRowStyleSuggestionState

Es una máscara que indica cuáles de los campos del TableRowStyle base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "minRowHeightSuggested": boolean
}
Campos
minRowHeightSuggested

boolean

Indica si hubo un cambio sugerido en minRowHeight.

TableStyle

Son los diseños que se aplican a una tabla.

Representación JSON
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Campos
tableColumnProperties[]

object (TableColumnProperties)

Son las propiedades de cada columna.

Ten en cuenta que, en Documentos, las tablas contienen filas y las filas contienen celdas, de manera similar a HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el tableRowStyle de la fila.

TableColumnProperties

Son las propiedades de una columna en una tabla.

Representación JSON
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
Campos
widthType

enum (WidthType)

Es el tipo de ancho de la columna.

width

object (Dimension)

Es el ancho de la columna. Se establece cuando el widthType de la columna es FIXED_WIDTH.

WidthType

Es el tipo de ancho de la columna.

Enums
WIDTH_TYPE_UNSPECIFIED No se especificó el tipo de ancho de columna.
EVENLY_DISTRIBUTED

El ancho de la columna se distribuye de manera uniforme entre las demás columnas distribuidas de manera uniforme.

El ancho de la columna se determina automáticamente y tendrá una parte igual del ancho restante de la tabla después de tener en cuenta todas las columnas con anchos especificados.

FIXED_WIDTH Ancho de columna fijo. La propiedad [width][google.apps.docs.v1.TableColumnProperties.width contiene el ancho de la columna.

TableOfContents

Un StructuralElement que representa un índice.

Representación JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Campos
content[]

object (StructuralElement)

Es el contenido del índice.

suggestedInsertionIds[]

string

Son los IDs de inserción sugeridos. Un TableOfContents puede tener varios IDs de inserción si se trata de un cambio sugerido anidado. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

Nota a pie de página

Es una nota al pie de un documento.

Representación JSON
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Campos
footnoteId

string

Es el ID de la nota al pie.

content[]

object (StructuralElement)

Es el contenido de la nota al pie.

Los índices del contenido de una nota al pie comienzan en cero.

DocumentStyle

Es el estilo del documento.

Representación JSON
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}
Campos
background

object (Background)

Es el fondo del documento. Los documentos no pueden tener un color de fondo transparente.

defaultHeaderId

string

Es el ID del encabezado predeterminado. Si no se establece, no hay un encabezado predeterminado.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

Es el ID del encabezado que se usa solo para las páginas pares. El valor de useEvenPageHeaderFooter determina si se usa defaultHeaderId o este valor para el encabezado en las páginas pares. Si no se configura, no habrá encabezado de página par.

Esta propiedad es de solo lectura.

firstPageHeaderId

string

Es el ID del encabezado que se usa solo para la primera página. Si no se configura, no existe un encabezado único para la primera página. El valor de useFirstPageHeaderFooter determina si se usa defaultHeaderId o este valor para el encabezado de la primera página. Si no se configura, no habrá encabezado de primera página.

Esta propiedad es de solo lectura.

pageNumberStart

integer

Número de página desde el que se comienza a contar la cantidad de páginas.

marginTop

object (Dimension)

Es el margen superior de la página.

Si actualizas el margen superior de la página en el estilo del documento, se borrará el margen superior de la página en todos los estilos de sección.

marginBottom

object (Dimension)

Es el margen inferior de la página.

Si actualizas el margen inferior de la página en el estilo del documento, se borrará el margen inferior de la página en todos los estilos de sección.

marginRight

object (Dimension)

Es el margen derecho de la página.

Si actualizas el margen derecho de la página en el estilo del documento, se borrará el margen derecho de la página en todos los estilos de sección. También puede hacer que las columnas cambien de tamaño en todas las secciones.

marginLeft

object (Dimension)

Es el margen izquierdo de la página.

Si actualizas el margen izquierdo de la página en el estilo del documento, se borrará el margen izquierdo de la página en todos los estilos de sección. También puede hacer que las columnas cambien de tamaño en todas las secciones.

pageSize

object (Size)

Es el tamaño de una página del documento.

marginHeader

object (Dimension)

Es la cantidad de espacio entre la parte superior de la página y el contenido del encabezado.

flipPageOrientation

boolean

Opcional. Indica si se deben invertir las dimensiones de pageSize, lo que permite cambiar la orientación de la página entre vertical y horizontal.

Fondo

Representa el fondo de un documento.

Representación JSON
{
  "color": {
    object (OptionalColor)
  }
}
Campos
color

object (OptionalColor)

Es el color de fondo.

Tamaño

Un ancho y una altura

Representación JSON
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
Campos
height

object (Dimension)

Es la altura del objeto.

width

object (Dimension)

Es el ancho del objeto.

SuggestedDocumentStyle

Es un cambio sugerido para DocumentStyle.

Representación JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
Campos
documentStyle

object (DocumentStyle)

Es un objeto DocumentStyle que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con documentStyleSuggestionState para ver qué campos cambiaron y sus valores nuevos.

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

Es una máscara que indica cuáles de los campos del DocumentStyle base se modificaron en esta sugerencia.

DocumentStyleSuggestionState

Es una máscara que indica cuáles de los campos del DocumentStyle base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
Campos
backgroundSuggestionState

object (BackgroundSuggestionState)

Es una máscara que indica cuáles de los campos de background se modificaron en esta sugerencia.

defaultHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido en defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido en evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido en firstPageHeaderId.

pageNumberStartSuggested

boolean

Indica si hubo un cambio sugerido en pageNumberStart.

marginTopSuggested

boolean

Indica si hubo un cambio sugerido en marginTop.

marginBottomSuggested

boolean

Indica si hubo un cambio sugerido en marginBottom.

marginRightSuggested

boolean

Indica si hubo un cambio sugerido en marginRight.

marginLeftSuggested

boolean

Indica si hubo un cambio sugerido en marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Máscara que indica cuáles de los campos de [size] [google.apps.docs.v1.DocumentStyle.size] se cambiaron en esta sugerencia.

marginHeaderSuggested

boolean

Indica si hubo un cambio sugerido en marginHeader.

flipPageOrientationSuggested

boolean

Opcional. Indica si hubo un cambio sugerido en flipPageOrientation.

BackgroundSuggestionState

Es una máscara que indica cuáles de los campos del Background base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, Backgound tiene un nuevo valor sugerido.

Representación JSON
{
  "backgroundColorSuggested": boolean
}
Campos
backgroundColorSuggested

boolean

Indica si se modificó el color de fondo actual en esta sugerencia.

SizeSuggestionState

Es una máscara que indica cuáles de los campos del Size base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, Size tiene un nuevo valor sugerido.

Representación JSON
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
Campos
heightSuggested

boolean

Indica si hubo un cambio sugerido en height.

widthSuggested

boolean

Indica si hubo un cambio sugerido en width.

NamedStyles

Son los estilos con nombre. Los párrafos del documento pueden heredar sus TextStyle y ParagraphStyle de estos estilos con nombre.

Representación JSON
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
Campos
styles[]

object (NamedStyle)

Son los estilos con nombre.

Hay una entrada para cada uno de los named style types posibles.

NamedStyle

Es un estilo con nombre. Los párrafos del documento pueden heredar sus TextStyle y ParagraphStyle de este estilo con nombre cuando tienen el mismo tipo de estilo con nombre.

Representación JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
Campos
namedStyleType

enum (NamedStyleType)

Es el tipo de este estilo con nombre.

textStyle

object (TextStyle)

Es el estilo de texto de este estilo con nombre.

paragraphStyle

object (ParagraphStyle)

Es el estilo de párrafo de este estilo con nombre.

SuggestedNamedStyles

Es un cambio sugerido para NamedStyles.

Representación JSON
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
Campos
namedStyles

object (NamedStyles)

Es un objeto NamedStyles que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con namedStylesSuggestionState para ver qué campos cambiaron y sus valores nuevos.

namedStylesSuggestionState

object (NamedStylesSuggestionState)

Es una máscara que indica cuáles de los campos del NamedStyles base se modificaron en esta sugerencia.

NamedStylesSuggestionState

Es el estado de sugerencia de un mensaje NamedStyles.

Representación JSON
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
Campos
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

Máscara que indica cuáles de los campos del objeto NamedStyle correspondiente en styles se modificaron en esta sugerencia.

El orden de estos estados de sugerencia de estilo con nombre coincide con el orden del estilo con nombre correspondiente dentro de la sugerencia named styles.

NamedStyleSuggestionState

Es el estado de sugerencia de un mensaje NamedStyle.

Representación JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Campos
namedStyleType

enum (NamedStyleType)

Es el tipo de diseño con nombre al que corresponde este estado de sugerencia.

Este campo se proporciona para facilitar la coincidencia de NamedStyleSuggestionState con su NamedStyle correspondiente.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuáles de los campos de text style se modificaron en esta sugerencia.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Es una máscara que indica cuáles de los campos de paragraph style se modificaron en esta sugerencia.

Lista

Un objeto List representa los atributos de lista para un grupo de párrafos que pertenecen a la misma lista. Un párrafo que forma parte de una lista tiene una referencia al ID de la lista en su bullet.

Representación JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
listProperties

object (ListProperties)

Son las propiedades de la lista.

suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

Son los cambios sugeridos en las propiedades de la lista, con el ID de sugerencia como clave.

suggestedInsertionId

string

Es el ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias de borrado para esta lista.

ListProperties

Son las propiedades de un objeto list que describen el aspecto de las viñetas pertenecientes a los párrafos asociados con una lista.

Representación JSON
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
Campos
nestingLevels[]

object (NestingLevel)

Describe las propiedades de las viñetas en el nivel asociado.

Una lista tiene como máximo 9 niveles de anidamiento, en los que el nivel 0 corresponde al nivel superior y el nivel 8, al nivel más anidado. Los niveles de anidación se devuelven en orden ascendente, y primero se devuelve el menos anidado.

NestingLevel

Contiene propiedades que describen el aspecto de una viñeta de lista en un nivel de anidación determinado.

Representación JSON
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
Campos
bulletAlignment

enum (BulletAlignment)

Es la alineación de la viñeta dentro del espacio asignado para renderizarla.

glyphFormat

string

Es la cadena de formato que usan las viñetas en este nivel de anidación.

El formato del glifo contiene uno o más marcadores de posición, y estos se reemplazan por los valores adecuados según el glyphType o el glyphSymbol. Los marcadores de posición siguen el patrón %[nestingLevel]. Además, los marcadores de posición pueden tener prefijos y sufijos. Por lo tanto, el formato de los glifos sigue el patrón <prefix>%[nestingLevel]<suffix>. Ten en cuenta que el prefijo y el sufijo son opcionales y pueden ser cadenas arbitrarias.

Por ejemplo, el formato de glifo %0. indica que el glifo renderizado reemplazará el marcador de posición por el glifo correspondiente para el nivel de anidación 0 seguido de un punto como sufijo. Por lo tanto, una lista con un tipo de glifo UPPER_ALPHA y un formato de glifo %0. en el nivel de anidamiento 0 generará una lista con glifos renderizados.

A.

B.

C.

El formato de glifo puede contener marcadores de posición para el nivel de anidación actual y para los niveles de anidación superiores. Por ejemplo, una lista puede tener un formato de glifo de %0. en el nivel de anidamiento 0 y un formato de glifo de %0.%1. en el nivel de anidamiento 1. Si se supone que ambos niveles de anidación tienen tipos de glifos DECIMAL, esto generaría una lista con glifos renderizados.

1.

2.

2.1.

2.2.

3.

En el caso de los niveles de anidación ordenados, la cadena que reemplaza un marcador de posición en el formato de glifo para un párrafo en particular depende del orden del párrafo dentro de la lista.

indentFirstLine

object (Dimension)

Es la cantidad de sangría para la primera línea de los párrafos en este nivel de anidación.

indentStart

object (Dimension)

Es la cantidad de sangría para los párrafos en este nivel de anidación. Se aplica al lado que corresponde al inicio del texto, según la dirección del contenido del párrafo.

textStyle

object (TextStyle)

Es el estilo de texto de las viñetas en este nivel de anidación.

startNumber

integer

Es el número del primer elemento de la lista en este nivel de anidamiento.

Un valor de 0 se trata como un valor de 1 para las listas con letras y números romanos. Para los valores 0 y 1, las listas con letras y números romanos comenzarán en a y i, respectivamente.

Este valor se ignora para los niveles de anidación con glifos no ordenados.

Campo de unión glyph_kind. Es el tipo de glifo que se usa en las viñetas. Define el glifo de viñeta que reemplaza los marcadores de posición en glyph_format. glyph_kind puede ser solo uno de los siguientes:
glyphType

enum (GlyphType)

Es el tipo de glifo que se usa en las viñetas cuando los párrafos de este nivel de anidamiento están ordenados.

El tipo de glifo determina el tipo de glifo que se usa para reemplazar los marcadores de posición dentro de glyphFormat cuando se ordenan los párrafos en este nivel de anidación. Por ejemplo, si el nivel de anidación es 0, el glyphFormat es %0. y el tipo de glifo es DECIMAL, el glifo renderizado reemplazará el marcador de posición %0 en el formato de glifo por un número que corresponda al orden del elemento de la lista dentro de la lista.

glyphSymbol

string

Es un símbolo de glifo personalizado que usan las viñetas cuando los párrafos de este nivel de anidación no están ordenados.

El símbolo de glifo reemplaza los marcadores de posición dentro de glyphFormat. Por ejemplo, si glyphSymbol es el círculo sólido correspondiente al punto de código Unicode U+25cf y glyphFormat es %0, el glifo renderizado sería el círculo sólido.

BulletAlignment

Son los tipos de alineación de una viñeta.

Enums
BULLET_ALIGNMENT_UNSPECIFIED La alineación de la viñeta no está especificada.
START La viñeta se alinea con el inicio del espacio asignado para renderizarla. Alineado a la izquierda para texto LTR y a la derecha en otros casos.
CENTER La viñeta se alinea con el centro del espacio asignado para renderizarla.
END La viñeta se alinea con el final del espacio asignado para renderizarla. Alineado a la derecha para el texto LTR y alineado a la izquierda en otros casos.

GlyphType

Son los tipos de glifos que se usan en las viñetas cuando los párrafos de este nivel de anidación están ordenados.

Enums
GLYPH_TYPE_UNSPECIFIED El tipo de glifo no se especificó o no es compatible.
NONE Una string vacía.
DECIMAL Un número, como 1, 2 o 3.
ZERO_DECIMAL Es un número en el que los números de un solo dígito tienen un prefijo cero, como 01, 02 o 03. Los números con más de un dígito no tienen un cero como prefijo.
UPPER_ALPHA Una letra mayúscula, como A, B o C.
ALPHA Una letra en minúscula, como a, b o c
UPPER_ROMAN Un número romano en mayúsculas, como I, II o III.
ROMAN Un número romano en minúscula, como i, ii o iii.

SuggestedListProperties

Es un cambio sugerido para ListProperties.

Representación JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Campos
listProperties

object (ListProperties)

Es un objeto ListProperties que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con listPropertiesSuggestionState para ver qué campos cambiaron y sus valores nuevos.

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

Es una máscara que indica cuáles de los campos del ListProperties base se modificaron en esta sugerencia.

ListPropertiesSuggestionState

Es una máscara que indica cuáles de los campos del ListProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
Campos
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

Máscara que indica cuáles de los campos del objeto NestingLevel correspondiente en nestingLevels se modificaron en esta sugerencia.

Los estados de sugerencia del nivel de anidación se devuelven en orden ascendente del nivel de anidación, y primero se devuelve el menos anidado.

NestingLevelSuggestionState

Es una máscara que indica cuáles de los campos del NestingLevel base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Campos
bulletAlignmentSuggested

boolean

Indica si hubo un cambio sugerido en bulletAlignment.

glyphTypeSuggested

boolean

Indica si hubo un cambio sugerido en glyphType.

glyphFormatSuggested

boolean

Indica si hubo un cambio sugerido en glyphFormat.

glyphSymbolSuggested

boolean

Indica si hubo un cambio sugerido en glyphSymbol.

indentFirstLineSuggested

boolean

Indica si hubo un cambio sugerido en indentFirstLine.

indentStartSuggested

boolean

Indica si hubo un cambio sugerido en indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuáles de los campos de text style se modificaron en esta sugerencia.

startNumberSuggested

boolean

Indica si hubo un cambio sugerido en startNumber.

NamedRanges

Es una colección de todos los NamedRanges del documento que comparten un nombre determinado.

Representación JSON
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
Campos
name

string

Es el nombre que comparten todos los named ranges.

namedRanges[]

object (NamedRange)

Los NamedRange que comparten el mismo nombre.

NamedRange

Es una colección de objetos Range con el mismo ID de rango con nombre.

Los rangos con nombre permiten que los desarrolladores asocien partes de un documento con una etiqueta arbitraria definida por el usuario para que su contenido se pueda leer o editar de forma programática más adelante. Un documento puede contener varios rangos con nombre que tengan el mismo nombre, pero cada rango con nombre tiene un ID único.

Se crea un rango con nombre con un solo Range, y el contenido insertado dentro de un rango con nombre generalmente expande ese rango. Sin embargo, ciertos cambios en el documento pueden hacer que el rango se divida en varios rangos.

Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tienen acceso al documento pueden ver sus rangos con nombre.

Representación JSON
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Campos
namedRangeId

string

Es el ID del rango con nombre.

name

string

Nombre del rango con nombre.

ranges[]

object (Range)

Son los rangos que pertenecen a este rango con nombre.

Rango

Especifica un rango contiguo de texto.

Representación JSON
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
Campos
segmentId

string

Es el ID del encabezado, el pie de página o la nota al pie en el que se incluye este rango. Un ID de segmento vacío significa el cuerpo del documento.

startIndex

integer

Índice de inicio basado en cero de este rango, en unidades de código UTF-16.

En todos los usos actuales, se debe proporcionar un índice de inicio. Este campo es un Int32Value para admitir futuros casos de uso con rangos abiertos.

endIndex

integer

Índice final basado en cero de este rango, exclusivo, en unidades de código UTF-16.

En todos los usos actuales, se debe proporcionar un índice final. Este campo es un Int32Value para admitir futuros casos de uso con rangos abiertos.

tabId

string

Es la pestaña que contiene este rango. Si se omite, la solicitud se aplica a la primera pestaña.

En un documento que contiene una sola pestaña, haz lo siguiente:

  • Si se proporciona, debe coincidir con el ID de la pestaña singular.

  • Si se omite, la solicitud se aplica a la pestaña singular.

En un documento que contiene varias pestañas, haz lo siguiente:

  • Si se proporciona, la solicitud se aplica a la pestaña especificada.

  • Si se omite, la solicitud se aplica a la primera pestaña del documento.

InlineObject

Objeto que aparece intercalado con el texto. Un InlineObject contiene un EmbeddedObject, como una imagen.

Representación JSON
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
objectId

string

Es el ID de este objeto intercalado. Se puede usar para actualizar las propiedades de un objeto.

inlineObjectProperties

object (InlineObjectProperties)

Son las propiedades de este objeto intercalado.

suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

Son los cambios sugeridos en las propiedades del objeto intercalado, con el ID de sugerencia como clave.

suggestedInsertionId

string

Es el ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

InlineObjectProperties

Son las propiedades de un InlineObject.

Representación JSON
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Campos
embeddedObject

object (EmbeddedObject)

Es el objeto incorporado de este objeto intercalado.

EmbeddedObject

Es un objeto incorporado en el documento.

Representación JSON
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
Campos
title

string

Es el título del objeto incorporado. title y description se combinan para mostrar el texto alternativo.

description

string

Es la descripción del objeto incorporado. title y description se combinan para mostrar el texto alternativo.

embeddedObjectBorder

object (EmbeddedObjectBorder)

Es el borde del objeto incorporado.

size

object (Size)

Tamaño visible de la imagen después de recortarla.

marginTop

object (Dimension)

Es el margen superior del objeto incorporado.

marginBottom

object (Dimension)

Es el margen inferior del objeto incorporado.

marginRight

object (Dimension)

Es el margen derecho del objeto incorporado.

marginLeft

object (Dimension)

Es el margen izquierdo del objeto incorporado.

linkedContentReference

object (LinkedContentReference)

Es una referencia al contenido de la fuente externa vinculada. Por ejemplo, contiene una referencia al gráfico de Hojas de cálculo de Google fuente cuando el objeto incorporado es un gráfico vinculado.

Si no se configura, el objeto incorporado no se vinculará.

Campo de unión properties. Son las propiedades específicas de cada tipo de objeto integrado. Las direcciones (properties) solo pueden ser una de las siguientes opciones:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

Son las propiedades de un dibujo incorporado.

imageProperties

object (ImageProperties)

Son las propiedades de una imagen.

EmbeddedDrawingProperties

Este tipo no tiene campos.

Son las propiedades de un dibujo incorporado y se usan para diferenciar el tipo de objeto. Un dibujo incorporado es aquel que se crea y edita dentro de un documento. Ten en cuenta que no se admiten detalles extensos.

ImageProperties

Son las propiedades de una imagen.

Representación JSON
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Campos
contentUri

string

Es un URI a la imagen con una vida útil predeterminada de 30 minutos. Este URI está etiquetado con la cuenta del solicitante. Cualquier persona que tenga el URI accederá a la imagen como el solicitante original. Es posible que se pierda el acceso a la imagen si cambia la configuración de uso compartido del documento.

sourceUri

string

El URI de origen es el URI que se usa para insertar la imagen. El URI de la fuente puede estar vacío.

brightness

number

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

number

Es el efecto de contraste de la imagen. El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa que no hay efecto.

transparency

number

Es el efecto de transparencia de la imagen. El valor debe estar en el intervalo [0.0, 1.0], donde 0 significa que no hay efecto y 1 significa que es transparente.

cropProperties

object (CropProperties)

Son las propiedades de recorte de la imagen.

angle

number

Ángulo de rotación de la imagen en el sentido de las agujas del reloj, en radianes.

CropProperties

Son las propiedades de recorte de una imagen.

El rectángulo de recorte se representa con desplazamientos fraccionarios desde los 4 bordes del contenido original.

  • Si el desplazamiento está en el intervalo (0, 1), el borde correspondiente del rectángulo de recorte se posiciona dentro del rectángulo de límite original de la imagen.
  • Si el desplazamiento es negativo o mayor que 1, el borde correspondiente del rectángulo de recorte se posiciona fuera del rectángulo delimitador original de la imagen.
  • Si todos los desplazamientos y ángulos de rotación son 0, la imagen no se recorta.
Representación JSON
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Campos
offsetLeft

number

El desplazamiento especifica qué tan hacia adentro se encuentra el borde izquierdo del rectángulo de recorte desde el borde izquierdo del contenido original, como una fracción del ancho del contenido original.

offsetRight

number

El desplazamiento especifica qué tan lejos hacia adentro se encuentra el borde derecho del rectángulo de recorte del borde derecho del contenido original como una fracción del ancho del contenido original.

offsetTop

number

El desplazamiento especifica qué tan lejos hacia adentro se encuentra el borde superior del rectángulo de recorte del borde superior del contenido original como una fracción de la altura del contenido original.

offsetBottom

number

El desplazamiento especifica qué tan adentro se encuentra el borde inferior del rectángulo de recorte con respecto al borde inferior del contenido original, como una fracción de la altura del contenido original.

angle

number

Es el ángulo de rotación en el sentido de las manecillas del reloj del rectángulo de recorte alrededor de su centro, en radianes. La rotación se aplica después de las compensaciones.

EmbeddedObjectBorder

Un borde alrededor de un EmbeddedObject.

Representación JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Campos
color

object (OptionalColor)

Es el color del borde.

width

object (Dimension)

Es el ancho del borde.

dashStyle

enum (DashStyle)

Es el estilo de guiones del borde.

propertyState

enum (PropertyState)

Es el estado de la propiedad de borde.

PropertyState

Son los estados posibles de una propiedad.

Enums
RENDERED Si el estado de una propiedad es RENDERED, el elemento tiene la propiedad correspondiente cuando se renderiza en el documento. Este es el valor predeterminado.
NOT_RENDERED Si el estado de una propiedad es NOT_RENDERED, el elemento no tendrá la propiedad correspondiente cuando se renderice en el documento.

LinkedContentReference

Es una referencia al contenido de la fuente externa vinculada.

Representación JSON
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
Campos
Campo de unión reference. Es la referencia específica del tipo de contenido vinculado. Las direcciones (reference) solo pueden ser una de las siguientes opciones:
sheetsChartReference

object (SheetsChartReference)

Es una referencia al gráfico vinculado.

SheetsChartReference

Es una referencia a un gráfico vinculado incorporado desde Hojas de cálculo de Google.

Representación JSON
{
  "spreadsheetId": string,
  "chartId": integer
}
Campos
spreadsheetId

string

Es el ID de la hoja de cálculo de Hojas de cálculo de Google que contiene el gráfico de origen.

chartId

integer

Es el ID del gráfico específico en la hoja de cálculo de Hojas de cálculo de Google que está incorporada.

SuggestedInlineObjectProperties

Es un cambio sugerido para InlineObjectProperties.

Representación JSON
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
Campos
inlineObjectProperties

object (InlineObjectProperties)

Es un objeto InlineObjectProperties que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con inlineObjectPropertiesSuggestionState para ver qué campos cambiaron y sus valores nuevos.

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

Es una máscara que indica cuáles de los campos del InlineObjectProperties base se modificaron en esta sugerencia.

InlineObjectPropertiesSuggestionState

Es una máscara que indica cuáles de los campos del InlineObjectProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Campos
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Es una máscara que indica cuáles de los campos de embeddedObject se modificaron en esta sugerencia.

EmbeddedObjectSuggestionState

Es una máscara que indica cuáles de los campos del EmbeddedObject base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
Campos
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

Es una máscara que indica cuáles de los campos de embeddedDrawingProperties se modificaron en esta sugerencia.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Es una máscara que indica cuáles de los campos de imageProperties se modificaron en esta sugerencia.

titleSuggested

boolean

Indica si hubo un cambio sugerido en title.

descriptionSuggested

boolean

Indica si hubo un cambio sugerido en description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Es una máscara que indica cuáles de los campos de embeddedObjectBorder se modificaron en esta sugerencia.

sizeSuggestionState

object (SizeSuggestionState)

Es una máscara que indica cuáles de los campos de size se modificaron en esta sugerencia.

marginLeftSuggested

boolean

Indica si hubo un cambio sugerido en marginLeft.

marginRightSuggested

boolean

Indica si hubo un cambio sugerido en marginRight.

marginTopSuggested

boolean

Indica si hubo un cambio sugerido en marginTop.

marginBottomSuggested

boolean

Indica si hubo un cambio sugerido en marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Es una máscara que indica cuáles de los campos de linkedContentReference se modificaron en esta sugerencia.

EmbeddedDrawingPropertiesSuggestionState

Este tipo no tiene campos.

Es una máscara que indica cuáles de los campos del EmbeddedDrawingProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

ImagePropertiesSuggestionState

Es una máscara que indica cuáles de los campos del ImageProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Campos
contentUriSuggested

boolean

Indica si hubo un cambio sugerido en contentUri.

sourceUriSuggested

boolean

Indica si hubo un cambio sugerido en [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

Indica si hubo un cambio sugerido en [brightness] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

Indica si hubo un cambio sugerido en [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Indica si hubo un cambio sugerido en [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Es una máscara que indica cuáles de los campos de cropProperties se modificaron en esta sugerencia.

angleSuggested

boolean

Indica si hubo un cambio sugerido en [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

Es una máscara que indica cuáles de los campos del CropProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
Campos
offsetLeftSuggested

boolean

Indica si hubo un cambio sugerido en offsetLeft.

offsetRightSuggested

boolean

Indica si hubo un cambio sugerido en offsetRight.

offsetTopSuggested

boolean

Indica si hubo un cambio sugerido en offsetTop.

offsetBottomSuggested

boolean

Indica si hubo un cambio sugerido en offsetBottom.

angleSuggested

boolean

Indica si hubo un cambio sugerido en angle.

EmbeddedObjectBorderSuggestionState

Es una máscara que indica cuáles de los campos del EmbeddedObjectBorder base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
Campos
colorSuggested

boolean

Indica si hubo un cambio sugerido en [color] [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

Indica si hubo un cambio sugerido en [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Indica si hubo un cambio sugerido en [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

Indica si hubo un cambio sugerido en [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

Es una máscara que indica cuáles de los campos del LinkedContentReference base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
Campos
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

Es una máscara que indica cuáles de los campos de sheetsChartReference se modificaron en esta sugerencia.

SheetsChartReferenceSuggestionState

Es una máscara que indica cuáles de los campos del SheetsChartReference base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
Campos
spreadsheetIdSuggested

boolean

Indica si hubo un cambio sugerido en spreadsheetId.

chartIdSuggested

boolean

Indica si hubo un cambio sugerido en chartId.

PositionedObject

Es un objeto que está unido a un Paragraph y se posiciona en relación con el inicio del párrafo. Un PositionedObject contiene un EmbeddedObject, como una imagen.

Representación JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
objectId

string

Es el ID de este objeto posicionado.

positionedObjectProperties

object (PositionedObjectProperties)

Son las propiedades de este objeto posicionado.

suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

Son los cambios sugeridos en las propiedades del objeto posicionado, con el ID de sugerencia como clave.

suggestedInsertionId

string

Es el ID de inserción sugerido. Si está vacío, no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de eliminación sugeridos. Si está vacío, no hay sugerencias para borrar este contenido.

PositionedObjectProperties

Propiedades de un PositionedObject.

Representación JSON
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Campos
positioning

object (PositionedObjectPositioning)

Es la posición de este objeto posicionado en relación con el salto de línea del Paragraph que hace referencia a este objeto posicionado.

embeddedObject

object (EmbeddedObject)

Es el objeto incorporado de este objeto posicionado.

PositionedObjectPositioning

Es el posicionamiento de un PositionedObject. El objeto posicionado se ubica en relación con el inicio del Paragraph al que está vinculado.

Representación JSON
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Campos
layout

enum (PositionedObjectLayout)

Es el diseño de este objeto posicionado.

leftOffset

object (Dimension)

Es el desplazamiento del borde izquierdo del objeto posicionado en relación con el inicio del Paragraph al que está vinculado. La posición exacta del objeto puede depender de otro contenido del documento y del diseño del documento.

topOffset

object (Dimension)

Es el desplazamiento del borde superior del objeto posicionado en relación con el inicio del Paragraph al que está vinculado. La posición exacta del objeto puede depender de otro contenido del documento y del diseño del documento.

PositionedObjectLayout

Son los diseños posibles de un [PositionedObject][google.aps.docs.v1.PositionedObject].

Enums
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED El diseño no está especificado.
WRAP_TEXT El texto se ajusta alrededor del objeto posicionado.
BREAK_LEFT Divide el texto de modo que el objeto posicionado quede a la izquierda y el texto a la derecha.
BREAK_RIGHT Divide el texto de modo que el objeto posicionado quede a la derecha y el texto a la izquierda.
BREAK_LEFT_RIGHT Divide el texto de modo que no haya texto a la izquierda ni a la derecha del objeto posicionado.
IN_FRONT_OF_TEXT El objeto posicionado está delante del texto.
BEHIND_TEXT El objeto posicionado está detrás del texto.

SuggestedPositionedObjectProperties

Es un cambio sugerido para PositionedObjectProperties.

Representación JSON
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Campos
positionedObjectProperties

object (PositionedObjectProperties)

Es un objeto PositionedObjectProperties que solo incluye los cambios realizados en esta sugerencia. Se puede usar junto con positionedObjectPropertiesSuggestionState para ver qué campos cambiaron y sus valores nuevos.

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

Es una máscara que indica cuáles de los campos del PositionedObjectProperties base se modificaron en esta sugerencia.

PositionedObjectPropertiesSuggestionState

Es una máscara que indica cuáles de los campos del PositionedObjectProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Campos
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

Es una máscara que indica cuáles de los campos de positioning se modificaron en esta sugerencia.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Es una máscara que indica cuáles de los campos de embeddedObject se modificaron en esta sugerencia.

PositionedObjectPositioningSuggestionState

Es una máscara que indica cuáles de los campos del PositionedObjectPositioning base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un nuevo valor sugerido.

Representación JSON
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
Campos
layoutSuggested

boolean

Indica si hubo un cambio sugerido en layout.

leftOffsetSuggested

boolean

Indica si hubo un cambio sugerido en leftOffset.

topOffsetSuggested

boolean

Indica si hubo un cambio sugerido en topOffset.

SuggestionsViewMode

Es el modo de vista de sugerencias aplicado al documento que indica cómo se representan los cambios sugeridos. Proporciona opciones para leer el documento con todas las sugerencias intercaladas, aceptadas o rechazadas.

Enums
DEFAULT_FOR_CURRENT_ACCESS El SuggestionsViewMode aplicado al documento devuelto depende del nivel de acceso actual del usuario. Si el usuario solo tiene acceso de visualización, se aplica PREVIEW_WITHOUT_SUGGESTIONS. De lo contrario, se aplica SUGGESTIONS_INLINE. Este es el modo de vista de sugerencias predeterminado.
SUGGESTIONS_INLINE

El documento que se muestra tiene sugerencias intercaladas. Los cambios sugeridos se diferenciarán del contenido base dentro del documento.

Las solicitudes para recuperar un documento con este modo mostrarán un error 403 si el usuario no tiene permiso para ver los cambios sugeridos.

PREVIEW_SUGGESTIONS_ACCEPTED

El documento que se devuelve es una vista previa con todos los cambios sugeridos aceptados.

Las solicitudes para recuperar un documento con este modo mostrarán un error 403 si el usuario no tiene permiso para ver los cambios sugeridos.

PREVIEW_WITHOUT_SUGGESTIONS El documento que se devuelve es una vista previa con todos los cambios sugeridos rechazados si hay sugerencias en el documento.

Métodos

batchUpdate

Aplica una o más actualizaciones al documento.

create

Crea un documento en blanco con el título que se proporciona en la solicitud.

get

Obtiene la versión más reciente del documento especificado.