REST Resource: documents

Recurso: Documento

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)

Pestañas que forman parte de un documento.

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

revisionId

string

Solo salida. Es el ID de revisión del documento. Se puede utilizar en solicitudes de actualización para especificar a qué revisión de un documento se deben aplicar las actualizaciones y cómo debe comportarse la solicitud si el documento se editó desde esa revisión. Solo se completa si el usuario tiene acceso de edición al documento.

El ID de revisión no es un número secuencial, sino una cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Si se muestra un ID de revisión, solo se garantiza su validez durante 24 horas, y no se puede compartir con los usuarios. Si el ID de revisión no se cambia entre llamadas, el documento no cambió. En cambio, un ID modificado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un ID modificado también puede deberse a factores internos, como modificaciones en el formato del ID.

suggestionsViewMode

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 la estableces, este campo contiene información sobre la primera pestaña del documento.

headers

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

Solo salida. Los encabezados del documento, con el ID de encabezado de 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 la estableces, este campo contiene información sobre la primera pestaña del documento.

footers

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

Solo salida. Los pies de página del documento, escritos por ID de 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 la estableces, este campo contiene información sobre la primera pestaña del documento.

footnotes

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

Solo salida. Las notas al pie del documento, escritas por el ID de la nota al pie

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 la estableces, 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 la estableces, este campo contiene información sobre la primera pestaña del documento.

suggestedDocumentStyleChanges

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

Solo salida. Los cambios sugeridos para el estilo del documento, codificados por 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 la estableces, 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 la estableces, este campo contiene información sobre la primera pestaña del documento.

suggestedNamedStylesChanges

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

Solo salida. Los cambios sugeridos para los estilos con nombre del documento, vinculados 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 la estableces, este campo contiene información sobre la primera pestaña del documento.

lists

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

Solo salida. Las listas del documento, con el ID de 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 la estableces, este campo contiene información sobre la primera pestaña del documento.

namedRanges

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

Solo salida. Los rangos con nombre en el documento, con clave por nombre.

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 la estableces, este campo contiene información sobre la primera pestaña del documento.

inlineObjects

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

Solo salida. Los objetos intercalados en el documento, con clave por ID de objeto.

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 la estableces, este campo contiene información sobre la primera pestaña del documento.

positionedObjects

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

Solo salida. Los objetos posicionados en el documento, con clave por ID de objeto.

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 la estableces, este campo contiene información sobre la primera pestaña del documento.

Tab

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)

Las propiedades de la pestaña, como el ID y el título

childTabs[]

object (Tab)

Las pestañas secundarias anidadas dentro de esta pestaña.

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

object (DocumentTab)

Una pestaña con contenido de documentos, como imágenes y texto

TabProperties

Propiedades de una pestaña

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

string

Solo salida. El ID de la pestaña. No se puede modificar este campo.

title

string

Es el nombre de la pestaña que se muestra al usuario.

parentTabId

string

Opcional. El ID de la pestaña superior. Está vacía cuando la pestaña actual es una pestaña de nivel raíz, lo que significa que no tiene ninguna superior.

index

integer

El índice basado en cero de la pestaña dentro del elemento superior.

nestingLevel

integer

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

DocumentTab

Una pestaña con el contenido del documento.

Representación JSON
{
  "body": {
    object (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)

Cuerpo principal de la pestaña del documento.

headers

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

Los encabezados de la pestaña del documento, con el ID del encabezado como clave.

footers

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

Los pies de página en la pestaña del documento, escritos por el ID del pie de página.

footnotes

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

Las notas al pie en la pestaña del documento, codificadas por el ID de la nota al pie

documentStyle

object (DocumentStyle)

El estilo de la pestaña del documento.

suggestedDocumentStyleChanges

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

Los cambios sugeridos para el estilo de la pestaña del documento, codificados por ID de sugerencia.

namedStyles

object (NamedStyles)

Los estilos con nombre de la pestaña del documento.

suggestedNamedStylesChanges

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

Los cambios sugeridos para los estilos con nombre de la pestaña del documento, codificados por ID de sugerencia.

lists

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

Las listas de la pestaña del documento, con el ID de lista como claves.

namedRanges

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

Los rangos con nombre en la pestaña del documento, con clave por nombre.

inlineObjects

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

Los objetos intercalados en la pestaña del documento, con clave por ID de objeto.

positionedObjects

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

Los objetos posicionados en la pestaña del documento, con clave por ID de objeto.

Cuerpo

El cuerpo del documento.

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

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

object (StructuralElement)

El contenido del cuerpo.

Los índices para el contenido del cuerpo comienzan en cero.

StructuralElement

Un StructuralElement describe el contenido que le proporciona estructura al documento.

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

  // Union field 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

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

endIndex

integer

Es el í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 índice de elemento estructural.

Párrafo

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

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)

El contenido del párrafo, desglosado en sus componentes.

paragraphStyle

object (ParagraphStyle)

El estilo de este párrafo.

suggestedParagraphStyleChanges

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

El estilo de párrafo sugerido cambia a este párrafo, codificado por ID de sugerencia.

bullet

object (Bullet)

Es la 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))

Los cambios sugeridos para la viñeta de este párrafo.

positionedObjectIds[]

string

Son los ID de los objetos posicionados conectados a este párrafo.

suggestedPositionedObjectIds

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

Los ID de los objetos posicionados sugeridos para adjuntar a este párrafo, enmarcados por ID de sugerencia.

ParagraphElement

Un ParagraphElement describe contenido de un Paragraph.

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

  // Union field 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

El índice final con base cero de este elemento de párrafo, exclusivo, en unidades de código UTF-16.

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

object (TextRun)

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

autoText

object (AutoText)

Un elemento de párrafo de texto automático.

pageBreak

object (PageBreak)

Un elemento de párrafo de salto de página.

columnBreak

object (ColumnBreak)

Un elemento de párrafo de salto de columna.

footnoteReference

object (FootnoteReference)

Un elemento de un párrafo de referencia de una nota al pie.

horizontalRule

object (HorizontalRule)

Un elemento de párrafo de regla horizontal.

equation

object (Equation)

Un elemento de párrafo de ecuación.

inlineObjectElement

object (InlineObjectElement)

Es un elemento de párrafo de un objeto intercalado.

person

object (Person)

Un elemento de párrafo que dirige a una persona o dirección de correo electrónico.

TextRun

Es un objeto ParagraphElement que representa una ejecución de texto con el mismo estilo.

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

string

Es el texto de esta ejecución.

Cualquier elemento que no sea de texto en la ejecución se reemplaza por el carácter Unicode U+E907.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una TextRun puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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))

El estilo de texto sugerido cambia en esta ejecución, con clave de ID de sugerencia.

TextStyle

Representa el estilo que se puede aplicar al texto.

Los estilos de texto heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de texto depende del lugar en el que se defina ese estilo:

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

Si el estilo de texto no se hereda de un estilo superior, al desconfigurar los campos, se revertirá el estilo a un valor que coincida con los valores predeterminados del editor de Documentos.

Representación JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (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 mayúsculas o no.

backgroundColor

object (OptionalColor)

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

foregroundColor

object (OptionalColor)

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

fontSize

object (Dimension)

El tamaño de la fuente del texto.

weightedFontFamily

object (WeightedFontFamily)

La familia de fuentes y el grosor renderizado del texto.

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

Si weightedFontFamily#weight no está configurado, el valor predeterminado es 400.

Si se configura weightedFontFamily, entonces weightedFontFamily#fontFamily también debe configurarse con un valor que no esté vacío. De lo contrario, se muestra un error 400 de solicitud incorrecta.

baselineOffset

enum (BaselineOffset)

Es el desplazamiento vertical del texto con respecto a su posición normal.

El texto con desplazamientos del modelo de referencia SUPERSCRIPT o SUBSCRIPT se renderiza automáticamente en un tamaño de fuente más pequeño, calculado en función del campo fontSize. Los cambios en este campo no afectan a fontSize.

OptionalColor

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

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

object (Color)

Si se establece, se usará como color opaco. Si no la estableces, 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

Un color RGB

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

number

El componente rojo del color, de 0.0 a 1.0.

green

number

El componente verde del color, de 0.0 a 1.0.

blue

number

El componente azul del color, de 0.0 a 1.0.

Dimensión

Es una magnitud en una dirección única en las unidades especificadas.

Representación JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
Campos
magnitude

number

La magnitud.

unit

enum (Unit)

Unidades para magnitud.

Unidad

Unidades de medida.

Enumeraciones
UNIT_UNSPECIFIED Las unidades son desconocidas.
PT Un punto, 1/72 de pulgada.

WeightedFontFamily

Representa una familia de fuentes y un grosor del texto.

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

string

La familia de fuentes del texto.

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

weight

integer

El grosor de la fuente. Este campo puede tener cualquier valor que sea múltiplo de 100 entre 100 y 900 inclusive. Este rango corresponde a los valores numéricos descritos en la sección 15.6 de la especificación CSS 2.1. No se permiten los 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 de 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 es 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 del renderizado equivale al peso.

BaselineOffset

Maneras en las que el texto se puede desplazar verticalmente de su posición normal.

Enumeraciones
BASELINE_OFFSET_UNSPECIFIED El desplazamiento del modelo de referencia del texto se hereda del elemento superior.
NONE El texto no está desplazado verticalmente.
SUPERSCRIPT El texto se desplaza verticalmente hacia arriba (superíndice).
SUBSCRIPT El texto se desplaza verticalmente hacia abajo (subíndice).

SuggestedTextStyle

Un cambio sugerido para un TextStyle.

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

object (TextStyle)

Una 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)

Una máscara que indica cuáles de los campos del TextStyle base se cambiaron en esta sugerencia.

TextStyleSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para bold.

italicSuggested

boolean

Indica si hubo un cambio sugerido para italic.

underlineSuggested

boolean

Indica si hubo un cambio sugerido para underline.

strikethroughSuggested

boolean

Indica si hubo un cambio sugerido para strikethrough.

smallCapsSuggested

boolean

Indica si hubo un cambio sugerido para smallCaps.

backgroundColorSuggested

boolean

Indica si hubo un cambio sugerido para backgroundColor.

foregroundColorSuggested

boolean

Indica si hubo un cambio sugerido para foregroundColor.

fontSizeSuggested

boolean

Indica si hubo un cambio sugerido para fontSize.

weightedFontFamilySuggested

boolean

Indica si hubo un cambio sugerido para weightedFontFamily.

baselineOffsetSuggested

boolean

Indica si hubo un cambio sugerido para baselineOffset.

AutoText

Un objeto ParagraphElement que representa un espacio 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 este texto automático.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una AutoText puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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))

El estilo de texto sugerido cambia a este AutoText, codificado por ID de sugerencia.

Tipo

Los tipos de texto automático.

Enumeraciones
TYPE_UNSPECIFIED Un tipo de texto automático no especificado.
PAGE_NUMBER Es un tipo de texto automático que representa el número de página actual.
PAGE_COUNT Escribe el texto automático que representa el número total de páginas en el documento.

PageBreak

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

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

string

Los IDs de inserción sugeridos. Una PageBreak puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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 salto de página.

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

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este salto de página, marcado por el ID de sugerencia.

ColumnBreak

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

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

string

Los IDs de inserción sugeridos. Una ColumnBreak puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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 salto de columna.

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

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este salto de columna, marcado por el 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 renderizado con un número y se usa para identificar la nota al pie.

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

string

Es el ID de footnote que incluye el contenido de esta referencia de nota al pie.

footnoteNumber

string

Es la cantidad renderizada de esta nota al pie.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una FootnoteReference puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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 FootnoteReference.

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a esta FootnoteReference con la clave de ID de sugerencia.

HorizontalRule

Un objeto ParagraphElement que representa una línea horizontal

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

string

Los IDs de inserción sugeridos. Una HorizontalRule puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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 HorizontalRule.

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

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a esta HorizontalRule, codificado por ID de sugerencia.

Ecuación

Un objeto ParagraphElement que representa una ecuación.

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

string

Los IDs de inserción sugeridos. Una Equation puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

InlineObjectElement

Es 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

El ID de las InlineObject que contiene este elemento.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una InlineObjectElement puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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 y el estilo del texto que se inserta junto a él.

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este InlineObject, controlado por el ID de sugerencia.

Persona

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

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

string

Solo salida. El ID único de este vínculo.

suggestedInsertionIds[]

string

IDs para sugerencias que insertan el vínculo de esta persona en el documento. Un Person podría tener varios IDs de inserción si se trata de un cambio sugerido anidado (por ejemplo, una sugerencia dentro de una sugerencia realizada por un usuario diferente). Si está vacío, el vínculo de esta persona no es una inserción sugerida.

suggestedDeletionIds[]

string

Son los IDs de las sugerencias que quitan el vínculo del documento a esta persona. Una Person podría tener varios IDs de eliminación si, por ejemplo, varios usuarios sugieren borrarlo. Si está vacío, no se sugiere borrar el vínculo de esta 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, marcado por el ID de sugerencia.

personProperties

object (PersonProperties)

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

PersonProperties

Propiedades específicas de un Person vinculado

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

string

Solo salida. El nombre de la persona si aparece en el texto del vínculo en lugar de la dirección de correo electrónico de la persona.

email

string

Solo salida. La dirección de correo electrónico vinculada a tu Person. Este campo siempre está presente.

RichLinkProperties

Propiedades específicas de un RichLink

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

string

Solo salida. El título de RichLink 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. Esto siempre está presente.

mimeType

string

Solo salida. El tipo de MIME de RichLink, si existe uno (por ejemplo, cuando es un archivo en Drive)

ParagraphStyle

Estilos que se aplican a un párrafo completo.

Los estilos de párrafo heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de párrafo depende del lugar en el que se define:

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

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

Representación JSON
{
  "headingId": string,
  "namedStyleType": enum (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

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

Esta propiedad es de solo lectura.

namedStyleType

enum (NamedStyleType)

El tipo de estilo con nombre del párrafo.

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

alignment

enum (Alignment)

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

lineSpacing

number

La cantidad de espacio entre líneas, como un porcentaje de normal, donde la normalidad se representa como 100.0. Si no la estableces, el valor se heredará del elemento superior.

direction

enum (ContentDirection)

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

spacingMode

enum (SpacingMode)

El modo de espaciado para el párrafo.

spaceAbove

object (Dimension)

La cantidad de espacio adicional sobre el párrafo. Si no la estableces, el valor se heredará del elemento superior.

spaceBelow

object (Dimension)

La cantidad de espacio adicional debajo del párrafo. Si no la estableces, el valor se heredará del elemento superior.

borderBetween

object (ParagraphBorder)

Es el borde entre este párrafo y el párrafo siguiente y el anterior. Si no la estableces, el valor se heredará del elemento superior.

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

Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad.

borderTop

object (ParagraphBorder)

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

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

Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad.

borderBottom

object (ParagraphBorder)

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

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

Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad.

borderLeft

object (ParagraphBorder)

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

Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad.

borderRight

object (ParagraphBorder)

Es el borde que se encuentra a la derecha de este párrafo. Si no la estableces, el valor se heredará del elemento superior.

Los bordes del párrafo no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad.

indentFirstLine

object (Dimension)

La cantidad de sangría para la primera línea del párrafo. Si no la estableces, el valor se heredará del elemento superior.

indentStart

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 la estableces, el valor se heredará 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 la estableces, el valor se heredará del elemento superior.

tabStops[]

object (TabStop)

Una lista de las tabulaciones para este párrafo. La lista de tabulaciones no se hereda.

Esta propiedad es de solo lectura.

keepLinesTogether

boolean

Si todas las líneas del párrafo deben colocarse en la misma página o columna, si es posible. Si no la estableces, el valor se heredará del elemento superior.

keepWithNext

boolean

Si al menos una parte de este párrafo debe presentarse en la misma página o columna que el siguiente párrafo, si es posible. Si no la estableces, el valor se heredará del elemento superior.

avoidWidowAndOrphan

boolean

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

shading

object (Shading)

El sombreado del párrafo. Si no la estableces, el valor se heredará del elemento superior.

pageBreakBefore

boolean

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

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

NamedStyleType

Son los tipos de estilos con nombre.

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

Alineación

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

Enumeraciones
ALIGNMENT_UNSPECIFIED La alineación del párrafo se hereda del elemento superior.
START El párrafo se alinea con el inicio de la línea. Alineado a la izquierda para el texto LTR; de lo contrario, alineado a la derecha.
CENTER El párrafo está centrado.
END El párrafo está alineado al final de la línea. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda
JUSTIFIED El párrafo está justificado.

ContentDirection

El contenido de las instrucciones puede fluir.

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

SpacingMode

Los diferentes modos de espaciado entre párrafos.

Enumeraciones
SPACING_MODE_UNSPECIFIED El modo de espaciado se hereda del elemento superior.
NEVER_COLLAPSE El espaciado de párrafo siempre está renderizado.
COLLAPSE_LISTS Se omite el espaciado de párrafo entre los elementos de la lista.

ParagraphBorder

Un borde alrededor de un párrafo.

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

object (OptionalColor)

El color del borde.

width

object (Dimension)

Es el ancho del borde.

padding

object (Dimension)

El relleno del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

DashStyle

Los tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el valor de “ST_PresetLineDashVal”. tipo simple descrito en la sección 20.1.10.48 de "Formatos de archivo de Office Open XML: Referencia sobre los aspectos básicos y el lenguaje de marcado", parte 1 de la 4a edición de ECMA-376.

Enumeraciones
DASH_STYLE_UNSPECIFIED Estilo de guion no especificado.
SOLID Línea continua Corresponde al valor "solid" de ECMA-376 ST_PresetLineDashVal. Este es el estilo de guion predeterminado.
DOT Línea de puntos. Corresponde al valor "punto" de ECMA-376 ST_PresetLineDashVal.
DASH Línea punteada Corresponde al valor "dash" de ECMA-376 ST_PresetLineDashVal.

TabStop

Una tabulación dentro de un párrafo.

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

object (Dimension)

El desplazamiento entre esta tabulación y el margen de inicio.

alignment

enum (TabStopAlignment)

Es la alineación de esta tabulación. Si no la estableces, el valor predeterminado será START.

TabStopAlignment

La alineación de la tabulación

Enumeraciones
TAB_STOP_ALIGNMENT_UNSPECIFIED No se especifica la alineación de la tabulación.
START La tabulación está alineada con el inicio de la línea. Esta es la opción predeterminada.
CENTER La tabulación está alineada con el centro de la línea.
END La tabulación está alineada al final de la línea.

Sombras

El sombreado de un párrafo.

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

object (OptionalColor)

El color de fondo del sombreado de este párrafo.

SuggestedParagraphStyle

Un cambio sugerido para un ParagraphStyle.

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

object (ParagraphStyle)

Una 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)

Una máscara que indica cuáles de los campos del ParagraphStyle base se cambiaron en esta sugerencia.

ParagraphStyleSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para headingId.

namedStyleTypeSuggested

boolean

Indica si hubo un cambio sugerido para namedStyleType.

alignmentSuggested

boolean

Indica si hubo un cambio sugerido para alignment.

lineSpacingSuggested

boolean

Indica si hubo un cambio sugerido para lineSpacing.

directionSuggested

boolean

Indica si hubo un cambio sugerido para direction.

spacingModeSuggested

boolean

Indica si hubo un cambio sugerido para spacingMode.

spaceAboveSuggested

boolean

Indica si hubo un cambio sugerido para spaceAbove.

spaceBelowSuggested

boolean

Indica si hubo un cambio sugerido para spaceBelow.

borderBetweenSuggested

boolean

Indica si hubo un cambio sugerido para borderBetween.

borderTopSuggested

boolean

Indica si hubo un cambio sugerido para borderTop.

borderBottomSuggested

boolean

Indica si hubo un cambio sugerido para borderBottom.

borderLeftSuggested

boolean

Indica si hubo un cambio sugerido para borderLeft.

borderRightSuggested

boolean

Indica si hubo un cambio sugerido para borderRight.

indentFirstLineSuggested

boolean

Indica si hubo un cambio sugerido para indentFirstLine.

indentStartSuggested

boolean

Indica si hubo un cambio sugerido para indentStart.

indentEndSuggested

boolean

Indica si hubo un cambio sugerido para indentEnd.

keepLinesTogetherSuggested

boolean

Indica si hubo un cambio sugerido para keepLinesTogether.

keepWithNextSuggested

boolean

Indica si hubo un cambio sugerido para keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indica si hubo un cambio sugerido para avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Una máscara que indica cuáles de los campos de shading se cambiaron en esta sugerencia.

pageBreakBeforeSuggested

boolean

Indica si hubo un cambio sugerido para pageBreakBefore.

ShadingSuggestionState

Una máscara que indica cuáles de los campos en el Shading base se cambiaron en este cambio sugerido. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.

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

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

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

nestingLevel

integer

El nivel de anidamiento de este párrafo en la lista.

textStyle

object (TextStyle)

El estilo de texto específico de párrafo que se aplicó a esta viñeta.

SuggestedBullet

Un cambio sugerido para un Bullet.

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

object (Bullet)

Una 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)

Una máscara que indica cuáles de los campos del Bullet base se cambiaron en esta sugerencia.

BulletSuggestionState

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

Representación JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (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)

Una máscara que indica cuáles de los campos de text style se cambiaron en esta sugerencia.

ObjectReferences

Es una colección de IDs de objeto.

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

string

Los ID de objeto

SectionBreak

Un objeto StructuralElement que representa un salto de sección. Una sección es un rango de contenido que tiene el mismo SectionStyle. Un salto de sección representa el inicio de una nueva sección, y el estilo de la sección se aplica a la sección que sigue 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

Los IDs de inserción sugeridos. Una SectionBreak puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID 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 que sigue a este salto de sección.

SectionStyle

El estilo 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)

Las propiedades de las columnas de la sección.

Si está vacía, la sección contiene una columna con las propiedades predeterminadas del editor de Documentos. Una sección se puede actualizar para que no tenga más de 3 columnas.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se generará un error 400 de solicitud incorrecta.

columnSeparatorStyle

enum (ColumnSeparatorStyle)

El estilo de los separadores de columna.

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

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

contentDirection

enum (ContentDirection)

Es la dirección del contenido de esta sección. Si no la estableces, el valor predeterminado será LEFT_TO_RIGHT.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

marginTop

object (Dimension)

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

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará 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 actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

marginRight

object (Dimension)

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 las columnas de esta sección cambien de tamaño. Como el margen afecta el ancho de la columna, se aplica antes que las propiedades de la columna.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

marginLeft

object (Dimension)

El margen izquierdo de la página de la sección. Si no se establece, el valor predeterminado es marginLeft de DocumentStyle. Actualizar el margen izquierdo hace que las columnas de esta sección cambien de tamaño. Como el margen afecta el ancho de la columna, se aplica antes que las propiedades de la columna.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

marginHeader

object (Dimension)

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 actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

sectionType

enum (SectionType)

Solo salida. Es el tipo de sección.

defaultHeaderId

string

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

Esta propiedad es de solo lectura.

firstPageHeaderId

string

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 el defaultHeaderId. Si no se establece, el valor se hereda del SectionStyle SectionBreak's anterior. Si no se establece el valor en el primer SectionBreak, se hereda de firstPageHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

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

Esta propiedad es de solo lectura.

pageNumberStart

integer

El número de página desde la que se comienza a contar la cantidad de páginas de esta sección. Si no la estableces, la numeración de las páginas continuará desde la sección anterior. Si no estableces el valor en la primera SectionBreak, consulta la pageNumberStart de DocumentStyle.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

flipPageOrientation

boolean

Opcional. Indica si se deben invertir las dimensiones del elemento pageSize de DocumentStyle en 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 de flipPageOrientation de DocumentStyle.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si se desactiva esta propiedad, se mostrará un error 400 de solicitud incorrecta.

SectionColumnProperties

Propiedades que se aplican a la columna de una sección.

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

object (Dimension)

Solo salida. El ancho de la columna.

paddingEnd

object (Dimension)

Es el relleno al final de la columna.

ColumnSeparatorStyle

El estilo de los separadores de columnas entre columnas.

Enumeraciones
COLUMN_SEPARATOR_STYLE_UNSPECIFIED Estilo de separador de columnas no especificado.
NONE No hay líneas de separador de columnas entre las columnas.
BETWEEN_EACH_COLUMN Renderiza una línea de separador de columnas entre cada columna.

SectionType

Representa cómo se posiciona el inicio de la sección actual en relación con la sección anterior.

Enumeraciones
SECTION_TYPE_UNSPECIFIED El tipo de sección no se especifica.
CONTINUOUS La sección comienza inmediatamente después del último párrafo de la sección anterior.
NEXT_PAGE La sección comienza en la página siguiente.

Tabla

Un 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 de 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)

El contenido y el estilo de cada fila

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una Table puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

tableStyle

object (TableStyle)

El estilo de la tabla.

Fila de la tabla

El contenido y el estilo de una fila en un Table

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (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

El í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 en la misma tabla.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una TableRow puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

tableRowStyle

object (TableRowStyle)

El estilo de la fila de la tabla.

suggestedTableRowStyleChanges

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

El estilo sugerido cambia en esta fila, codificado por ID de sugerencia.

TableCell

El contenido y el estilo de una celda en un Table

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

integer

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

endIndex

integer

El í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

Los IDs de inserción sugeridos. Una TableCell puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

suggestedTableCellStyleChanges

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

Los cambios sugeridos para el estilo de celda de la tabla, vinculados por ID de sugerencia.

TableCellStyle

Es el estilo de un TableCell.

Los estilos de celda de tabla heredados se representan como campos sin configurar en este mensaje. Un estilo de celda de tabla puede heredar 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

El intervalo de filas de la celda.

Esta propiedad es de solo lectura.

columnSpan

integer

El intervalo de columnas de la celda.

Esta propiedad es de solo lectura.

backgroundColor

object (OptionalColor)

El color de fondo de la celda.

borderLeft

object (TableCellBorder)

Borde izquierdo de la celda.

borderRight

object (TableCellBorder)

Borde derecho de la celda.

borderTop

object (TableCellBorder)

Borde superior de la celda.

borderBottom

object (TableCellBorder)

Borde inferior de la celda.

paddingLeft

object (Dimension)

Relleno izquierdo de la celda.

paddingRight

object (Dimension)

El padding derecho de la celda.

paddingTop

object (Dimension)

Padding superior de la celda.

paddingBottom

object (Dimension)

Padding inferior de la celda

contentAlignment

enum (ContentAlignment)

La alineación del contenido en la celda de la tabla. La alineación predeterminada es la misma que la de las celdas de tabla nuevas que se crean en el editor de Documentos.

TableCellBorder

Un borde alrededor de una celda de la tabla.

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

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

object (OptionalColor)

El color del borde.

Este color no puede ser transparente.

width

object (Dimension)

Es el ancho del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

ContentAlignment

Los tipos de alineación del contenido.

Derivado de un subconjunto de valores de "ST_TextAnchoringType" tipo simple en la sección 20.1.10.59 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 de la 4a edición de ECMA-376.

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

SuggestedTableCellStyle

Un cambio sugerido para un TableCellStyle.

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

object (TableCellStyle)

Una 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)

Una máscara que indica cuáles de los campos del TableCellStyle base se cambiaron en esta sugerencia.

TableCellStyleSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para rowSpan.

columnSpanSuggested

boolean

Indica si hubo un cambio sugerido para columnSpan.

backgroundColorSuggested

boolean

Indica si hubo un cambio sugerido para backgroundColor.

borderLeftSuggested

boolean

Indica si hubo un cambio sugerido para borderLeft.

borderRightSuggested

boolean

Indica si hubo un cambio sugerido para borderRight.

borderTopSuggested

boolean

Indica si hubo un cambio sugerido para borderTop.

borderBottomSuggested

boolean

Indica si hubo un cambio sugerido para borderBottom.

paddingLeftSuggested

boolean

Indica si hubo un cambio sugerido para paddingLeft.

paddingRightSuggested

boolean

Indica si hubo un cambio sugerido para paddingRight.

paddingTopSuggested

boolean

Indica si hubo un cambio sugerido para paddingTop.

paddingBottomSuggested

boolean

Indica si hubo un cambio sugerido para paddingBottom.

contentAlignmentSuggested

boolean

Indica si hubo un cambio sugerido para contentAlignment.

TableRowStyle

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)

La altura mínima de la fila. En el Editor de Documentos, la fila se renderizará a una altura igual o superior a este valor para mostrar todo el contenido 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 desbordar los límites de la página o de las columnas.

SuggestedTableRowStyle

Un cambio sugerido para un TableRowStyle.

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

object (TableRowStyle)

Una 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)

Una máscara que indica cuáles de los campos del TableRowStyle base se cambiaron en esta sugerencia.

TableRowStyleSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para minRowHeight.

TableStyle

Diseños que se aplican a una tabla.

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

object (TableColumnProperties)

Propiedades de cada columna

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

TableColumnProperties

Propiedades de una columna en una tabla.

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

enum (WidthType)

El tipo de ancho de la columna.

width

object (Dimension)

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

WidthType

El tipo de ancho de la columna.

Enumeraciones
WIDTH_TYPE_UNSPECIFIED El tipo de ancho de columna no se especifica.
EVENLY_DISTRIBUTED

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

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

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

TableOfContents

Es un elemento 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

Los IDs de inserción sugeridos. Una TableOfContents puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

Nota a pie de página

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)

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)

Corresponde al fondo del documento. Los documentos no pueden tener un color de fondo transparente.

defaultHeaderId

string

El ID del encabezado predeterminado. Si no la estableces, no habrá ningún encabezado predeterminado.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

El ID del encabezado que se utiliza solo para páginas pares. El valor de useEvenPageHeaderFooter determina si se debe usar defaultHeaderId o este para el encabezado en páginas pares. Si no la estableces, no habrá ningún encabezado en las páginas pares.

Esta propiedad es de solo lectura.

firstPageHeaderId

string

El ID del encabezado que se usa solo para la primera página. Si no se establece, no existe un encabezado único para la primera página. El valor de useFirstPageHeaderFooter determina si se debe usar el defaultHeaderId o este valor para el encabezado de la primera página. Si no la estableces, no se mostrará el encabezado de la primera página.

Esta propiedad es de solo lectura.

pageNumberStart

integer

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

marginTop

object (Dimension)

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)

El margen inferior de la página.

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

marginRight

object (Dimension)

El margen derecho de la página.

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

marginLeft

object (Dimension)

El margen izquierdo de la página.

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

pageSize

object (Size)

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

marginHeader

object (Dimension)

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

flipPageOrientation

boolean

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

Información general

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)

La altura del objeto.

width

object (Dimension)

El ancho del objeto.

SuggestedDocumentStyle

Un cambio sugerido para DocumentStyle.

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

object (DocumentStyle)

Una 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)

Una máscara que indica cuáles de los campos del DocumentStyle base se cambiaron en esta sugerencia.

DocumentStyleSuggestionState

Una máscara que indica cuáles de los campos del DocumentStyle base se cambiaron en esta sugerencia. Para cualquier campo configurado 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)

Una máscara que indica cuáles de los campos de background se cambiaron en esta sugerencia.

defaultHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido para defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido para evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido para firstPageHeaderId.

pageNumberStartSuggested

boolean

Indica si hubo un cambio sugerido para pageNumberStart.

marginTopSuggested

boolean

Indica si hubo un cambio sugerido para marginTop.

marginBottomSuggested

boolean

Indica si hubo un cambio sugerido para marginBottom.

marginRightSuggested

boolean

Indica si hubo un cambio sugerido para marginRight.

marginLeftSuggested

boolean

Indica si hubo un cambio sugerido para marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Una máscara que indica cuál de los campos de [tamaño] Se modificó [google.apps.docs.v1.DocumentStyle.size] en esta sugerencia.

marginHeaderSuggested

boolean

Indica si hubo un cambio sugerido para marginHeader.

flipPageOrientationSuggested

boolean

Opcional. Indica si hubo un cambio sugerido para flipPageOrientation.

BackgroundSuggestionState

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

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

boolean

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

SizeSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para height.

widthSuggested

boolean

Indica si hubo un cambio sugerido para width.

NamedStyles

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)

Los estilos con nombre.

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

NamedStyle

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

Representación JSON
{
  "namedStyleType": enum (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

Un cambio sugerido para NamedStyles.

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

object (NamedStyles)

Una 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)

Una máscara que indica cuáles de los campos del NamedStyles base se cambiaron en esta sugerencia.

NamedStylesSuggestionState

Es el estado de sugerencia de un mensaje NamedStyles.

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

object (NamedStyleSuggestionState)

Una máscara que indica cuáles de los campos del NamedStyle correspondiente en styles se cambiaron en esta sugerencia.

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

NamedStyleSuggestionState

Un estado de sugerencia de un mensaje NamedStyle.

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

enum (NamedStyleType)

El tipo de estilo con nombre al que corresponde este estado de sugerencia.

Este campo se proporciona como una ventaja para hacer coincidir NamedStylesuggestionState con su NamedStyle correspondiente.

textStyleSuggestionState

object (TextStyleSuggestionState)

Una máscara que indica cuáles de los campos de text style se cambiaron en esta sugerencia.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Una máscara que indica cuáles de los campos de paragraph style se cambiaron en esta sugerencia.

Lista

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

Representación JSON
{
  "listProperties": {
    object (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))

Los cambios sugeridos para las propiedades de la lista, con clave por ID de sugerencia.

suggestedInsertionId

string

El ID de inserción sugerido. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

Los ID de eliminación sugeridos. Si está vacía, no hay sugerencias de eliminaciones de esta lista.

ListProperties

Las propiedades de una list que describen el aspecto de las viñetas que pertenecen a los párrafos asociados con una lista.

Representación JSON
{
  "nestingLevels": [
    {
      object (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, con un nivel 0 que corresponde al nivel superior y un nivel 8 que corresponde al nivel más anidado. Los niveles de anidación se muestran en orden ascendente, y los menos anidados se muestran primero.

NestingLevel

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

Representación JSON
{
  "bulletAlignment": enum (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 designado para renderizarla.

glyphFormat

string

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, que se reemplazan por los valores adecuados según glyphType o 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 del glifo 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 anidamiento 0 seguido de un punto como sufijo. Por lo tanto, una lista con un tipo de glifo UPPER_ALPHA y el formato de glifo %0. en el nivel de anidamiento 0 dará como resultado una lista con glifos renderizados

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

Para niveles de anidamiento ordenados, la cadena que reemplaza un marcador de posición en formato glifo para un párrafo en particular depende del orden de este dentro de la lista.

indentFirstLine

object (Dimension)

Es la cantidad de sangría para la primera línea de 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 en el lado que corresponde al inicio del texto, según la dirección del contenido del párrafo.

textStyle

object (TextStyle)

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

startNumber

integer

Es el número del primer elemento de lista en este nivel de anidación.

El valor 0 se considera como el valor 1 en las listas con letras y con números romanos. Para valores de 0 y 1, las listas de números romanos y con letras comienzan en a y i, respectivamente.

Este valor se ignora para niveles de anidamiento con glifos desordenados.

Campo de unión glyph_kind. El tipo de glifo que usan las viñetas. Esto define el glifo de viñeta que reemplaza los marcadores de posición en el elemento glyph_format. glyph_kind puede ser solo uno de los siguientes:
glyphType

enum (GlyphType)

Es el tipo de glifo que usan las viñetas cuando se ordenan los párrafos en este nivel de anidamiento.

El tipo de glifo determina qué tipo de glifo se utiliza 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 anidamiento 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 correspondiente al orden de los elementos dentro de la lista.

glyphSymbol

string

Un símbolo de glifo personalizado que se usa para las viñetas cuando los párrafos en este nivel de anidación no están ordenados.

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

BulletAlignment

Los tipos de alineación de una viñeta.

Enumeraciones
BULLET_ALIGNMENT_UNSPECIFIED La alineación de las viñetas no está especificada.
START La viñeta se alinea con el inicio del espacio asignado para la renderización de la viñeta. Alineado a la izquierda para el texto LTR; de lo contrario, alineado a la derecha.
CENTER La viñeta se alinea con el centro del espacio designado para renderizar la viñeta.
END La viñeta se alinea con el final del espacio designado para renderizarla. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda

GlyphType

Son los tipos de glifos que usan las viñetas cuando se ordenan los párrafos en este nivel de anidamiento.

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

SuggestedListProperties

Un cambio sugerido para ListProperties.

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

object (ListProperties)

Una 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)

Una máscara que indica cuáles de los campos del ListProperties base se cambiaron en esta sugerencia.

ListPropertiesSuggestionState

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

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

object (NestingLevelSuggestionState)

Una máscara que indica cuáles de los campos del NestingLevel correspondiente en nestingLevels se cambiaron en esta sugerencia.

Los estados de sugerencia de nivel de anidamiento se muestran en orden ascendente a partir del nivel de anidamiento, con el primer nivel de anidación que se muestra primero.

NestingLevelSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para bulletAlignment.

glyphTypeSuggested

boolean

Indica si hubo un cambio sugerido para glyphType.

glyphFormatSuggested

boolean

Indica si hubo un cambio sugerido para glyphFormat.

glyphSymbolSuggested

boolean

Indica si hubo un cambio sugerido para glyphSymbol.

indentFirstLineSuggested

boolean

Indica si hubo un cambio sugerido para indentFirstLine.

indentStartSuggested

boolean

Indica si hubo un cambio sugerido para indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Una máscara que indica cuáles de los campos de text style se cambiaron en esta sugerencia.

startNumberSuggested

boolean

Indica si hubo un cambio sugerido para startNumber.

NamedRanges

Una colección de todos los NamedRange del documento que comparten un nombre determinado.

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

string

El nombre que comparten todos los named ranges.

namedRanges[]

object (NamedRange)

Son las NamedRange que comparten el mismo nombre.

NamedRange

Una colección de Range con el mismo ID de rango con nombre.

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

Un rango con nombre se crea con un solo Range, y el contenido 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.

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

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

string

El ID del rango con nombre.

name

string

El nombre del rango con nombre.

ranges[]

object (Range)

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 que contiene este rango. Un ID de segmento vacío hace referencia al cuerpo del documento.

startIndex

integer

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

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

endIndex

integer

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

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

tabId

string

La pestaña que contiene este rango. Cuando se omite, la solicitud se aplica a la primera pestaña.

En un documento que contiene una sola pestaña:

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

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

En un documento que contiene varias pestañas:

  • 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

Un 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

El ID de este objeto intercalado. Puede usarse para actualizar las propiedades de un objeto.

inlineObjectProperties

object (InlineObjectProperties)

Son las propiedades de este objeto intercalado.

suggestedInlineObjectPropertiesChanges

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

Los cambios sugeridos para las propiedades del objeto intercalados, con clave por ID de sugerencia.

suggestedInsertionId

string

El ID de inserción sugerido. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

InlineObjectProperties

Propiedades de un InlineObject

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

object (EmbeddedObject)

El objeto incorporado de este objeto intercalado.

EmbeddedObject

Es un objeto incorporado en el documento.

Representación JSON
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (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

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

description

string

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

embeddedObjectBorder

object (EmbeddedObjectBorder)

El borde del objeto incorporado.

size

object (Size)

El tamaño visible de la imagen después de recortarla.

marginTop

object (Dimension)

El margen superior del objeto incorporado.

marginBottom

object (Dimension)

El margen inferior del objeto incorporado.

marginRight

object (Dimension)

El margen derecho del objeto incorporado.

marginLeft

object (Dimension)

El margen izquierdo del objeto incorporado.

linkedContentReference

object (LinkedContentReference)

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

Si no la estableces, el objeto incorporado no estará vinculado.

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

object (EmbeddedDrawingProperties)

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 que se usan para diferenciar el tipo de objeto. Los dibujos incorporados se crean y editan en un documento. Ten en cuenta que no se admiten detalles exhaustivos.

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

Un URI para la imagen con una vida útil predeterminada de 30 minutos. Este URI se etiqueta con la cuenta del solicitante. Cualquier persona con el URI accede de manera efectiva a la imagen como el solicitante original. Si cambia la configuración de uso compartido del documento, es posible que se pierda el acceso a la imagen.

sourceUri

string

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

brightness

number

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

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

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

cropProperties

object (CropProperties)

Las propiedades de recorte de la imagen.

angle

number

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

CropProperties

Son las propiedades de recorte de una imagen.

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

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

number

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

offsetRight

number

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

offsetTop

number

El desplazamiento especifica qué tan lejos 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 lejos se encuentra el borde inferior del rectángulo de recorte del borde inferior del contenido original como una fracción de la altura del contenido original.

angle

number

Á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

Es un borde alrededor de una EmbeddedObject.

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

object (OptionalColor)

El color del borde.

width

object (Dimension)

Es el ancho del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

propertyState

enum (PropertyState)

Es el estado de la propiedad de la frontera.

PropertyState

Son los posibles estados de una propiedad.

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

LinkedContentReference

Es una referencia al contenido de la fuente vinculada externa.

Representación JSON
{

  // Union field 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

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

El ID del gráfico específico en la hoja de cálculo de Hojas de cálculo de Google incorporada.

SuggestedInlineObjectProperties

Un cambio sugerido para InlineObjectProperties.

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

object (InlineObjectProperties)

Una 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)

Una máscara que indica cuáles de los campos del InlineObjectProperties base se cambiaron en esta sugerencia.

InlineObjectPropertiesSuggestionState

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

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

object (EmbeddedObjectSuggestionState)

Una máscara que indica cuáles de los campos de embeddedObject se cambiaron en esta sugerencia.

EmbeddedObjectSuggestionState

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

Representación JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (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)

Una máscara que indica cuáles de los campos de embeddedDrawingProperties se cambiaron en esta sugerencia.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Una máscara que indica cuáles de los campos de imageProperties se cambiaron en esta sugerencia.

titleSuggested

boolean

Indica si hubo un cambio sugerido para title.

descriptionSuggested

boolean

Indica si hubo un cambio sugerido para description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Una máscara que indica cuáles de los campos de embeddedObjectBorder se cambiaron en esta sugerencia.

sizeSuggestionState

object (SizeSuggestionState)

Una máscara que indica cuáles de los campos de size se cambiaron en esta sugerencia.

marginLeftSuggested

boolean

Indica si hubo un cambio sugerido para marginLeft.

marginRightSuggested

boolean

Indica si hubo un cambio sugerido para marginRight.

marginTopSuggested

boolean

Indica si hubo un cambio sugerido para marginTop.

marginBottomSuggested

boolean

Indica si hubo un cambio sugerido para marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Una máscara que indica cuáles de los campos de linkedContentReference se cambiaron en esta sugerencia.

EmbeddedDrawingPropertiesSuggestionState

Este tipo no tiene campos.

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

ImagePropertiesSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para contentUri.

sourceUriSuggested

boolean

Indica si se sugirió un cambio en [sourceUri]. [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

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

contrastSuggested

boolean

Indica si se sugirió un cambio en el [contraste]. [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Indica si se sugirió un cambio para la [transparencia]. [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Una máscara que indica cuáles de los campos de cropProperties se cambiaron en esta sugerencia.

angleSuggested

boolean

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

CropPropertiesSuggestionState

Una máscara que indica cuáles de los campos del CropProperties base se cambiaron en esta sugerencia. Para cualquier campo configurado 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 para offsetLeft.

offsetRightSuggested

boolean

Indica si hubo un cambio sugerido para offsetRight.

offsetTopSuggested

boolean

Indica si hubo un cambio sugerido para offsetTop.

offsetBottomSuggested

boolean

Indica si hubo un cambio sugerido para offsetBottom.

angleSuggested

boolean

Indica si hubo un cambio sugerido para angle.

EmbeddedObjectBorderSuggestionState

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

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

boolean

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

widthSuggested

boolean

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

dashStyleSuggested

boolean

Indica si se sugirió un cambio para [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

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

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

object (SheetsChartReferenceSuggestionState)

Una máscara que indica cuáles de los campos de sheetsChartReference se cambiaron en esta sugerencia.

SheetsChartReferenceSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para spreadsheetId.

chartIdSuggested

boolean

Indica si hubo un cambio sugerido para chartId.

PositionedObject

Es un objeto que está anclado a un Paragraph y posicionado respecto al principio del párrafo. Un objeto 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

El ID de este objeto posicionado.

positionedObjectProperties

object (PositionedObjectProperties)

Son las propiedades de este objeto posicionado.

suggestedPositionedObjectPropertiesChanges

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

Los cambios sugeridos para las propiedades del objeto posicionado, con clave por ID de sugerencia.

suggestedInsertionId

string

El ID de inserción sugerido. Si está vacía, entonces esta no es una inserción sugerida.

suggestedDeletionIds[]

string

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

PositionedObjectProperties

Propiedades de un PositionedObject

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

object (PositionedObjectPositioning)

El posicionamiento de este objeto posicionado en relación con la línea nueva del Paragraph que hace referencia a este objeto posicionado

embeddedObject

object (EmbeddedObject)

El objeto incorporado de este objeto posicionado.

PositionedObjectPositioning

El posicionamiento de un PositionedObject El objeto posicionado se posiciona de manera relativa al comienzo de la Paragraph a la que se conecta.

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

enum (PositionedObjectLayout)

El diseño de este objeto posicionado.

leftOffset

object (Dimension)

El desplazamiento del borde izquierdo del objeto posicionado en relación con el comienzo del Paragraph al que está conectado. La posición exacta del objeto puede depender de otro contenido del documento y del estilo de este.

topOffset

object (Dimension)

El desplazamiento del borde superior del objeto posicionado en relación con el comienzo del Paragraph al que está conectado. La posición exacta del objeto puede depender de otro contenido del documento y del estilo de este.

PositionedObjectLayout

Posibles diseños de un objeto [PositionedObject][google.aps.docs.v1.PositionedObject].

Enumeraciones
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED El diseño no está especificado.
WRAP_TEXT El texto se ajusta al objeto posicionado.
BREAK_LEFT Divide el texto de modo que el objeto posicionado esté a la izquierda y el texto esté a la derecha.
BREAK_RIGHT Divide el texto de modo que el objeto posicionado esté a la derecha y el texto esté a la izquierda.
BREAK_LEFT_RIGHT Rompe el texto de modo que no haya texto a la izquierda o derecha del objeto posicionado.
IN_FRONT_OF_TEXT El objeto posicionado está frente al texto.
BEHIND_TEXT El objeto posicionado está detrás del texto.

SuggestedPositionedObjectProperties

Un cambio sugerido para PositionedObjectProperties.

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

object (PositionedObjectProperties)

Una 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)

Una máscara que indica cuáles de los campos del PositionedObjectProperties base se cambiaron en esta sugerencia.

PositionedObjectPropertiesSuggestionState

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

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

object (PositionedObjectPositioningSuggestionState)

Una máscara que indica cuáles de los campos de positioning se cambiaron en esta sugerencia.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Una máscara que indica cuáles de los campos de embeddedObject se cambiaron en esta sugerencia.

PositionedObjectPositioningSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido para layout.

leftOffsetSuggested

boolean

Indica si hubo un cambio sugerido para leftOffset.

topOffsetSuggested

boolean

Indica si hubo un cambio sugerido para topOffset.

SuggestionsViewMode

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

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

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

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

PREVIEW_SUGGESTIONS_ACCEPTED

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

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

PREVIEW_WITHOUT_SUGGESTIONS El documento que se muestra es una vista previa y todos los cambios sugeridos se rechazan si hay sugerencias.

Métodos

batchUpdate

Aplica una o más actualizaciones al documento.

create

Crea un documento en blanco con el título proporcionado en la solicitud.

get

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