REST Resource: documents

Recurso: Documento

Un archivo de Documentos de Google.

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

string

Solo salida. Es el ID del documento.

title

string

Es el título del documento.

tabs[]

object (Tab)

Son 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. El ID de la revisión del documento. Se puede usar en solicitudes de actualización para especificar a qué revisión de un documento se deben aplicar las actualizaciones y cómo debe comportarse la solicitud si el documento se editó desde esa revisión. Solo se completa si el usuario tiene acceso de edición al documento.

El ID de revisión no es un número secuencial, sino una cadena opaca. El formato del ID de revisión puede cambiar con el tiempo. Se garantiza que un ID de revisión devuelto solo será válido durante 24 horas después de que se devuelva y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre llamadas, significa que el documento no cambió. Por el contrario, un ID modificado (para el mismo documento y usuario) suele significar que el documento se actualizó. Sin embargo, un ID 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, ordenados por ID de encabezado

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, ordenados 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, ordenadas por ID de 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 se establece, 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 se establece, este campo contiene información sobre la primera pestaña del documento.

suggestedDocumentStyleChanges

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

Solo salida. Los cambios sugeridos en el estilo del documento, ordenados 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 se establece, 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 se establece, 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 se establece, 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, ordenados 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

Es una pestaña en un documento.

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

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

object (TabProperties)

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. Es el contenido de la pestaña. Las direcciones (content) solo pueden ser una de las siguientes opciones:
documentTab

object (DocumentTab)

Una pestaña con 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 cambiar 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ío cuando la pestaña actual es de nivel raíz, lo que significa que no tiene ningún elemento 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)

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

headers

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

Los encabezados de la pestaña del documento, ordenados por ID de encabezado

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)

Es 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 nombrados de la pestaña del documento.

suggestedNamedStylesChanges

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

Los cambios sugeridos en los estilos nombrados de la pestaña del documento, ordenados por ID de sugerencia

lists

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

Las listas de la pestaña Documento, ordenadas por ID de lista

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, ordenados 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)

Es 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 de finalización basado en cero de este elemento estructural, exclusivo, en unidades de código UTF-16.

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

object (Paragraph)

Es un tipo de párrafo de elemento estructural.

sectionBreak

object (SectionBreak)

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

table

object (Table)

Un tipo de elemento estructural de tabla.

tableOfContents

object (TableOfContents)

Un elemento estructural de tipo índice.

Párrafo

Un 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, con clave de 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 en la viñeta de este párrafo.

positionedObjectIds[]

string

Los IDs de los objetos posicionados vinculados 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)

Es un elemento de párrafo de referencia de 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.

Los elementos que no sean de texto en la ejecución se reemplazan 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ío, significa que no se trata de una inserción sugerida.

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de 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 a esta ejecución, con clave de ID de sugerencia.

TextStyle

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

Los estilos de texto heredados se representan como campos 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 de texto en un Paragraph hereda del named style type correspondiente del párrafo.
  • El TextStyle en un named style hereda del estilo llamado normal text.
  • El TextStyle del estilo llamado normal text hereda del estilo de texto predeterminado en el editor de Documentos.
  • El TextStyle en un elemento Paragraph que se incluye en una tabla puede heredar su estilo de texto del estilo de la tabla.

Si el estilo de texto no hereda de un elemento superior, si no estableces los campos, el estilo volverá a un valor que coincida con los valores predeterminados del editor de Documentos.

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

backgroundColor

object (OptionalColor)

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

foregroundColor

object (OptionalColor)

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

fontSize

object (Dimension)

Es 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 establece weightedFontFamily, weightedFontFamily#fontFamily también se debe establecer con un valor no vacío. De lo contrario, se muestra un error 400 de solicitud incorrecta.

baselineOffset

enum (BaselineOffset)

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

El texto con compensaciones 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 un color opaco. Si no se establece, 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

Es 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 de 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 en 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 un múltiplo de 100 entre 100 y 900 inclusive. Este rango corresponde a los valores numéricos descritos en la especificación CSS 2.1, sección 15.6, sin valores no numéricos.

El valor predeterminado es 400 ("normal").

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

  • Si el texto está en negrita y el grosor es inferior a 400, el grosor 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 renderizado es igual 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

Es un cambio sugerido en un TextStyle.

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

object (TextStyle)

Un 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 de la TextStyle base se modificaron en esta sugerencia.

TextStyleSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido en 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 en 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 en 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 en baselineOffset.

Texto automático

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

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

enum (Type)

Es el tipo de texto automático.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos. Una AutoText puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, significa que no se trata de 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 Es un tipo de texto automático no especificado.
PAGE_NUMBER Escribe el texto automático que representa el número de página actual.
PAGE_COUNT Escribe para obtener texto automático que represente la cantidad total de páginas del documento.

PageBreak

Un 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 Un PageBreak puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, significa que no se trata de 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 los textos continuos y las referencias de notas al pie, el estilo de texto de un salto de página puede afectar el diseño del contenido, así como el estilo del texto que se inserta junto a él.

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este Salto de página, con clave de ID de sugerencia.

ColumnBreak

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Es el estilo de texto de este ColumnBreak.

Al igual que el contenido de texto, como los textos continuos y las referencias de notas al pie, el estilo de texto de una pausa de columna puede afectar el diseño del contenido, así como 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 ColumnBreak, con clave de ID de sugerencia.

FootnoteReference

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

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

string

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

footnoteNumber

string

El número renderizado 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 IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de 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, que se identifica por el ID de sugerencia.

HorizontalRule

Un ParagraphElement que representa una línea horizontal.

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

string

Los IDs de inserción sugeridos. Una HorizontalRule puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, significa que no se trata de 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 el contenido de texto, como los textos continuos y las referencias de notas al pie, el estilo de texto de una línea horizontal puede afectar el diseño del contenido, así como el estilo del texto que se inserta junto a él.

suggestedTextStyleChanges

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

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

Ecuación

Un ParagraphElement que representa una ecuación.

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

string

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

suggestedDeletionIds[]

string

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

InlineObjectElement

Un ParagraphElement que contiene un InlineObject.

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

string

El ID de las InlineObject que contiene este elemento.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Es el estilo de texto de este InlineObjectElement.

Al igual que el contenido de texto, como los textos y las referencias de notas al pie, el estilo de texto de un elemento de objeto intercalado puede afectar el diseño del contenido y el estilo del texto que se inserta junto a él.

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

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

suggestedDeletionIds[]

string

IDs de las sugerencias que quitan el vínculo de esta persona del documento. Un Person puede tener varios IDs de eliminación si, por ejemplo, varios usuarios sugieren borrarlo. Si está vacío, no se sugerirá que se elimine 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, con clave de ID de sugerencia.

personProperties

object (PersonProperties)

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

PersonProperties

Son 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. Es la dirección de correo electrónico vinculada a esta 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 título del recurso vinculado en el momento de la inserción o la última actualización del vínculo. Este campo siempre está presente.

uri

string

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

mimeType

string

Solo salida. 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 no establecidos 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 un named style hereda del estilo llamado 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 que se incluye en una tabla puede heredar su estilo de párrafo del estilo de la tabla.

Si el estilo de párrafo no hereda de un elemento superior, si no se establecen los campos, el estilo volverá a un valor que coincida con los valores predeterminados del editor de Documentos.

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

string

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

Esta propiedad es de solo lectura.

namedStyleType

enum (NamedStyleType)

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

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

alignment

enum (Alignment)

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

lineSpacing

number

Es la cantidad de espacio entre líneas, como un porcentaje de lo normal, donde lo normal 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)

Es 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 se establece, el valor se hereda del elemento superior.

borderBetween

object (ParagraphBorder)

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

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

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

borderTop

object (ParagraphBorder)

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. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad.

borderBottom

object (ParagraphBorder)

El borde de 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 párrafo que aparece a continuación tiene diferentes propiedades de borde y sangría.

No se pueden actualizar parcialmente los bordes de los párrafos. Al cambiar el borde de un párrafo, el borde nuevo se debe especificar en su totalidad.

borderLeft

object (ParagraphBorder)

El borde que se encuentra 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. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad.

borderRight

object (ParagraphBorder)

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

No se pueden actualizar parcialmente los bordes de los párrafos. Cuando se cambia el borde de un párrafo, se debe especificar el nuevo borde en su totalidad.

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 del párrafo actual. Si no se establece, el valor se hereda del elemento superior.

tabStops[]

object (TabStop)

Es una lista de los puntos de tabulación de este párrafo. La lista de tabulaciones no se hereda.

Esta propiedad es de solo lectura.

keepLinesTogether

boolean

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

keepWithNext

boolean

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

avoidWidowAndOrphan

boolean

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

shading

object (Shading)

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

pageBreakBefore

boolean

Indica si el párrafo actual siempre debe comenzar al principio de una página. Si no se establece, el valor se hereda 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

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 Título 3.
HEADING_4 Título 4.
HEADING_5 Encabezado 5.
HEADING_6 Título 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 está alineado con el inicio de la línea. Se alinea a la izquierda para el texto LTR y a la derecha para el resto de los casos.
CENTER El párrafo está centrado.
END El párrafo está alineado al final de la línea. Se alinea a la derecha para el texto LTR y a la izquierda para el resto de los casos.
JUSTIFIED El párrafo está justificado.

ContentDirection

El contenido de las instrucciones puede fluir.

Enumeraciones
CONTENT_DIRECTION_UNSPECIFIED No se 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 de párrafos.

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

ParagraphBorder

Un borde alrededor de un párrafo.

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

object (OptionalColor)

Es el color del borde.

width

object (Dimension)

Es el ancho del borde.

padding

object (Dimension)

El relleno del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

DashStyle

Son 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 archivos 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 "dot" de ST_PresetLineDashVal de ECMA-376.
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 La alineación del punto de tabulación no está especificada.
START La tabulación está alineada con el inicio de la línea. Esta es la opción predeterminada.
CENTER El punto de tabulación está alineado con el centro de la línea.
END El punto de tabulación está alineado con el final de la línea.

Sombras

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

Un 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 en headingId.

namedStyleTypeSuggested

boolean

Indica si hubo un cambio sugerido para namedStyleType.

alignmentSuggested

boolean

Indica si hubo un cambio sugerido en alignment.

lineSpacingSuggested

boolean

Indica si hubo un cambio sugerido en lineSpacing.

directionSuggested

boolean

Indica si hubo un cambio sugerido en direction.

spacingModeSuggested

boolean

Indica si hubo un cambio sugerido en spacingMode.

spaceAboveSuggested

boolean

Indica si hubo un cambio sugerido 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 en borderBottom.

borderLeftSuggested

boolean

Indica si hubo un cambio sugerido en 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 en indentStart.

indentEndSuggested

boolean

Indica si hubo un cambio sugerido para indentEnd.

keepLinesTogetherSuggested

boolean

Indica si hubo un cambio sugerido en keepLinesTogether.

keepWithNextSuggested

boolean

Indica si hubo un cambio sugerido para keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indica si hubo un cambio sugerido en avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

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

pageBreakBeforeSuggested

boolean

Indica si hubo un cambio sugerido en pageBreakBefore.

ShadingSuggestionState

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

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

boolean

Indica si hubo un cambio sugerido en el 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

Es 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 establecido como verdadero, hay un valor sugerido nuevo.

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

boolean

Indica si hubo un cambio sugerido en listId.

nestingLevelSuggested

boolean

Indica si hubo un cambio sugerido en nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

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

ObjectReferences

Es una colección de IDs de objetos.

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

string

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 sección nueva, y el estilo de la sección se aplica a la sección después del salto.

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

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

string

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

suggestedDeletionIds[]

string

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

sectionStyle

object (SectionStyle)

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

SectionStyle

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

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

object (SectionColumnProperties)

Las propiedades de las columnas de la sección.

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

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

Es el estilo de los separadores de columnas.

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

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400.

contentDirection

enum (ContentDirection)

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

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

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

Cuando se actualiza esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400.

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

marginHeader

object (Dimension)

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

Cuando 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

Es el ID del encabezado predeterminado. Si no se establece, el valor se hereda del SectionStyle SectionBreak's anterior. Si el valor no se establece en el primer SectionBreak, 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 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 falso, los encabezados de las páginas pares usarán el defaultHeaderId. Si no se establece, el valor hereda del SectionStyle SectionBreak's anterior. Si el valor no se establece en el primer SectionBreak, hereda de evenPageHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

pageNumberStart

integer

Es el número de página desde el que se debe comenzar a contar la cantidad de páginas de esta sección. Si no se establece, la numeración de páginas continúa desde la sección anterior. Si no estableces el valor en la primera SectionBreak, consulta la pageNumberStart de DocumentStyle.

Cuando actualizas esta propiedad, es necesario establecer un valor concreto. Si no se establece esta propiedad, se produce un error de solicitud incorrecta 400.

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 StructuralElement que representa una tabla.

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

integer

Cantidad de filas en la tabla.

columns

integer

Cantidad de columnas en la tabla.

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

tableRows[]

object (TableRow)

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ío, significa que no se trata de 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)

Es el estilo de la tabla.

Fila de la tabla

El contenido y el estilo de una fila en un Table

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

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

tableCells[]

object (TableCell)

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

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos Si está vacío, significa que no hay sugerencias de eliminación de 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 en el estilo de la celda de la tabla, ordenados por ID de sugerencia.

TableCellStyle

Es el estilo de un TableCell.

Los estilos de celda de tabla heredados se representan como campos sin configurar en este mensaje. El estilo de una celda de tabla puede heredar el estilo de la tabla.

Representación JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (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

Es el intervalo de columnas de la celda.

Esta propiedad es de solo lectura.

backgroundColor

object (OptionalColor)

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

Es el borde superior de la celda.

borderBottom

object (TableCellBorder)

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

Relleno superior de la celda.

paddingBottom

object (Dimension)

Es el padding inferior de la celda.

contentAlignment

enum (ContentAlignment)

Es la alineación del contenido en la celda de la tabla. La alineación predeterminada 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 una celda de tabla, establece su 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 admitida
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 en un TableCellStyle.

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

object (TableCellStyle)

Un 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 de la TableCellStyle base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.

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

boolean

Indica si hubo un cambio sugerido para rowSpan.

columnSpanSuggested

boolean

Indica si hubo un cambio sugerido en columnSpan.

backgroundColorSuggested

boolean

Indica si hubo un cambio sugerido para backgroundColor.

borderLeftSuggested

boolean

Indica si hubo un cambio sugerido en borderLeft.

borderRightSuggested

boolean

Indica si hubo un cambio sugerido para borderRight.

borderTopSuggested

boolean

Indica si hubo un cambio sugerido en borderTop.

borderBottomSuggested

boolean

Indica si hubo un cambio sugerido en borderBottom.

paddingLeftSuggested

boolean

Indica si hubo un cambio sugerido en paddingLeft.

paddingRightSuggested

boolean

Indica si hubo un cambio sugerido para paddingRight.

paddingTopSuggested

boolean

Indica si hubo un cambio sugerido para paddingTop.

paddingBottomSuggested

boolean

Indica si hubo un cambio sugerido en paddingBottom.

contentAlignmentSuggested

boolean

Indica si hubo un cambio sugerido en 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)

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

tableHeader

boolean

Indica si la fila es un encabezado de tabla.

preventOverflow

boolean

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

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

Son los 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, al igual que en 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)

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

WidthType

Es el tipo de ancho de la columna.

Enumeraciones
WIDTH_TYPE_UNSPECIFIED No se especificó el tipo de ancho de columna.
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 tener en cuenta todas las columnas con anchos especificados.

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

TableOfContents

Un StructuralElement que representa un índice.

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

object (StructuralElement)

Es el contenido del índice.

suggestedInsertionIds[]

string

Los IDs de inserción sugeridos Un TableOfContents puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, significa que no se trata de 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

Nota al pie de un documento.

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

string

Es el ID de la nota al pie.

content[]

object (StructuralElement)

Es el contenido de la nota a pie de página.

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

DocumentStyle

Es el estilo del documento.

Representación JSON
{
  "background": {
    object (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 se establece, no hay un 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 valor para el encabezado en las 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 utiliza 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 se establece, no hay encabezado de primera página.

Esta propiedad es de solo lectura.

pageNumberStart

integer

Es 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á el margen izquierdo de la página en todos los estilos de sección. También puede hacer que el tamaño de las columnas cambie en todas las secciones.

pageSize

object (Size)

Es el tamaño de una página en el 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 invertir las dimensiones de pageSize, lo que permite cambiar la orientación de la página entre vertical y horizontal.

Segundo plano

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 en el DocumentStyle.

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

object (DocumentStyle)

Un 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 de la DocumentStyle base se modificaron en esta sugerencia.

DocumentStyleSuggestionState

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

Representación JSON
{
  "backgroundSuggestionState": {
    object (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 en evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indica si hubo un cambio sugerido en firstPageHeaderId.

pageNumberStartSuggested

boolean

Indica si hubo un cambio sugerido en pageNumberStart.

marginTopSuggested

boolean

Indica si hubo un cambio sugerido para marginTop.

marginBottomSuggested

boolean

Indica si hubo un cambio sugerido para marginBottom.

marginRightSuggested

boolean

Indica si hubo un cambio sugerido en marginRight.

marginLeftSuggested

boolean

Indica si hubo un cambio sugerido en marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Es una máscara que indica cuáles de los campos en [size] [google.apps.docs.v1.DocumentStyle.size] se modificaron en esta sugerencia.

marginHeaderSuggested

boolean

Indica si hubo un cambio sugerido en marginHeader.

flipPageOrientationSuggested

boolean

Opcional. Indica si hubo un cambio sugerido en flipPageOrientation.

BackgroundSuggestionState

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

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

boolean

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

SizeSuggestionState

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

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

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 nombrados.

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 de la NamedStyles base se modificaron en esta sugerencia.

NamedStylesSuggestionState

Es el estado de la sugerencia de un mensaje NamedStyles.

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

object (NamedStyleSuggestionState)

Es 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

Es 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 para facilitar la coincidencia de 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)

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

Lista

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

Representación JSON
{
  "listProperties": {
    object (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 en las propiedades de la lista, ordenados 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 IDs de eliminación sugeridos Si está vacía, significa que no hay eliminaciones sugeridas 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, en los que el nivel 0 corresponde al nivel superior y el nivel 8 corresponde al nivel más anidado. Los niveles de anidación se muestran en orden ascendente, y 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 de glifo contiene uno o más marcadores de posición, que se reemplazan por los valores adecuados según el 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 anidación 0 seguido de un punto como sufijo. Por lo tanto, una lista con un tipo de glifo de UPPER_ALPHA y un formato de glifo de %0. en el nivel de anidamiento 0 generará una lista con glifos renderizados.

A.

B.

C.

El formato de glifo puede contener marcadores de posición para el nivel de anidación actual, 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.

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

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

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

textStyle

object (TextStyle)

Es el estilo de texto de las viñetas en este nivel de anidamiento.

startNumber

integer

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

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. Es el tipo de glifo que usan las viñetas. Esto define el glifo de viñeta que reemplaza los marcadores de posición en 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 anidación.

El tipo de glifo determina el tipo de glifo que se usa para reemplazar los marcadores de posición dentro de glyphFormat cuando se ordenan los párrafos en este nivel de anidación. Por ejemplo, si el nivel de 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 de 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 viñetas no está especificada.
START La viñeta se alinea con el comienzo del espacio asignado para la renderización de la viñeta. Se alinea a la izquierda para el texto LTR y a la derecha para el resto de los casos.
CENTER El viñeta se alinea con el centro del espacio asignado para renderizarlo.
END 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 anidación.

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

SuggestedListProperties

Un cambio sugerido para ListProperties.

Representación JSON
{
  "listProperties": {
    object (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 de la ListProperties base se modificaron 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 de la NestingLevel base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.

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

boolean

Indica si hubo un cambio sugerido en 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 en glyphSymbol.

indentFirstLineSuggested

boolean

Indica si hubo un cambio sugerido en indentFirstLine.

indentStartSuggested

boolean

Indica si hubo un cambio sugerido en indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

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

Los 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 que se inserta dentro de un rango con nombre suele expandir ese rango. Sin embargo, ciertos cambios en el documento pueden hacer que el rango se divida en varios.

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

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

string

Es el ID del rango con nombre.

name

string

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 indica el 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 casos de uso futuros 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 la pestaña única.

  • 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

Es 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. Se puede usar para actualizar las propiedades de un objeto.

inlineObjectProperties

object (InlineObjectProperties)

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

Es el margen superior del objeto incorporado.

marginBottom

object (Dimension)

Es 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 Hojas de cálculo de Google de origen cuando el objeto incorporado es un gráfico vinculado.

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

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

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 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 extensos.

ImageProperties

Son las propiedades de una imagen.

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

string

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

sourceUri

string

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

brightness

number

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

contrast

number

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 que no hay 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 de recorte se representa con compensaciones fraccionarias de los 4 bordes del contenido original.

  • Si el desplazamiento está en el intervalo (0, 1), el borde correspondiente del rectángulo de recorte se ubica dentro del rectángulo de límite original de la imagen.
  • Si el desplazamiento es negativo o superior a 1, el borde correspondiente del rectángulo de recorte se coloca fuera del rectángulo de límite original de la imagen.
  • Si 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 está el borde izquierdo del rectángulo de recorte 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 hacia adentro está el borde superior del rectángulo de recorte del borde superior del contenido original como una fracción de la altura del contenido original.

offsetBottom

number

El desplazamiento especifica qué tan lejos está el borde inferior del rectángulo de recorte del borde inferior del contenido original como una fracción de la altura del contenido original.

angle

number

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

EmbeddedObjectBorder

Un borde alrededor de un EmbeddedObject.

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

object (OptionalColor)

Es el color del borde.

width

object (Dimension)

Es el ancho del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

propertyState

enum (PropertyState)

Es el estado de la propiedad de borde.

PropertyState

Son los estados posibles de una propiedad.

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

LinkedContentReference

Es una referencia al contenido de la fuente 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)

Es una máscara que indica cuáles de los campos de embeddedObject se modificaron 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)

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

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

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

titleSuggested

boolean

Indica si hubo un cambio sugerido 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)

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

marginLeftSuggested

boolean

Indica si hubo un cambio sugerido en marginLeft.

marginRightSuggested

boolean

Indica si hubo un cambio sugerido en marginRight.

marginTopSuggested

boolean

Indica si hubo un cambio sugerido 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 de la EmbeddedDrawingProperties base se modificaron en esta sugerencia. Para cualquier campo establecido como verdadero, hay un valor sugerido nuevo.

ImagePropertiesSuggestionState

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

Representación JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (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 hubo un cambio sugerido en [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

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

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

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

angleSuggested

boolean

Indica si hubo un cambio sugerido 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 establecido como verdadero, hay un valor sugerido nuevo.

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

boolean

Indica si hubo un cambio sugerido en offsetLeft.

offsetRightSuggested

boolean

Indica si hubo un cambio sugerido para offsetRight.

offsetTopSuggested

boolean

Indica si hubo un cambio sugerido en offsetTop.

offsetBottomSuggested

boolean

Indica si hubo un cambio sugerido en offsetBottom.

angleSuggested

boolean

Indica si hubo un cambio sugerido en angle.

EmbeddedObjectBorderSuggestionState

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

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

boolean

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

widthSuggested

boolean

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

dashStyleSuggested

boolean

Indica si 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 establecido como verdadero, hay un valor sugerido nuevo.

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 de la SheetsChartReference base se modificaron en esta sugerencia. Para cualquier campo configurado como verdadero, hay un nuevo valor sugerido.

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

boolean

Indica si hubo un cambio sugerido en spreadsheetId.

chartIdSuggested

boolean

Indica si hubo un cambio sugerido en chartId.

PositionedObject

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

Representación JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (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 ubica en relación con el principio del Paragraph al que está conectado.

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

enum (PositionedObjectLayout)

Es el diseño de este objeto posicionado.

leftOffset

object (Dimension)

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

PositionedObjectLayout

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

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

SuggestedPositionedObjectProperties

Un cambio sugerido para PositionedObjectProperties.

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

object (PositionedObjectProperties)

Un 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 de la PositionedObjectProperties base se modificaron 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)

Es una máscara que indica cuáles de los campos de embeddedObject se modificaron 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 en layout.

leftOffsetSuggested

boolean

Indica si hubo un cambio sugerido para leftOffset.

topOffsetSuggested

boolean

Indica si hubo un cambio sugerido en topOffset.

SuggestionsViewMode

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

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 con todos los cambios sugeridos rechazados si hay alguno.

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.