REST Resource: documents

Recurso: Documento

Un archivo de Documentos de Google

Representación JSON
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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.

body

object (Body)

Solo salida. Es el cuerpo principal del documento.

headers

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

Solo salida. Son los encabezados del documento, codificados por ID de encabezado.

footers

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

Solo salida. Son los pies de página del documento, codificados por el ID del pie de página.

footnotes

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

Solo salida. Son las notas al pie del documento, marcadas por un ID de nota al pie.

documentStyle

object (DocumentStyle)

Solo salida. Es el estilo del documento.

suggestedDocumentStyleChanges

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

Solo salida. Los cambios sugeridos en el estilo del documento, basados en el ID de sugerencia.

namedStyles

object (NamedStyles)

Solo salida. Los estilos con nombre del documento.

suggestedNamedStylesChanges

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

Solo salida. Los cambios sugeridos en los estilos con nombre del documento, con claves según el ID de sugerencia.

lists

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

Solo salida. Son las listas del documento, codificadas por ID de lista.

namedRanges

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

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

revisionId

string

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

El ID de revisión no es un número secuencial, sino una string opaca. El formato del ID de revisión puede cambiar con el tiempo. El ID de revisión que se muestra solo puede ser válido por 24 horas después de que se muestra y no puede compartirse entre usuarios. Si el ID de revisión no se modifica entre llamadas, el documento no se modifica. Por el contrario, un ID modificado (para el mismo documento y el mismo usuario) suele significar que el documento se actualizó. Sin embargo, un ID modificado también puede deberse a factores internos, como cambios de formato de ID.

suggestionsViewMode

enum (SuggestionsViewMode)

Solo salida. El modo de vista de sugerencias aplicado al documento.

Nota: Cuando se edita un documento, los cambios deben basarse en un documento que tenga SUGGESTIONS_INLINE.

inlineObjects

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

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

positionedObjects

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

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

Cuerpo

El cuerpo del documento.

El cuerpo suele incluir el contenido completo del documento, excepto headers, footers y footnotes.

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

object (StructuralElement)

El contenido del cuerpo.

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

Elemento estructural

Un StructuralElement describe el contenido que proporciona estructura al documento.

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

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

integer

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

endIndex

integer

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

Campo de unión content. 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)

Tipo de salto de sección de elemento estructural.

table

object (Table)

Un tipo de tabla de elemento estructural.

tableOfContents

object (TableOfContents)

Un índice de tipo de elemento estructural.

Párrafo

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

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

object (ParagraphElement)

El contenido del párrafo, dividido en sus partes.

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 y depende del ID de sugerencia.

bullet

object (Bullet)

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

suggestedBulletChanges

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

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

positionedObjectIds[]

string

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

suggestedPositionedObjectIds

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

Son los ID de los objetos posicionados que se sugieren que se adjunten a este párrafo, con claves por ID de sugerencia.

Elemento de párrafo

Un ParagraphElement describe el contenido dentro de una Paragraph.

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

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

integer

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

endIndex

integer

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

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

object (TextRun)

Un elemento de párrafo de ejecución de texto.

autoText

object (AutoText)

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

pageBreak

object (PageBreak)

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

columnBreak

object (ColumnBreak)

Un elemento de párrafo de salto de columna.

footnoteReference

object (FootnoteReference)

Un elemento de párrafo de referencia de pie de página

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)

Un elemento de párrafo de objeto intercalado.

person

object (Person)

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

Ejecución de texto

Es un ParagraphElement que representa una serie de textos 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 son de texto en la ejecución se reemplazan por el carácter Unicode U+E907.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones 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, basado en el ID de sugerencia.

TextStyle

Representa el estilo que se puede aplicar al texto.

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

  • 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 con nombre normal text.
  • El TextStyle del estilo con nombre normal text hereda del estilo de texto predeterminado del editor de Documentos.
  • El TextStyle de 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 se hereda de un elemento superior, si anulas la configuración de los campos, se revertirá el estilo a un valor que coincida con los valores predeterminados en el editor de Documentos.

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

boolean

Indica si el texto se renderiza en negrita.

italic

boolean

Si el texto está en cursiva o no.

underline

boolean

Indica si el texto está subrayado o no.

strikethrough

boolean

Indica si el texto ha sido tachado o no.

smallCaps

boolean

Indica si el texto está en letras mayúsculas pequeñas o no.

backgroundColor

object (OptionalColor)

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

foregroundColor

object (OptionalColor)

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

fontSize

object (Dimension)

El tamaño de la fuente del texto

weightedFontFamily

object (WeightedFontFamily)

Es la familia de fuentes y el peso renderizado del texto.

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

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

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

baselineOffset

enum (BaselineOffset)

Desplazamiento vertical del texto desde su posición normal.

El texto con desplazamiento de referencia SUPERSCRIPT o SUBSCRIPT se renderiza automáticamente en un tamaño de fuente más pequeño, calculado según el campo fontSize. Los cambios que realices en este campo no afectarán a fontSize.

Color opcional

Un color que puede ser completamente opaco o completamente transparente.

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

object (Color)

Si se establece, se usará como 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)

El valor de color RGB.

Color de RGB

Un color RGB.

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

number

Componente rojo del color, de 0.0 a 1.0.

green

number

Componente verde del color, de 0.0 a 1.0.

blue

number

Componente azul del color, de 0.0 a 1.0.

Dimensión

Una magnitud en una sola dirección en las unidades especificadas.

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

number

La magnitud.

unit

enum (Unit)

Unidades de magnitud.

Unidad

Unidades de medida.

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

Fuente de la familia con ponderación

Representa una familia de fuentes y el grosor del texto.

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

string

Es la familia de fuentes del texto.

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

weight

integer

El grosor de la fuente. Este campo puede tener cualquier valor que sea múltiplo de 100 entre 100 y 900, ambos incluidos. Este rango corresponde a los valores numéricos descritos en la especificación de CSS 2.1, sección 15.6, con valores no numéricos no permitidos.

El valor predeterminado es 400 ("normal").

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

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

Compensación de referencia

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

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

Estilo de texto sugerido

Se sugiere un cambio en TextStyle.

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

object (TextStyle)

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

textStyleSuggestionState

object (TextStyleSuggestionState)

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

Estado de sugerencia de texto

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

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

boolean

Indica si se sugirió un cambio a bold.

italicSuggested

boolean

Indica si se sugirió un cambio a italic.

underlineSuggested

boolean

Indica si se sugirió un cambio a underline.

strikethroughSuggested

boolean

Indica si se sugirió un cambio a strikethrough.

smallCapsSuggested

boolean

Indica si se sugirió un cambio a smallCaps.

backgroundColorSuggested

boolean

Indica si se sugirió un cambio a backgroundColor.

foregroundColorSuggested

boolean

Indica si se sugirió un cambio a foregroundColor.

fontSizeSuggested

boolean

Indica si se sugirió un cambio a fontSize.

weightedFontFamilySuggested

boolean

Indica si se sugirió un cambio a weightedFontFamily.

baselineOffsetSuggested

boolean

Indica si se sugirió un cambio a baselineOffset.

Texto automático

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

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

enum (Type)

Es el tipo de este texto automático.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

textStyle

object (TextStyle)

El estilo de texto de este AutoText.

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este texto automático, con una clave por ID de sugerencia.

Tipo

Los tipos de texto automático.

Enumeradores
TYPE_UNSPECIFIED Un tipo de texto automático sin especificar.
PAGE_NUMBER Escribe para el texto automático que representa el número de la página actual.
PAGE_COUNT Escribe para el texto automático que representa la cantidad total de páginas del documento.

Salto de página

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

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

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

textStyle

object (TextStyle)

El estilo de texto de este salto de página.

Al igual que ocurre con el contenido de texto, como las ejecuciones de texto y las referencias al pie de página, el estilo de un salto de página puede afectar el diseño del contenido y el estilo 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 por ID de sugerencia.

Salto de columna

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

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

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

textStyle

object (TextStyle)

El estilo de texto de esta ColumnBreak

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

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este ColumnBreak, basado en el ID de sugerencia.

Referencia al pie de página

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

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

string

Es el ID de footnote, que incluye el contenido de esta referencia de nota a pie de página.

footnoteNumber

string

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

textStyle

object (TextStyle)

El estilo de texto de esta FootnoteReference.

suggestedTextStyleChanges

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

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

Regla horizontal

Un objeto ParagraphElement que representa una línea horizontal.

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

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

textStyle

object (TextStyle)

El estilo de texto de esta HorizontalRule.

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

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a esta HorizontalRule, con un ID de sugerencia.

Ecuación

Un objeto ParagraphElement que representa una ecuación.

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

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

ElementoinlineObject

Un objeto ParagraphElement que contiene un elemento InlineObject.

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

string

Es el ID de InlineObject que contiene este elemento.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

textStyle

object (TextStyle)

El estilo de texto de este InlineObjectElement.

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

suggestedTextStyleChanges

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

El estilo de texto sugerido cambia a este objeto InlineObject, que usa el ID de sugerencia.

Person

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

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

string

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

suggestedInsertionIds[]

string

Son los ID de 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 realizada por un usuario diferente, por ejemplo). Si está vacío, el vínculo de esta persona no es una inserción sugerida.

suggestedDeletionIds[]

string

ID de sugerencias para quitar a esta persona del vínculo. Un Person puede tener varios IDs de eliminación si, por ejemplo, varios usuarios sugieren borrarlo. Si está vacío, no se sugiere la eliminación del vínculo de esta persona.

textStyle

object (TextStyle)

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 por ID de sugerencia.

personProperties

object (PersonProperties)

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

Propiedades de persona

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 en la dirección de correo electrónico de la persona.

email

string

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

Propiedades de RichLink

Propiedades específicas de un objeto RichLink.

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

string

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

uri

string

Solo salida. Es el URI de RichLink. Esto siempre está presente.

mimeType

string

Solo salida. El tipo de MIME de RichLink, si hay uno (por ejemplo, cuando se trata de un archivo de Drive)

ParagraphStyle

Estilos que se aplican a un párrafo completo

Los estilos de párrafo heredados se representan como campos sin configurar en este mensaje. El elemento superior de un estilo de párrafo depende de dónde se define su estilo:

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

Si el estilo de párrafo no hereda de un elemento superior, si anula la configuración de los campos, el estilo se revertirá a un valor que coincida con los valores predeterminados en el 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 de encabezado del párrafo. Si está vacío, este párrafo no es un encabezado.

Esta propiedad es de solo lectura.

namedStyleType

enum (NamedStyleType)

El tipo de estilo con nombre del párrafo.

Como la actualización del tipo de estilo con nombre afecta 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

La cantidad de espacio entre las líneas, como un porcentaje de la normal, donde la 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 se establece, el valor predeterminado es LEFT_TO_RIGHT, ya que no se hereda la dirección de párrafo.

spacingMode

enum (SpacingMode)

Es el modo de espaciado para un párrafo.

spaceAbove

object (Dimension)

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

spaceBelow

object (Dimension)

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

borderBetween

object (ParagraphBorder)

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

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo.

borderTop

object (ParagraphBorder)

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

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo.

borderBottom

object (ParagraphBorder)

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

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo.

borderLeft

object (ParagraphBorder)

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo.

borderRight

object (ParagraphBorder)

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Cuando se cambia el borde de un párrafo, el nuevo borde debe especificarse por completo.

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)

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

indentEnd

object (Dimension)

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

tabStops[]

object (TabStop)

Se mostrará una lista de las pestañas 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 mostrarse 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, al menos una parte de este párrafo debe aparecer en la misma página o columna que el párrafo siguiente. Si no la estableces, el valor se heredará del elemento superior.

avoidWidowAndOrphan

boolean

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

shading

object (Shading)

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

pageBreakBefore

boolean

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

Si intentas actualizar pageBreakBefore para párrafos en regiones no admitidas, incluidas Table, Header, Footer y Footnote, se puede generar un estado de documento no válido que muestra un error 400 de solicitud incorrecta.

TipodeEstilodeNombre

Los tipos de estilos con nombre.

Enumeradores
NAMED_STYLE_TYPE_UNSPECIFIED El tipo de estilo con nombre no está especificado.
NORMAL_TEXT Texto normal.
TITLE Título.
SUBTITLE Subtítulos.
HEADING_1 Encabezado 1.
HEADING_2 Encabezado 2.
HEADING_3 Encabezado 3.
HEADING_4 Encabezado 4.
HEADING_5 Encabezado 5.
HEADING_6 Encabezado 6.

Alineación

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

Enumeradores
ALIGNMENT_UNSPECIFIED La alineación del párrafo se hereda del elemento superior.
START El párrafo se alinea con el inicio de la línea. Alineado hacia la izquierda para texto de izquierda a derecha, alineado hacia la derecha.
CENTER El párrafo está centrado.
END El párrafo se alinea con el final de la línea. Alineado a la derecha para texto de izquierda a derecha, a la izquierda, en caso contrario.
JUSTIFIED El párrafo se justifica.

Dirección de contenido

El contenido en el que pueden fluir las instrucciones sobre cómo llegar

Enumeradores
CONTENT_DIRECTION_UNSPECIFIED La dirección del contenido no está especificada.
LEFT_TO_RIGHT El contenido va de izquierda a derecha.
RIGHT_TO_LEFT El contenido va de derecha a izquierda.

Modo spacing

Los diferentes modos para el espaciado de párrafos.

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

Borde de párrafo

Un borde alrededor de un párrafo

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

object (OptionalColor)

El color del borde.

width

object (Dimension)

El ancho del borde.

padding

object (Dimension)

El padding del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

Estilo de guion

Los tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el tipo simple "ST_PresetLineDashVal" descrito en la sección 20.1.10.48 de "Office Open XML File Formats - Fundamentals andMark Language Reference", parte 1 de la cuarta edición 376 del ECMA-376.

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

TabStop

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 parada de pestaña y el margen de inicio.

alignment

enum (TabStopAlignment)

La alineación de esta pestaña se detiene. Si no se establece, el valor predeterminado es START.

TabStopAlignment

Alineación de la tabulación.

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

Sombreado

Sombreado de un párrafo.

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

object (OptionalColor)

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

Estilo de párrafo sugerido

Se sugiere un cambio en ParagraphStyle.

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

object (ParagraphStyle)

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

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

Estado del párrafo de párrafo

Es una máscara que indica cuáles de los campos en el ParagraphStyle base se modificaron 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 se sugirió un cambio a headingId.

namedStyleTypeSuggested

boolean

Indica si se sugirió un cambio a namedStyleType.

alignmentSuggested

boolean

Indica si se sugirió un cambio a alignment.

lineSpacingSuggested

boolean

Indica si se sugirió un cambio a lineSpacing.

directionSuggested

boolean

Indica si se sugirió un cambio a direction.

spacingModeSuggested

boolean

Indica si se sugirió un cambio a spacingMode.

spaceAboveSuggested

boolean

Indica si se sugirió un cambio a spaceAbove.

spaceBelowSuggested

boolean

Indica si se sugirió un cambio a spaceBelow.

borderBetweenSuggested

boolean

Indica si se sugirió un cambio a borderBetween.

borderTopSuggested

boolean

Indica si se sugirió un cambio a borderTop.

borderBottomSuggested

boolean

Indica si se sugirió un cambio a borderBottom.

borderLeftSuggested

boolean

Indica si se sugirió un cambio a borderLeft.

borderRightSuggested

boolean

Indica si se sugirió un cambio a borderRight.

indentFirstLineSuggested

boolean

Indica si se sugirió un cambio a indentFirstLine.

indentStartSuggested

boolean

Indica si se sugirió un cambio a indentStart.

indentEndSuggested

boolean

Indica si se sugirió un cambio a indentEnd.

keepLinesTogetherSuggested

boolean

Indica si se sugirió un cambio a keepLinesTogether.

keepWithNextSuggested

boolean

Indica si se sugirió un cambio a keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indica si se sugirió un cambio a avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Es una máscara que indica cuál de los campos en shading se modificó en esta sugerencia.

pageBreakBeforeSuggested

boolean

Indica si se sugirió un cambio a pageBreakBefore.

Estado de sugerencia de sombra

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

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

boolean

Indica si se sugirió un cambio en Shading.

Viñeta

Describe la viñeta de un párrafo.

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

string

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

nestingLevel

integer

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

textStyle

object (TextStyle)

Es el estilo de texto específico del párrafo aplicado en esta viñeta.

Viñeta sugerida

Se sugiere un cambio en Bullet.

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

object (Bullet)

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

bulletSuggestionState

object (BulletSuggestionState)

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

Estado de viñeta sugerido

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

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

boolean

Indica si se sugirió un cambio en listId.

nestingLevelSuggested

boolean

Indica si se sugirió un cambio en nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuál de los campos en text style se modificó en esta sugerencia.

Referencias de objetos

Una colección de ID de objetos.

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

string

Los ID de objeto.

Salto de sección

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

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

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

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

sectionStyle

object (SectionStyle)

El estilo de la sección después de este salto de sección

Estilo de sección

El estilo que se aplica a una sección.

Representación JSON
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer
}
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 se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

columnSeparatorStyle

enum (ColumnSeparatorStyle)

El estilo de los separadores de columnas.

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

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

contentDirection

enum (ContentDirection)

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

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

marginTop

object (Dimension)

El margen de la parte superior de la sección. Si no se configura, el valor predeterminado de marginTop es DocumentStyle.

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

marginBottom

object (Dimension)

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

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

marginRight

object (Dimension)

El margen derecho de la sección. Si no se configura, el valor predeterminado de marginRight es DocumentStyle. Si actualizas el margen derecho, se cambia el tamaño de las columnas de esta sección. Dado que el margen afecta el ancho de las columnas, se aplica antes que a las propiedades.

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

marginLeft

object (Dimension)

El margen izquierdo de la sección. Si no se configura, el valor predeterminado de marginLeft es DocumentStyle. La actualización del margen izquierdo hace que se cambie el tamaño de las columnas de esta sección. Dado que el margen afecta el ancho de las columnas, se aplica antes que a las propiedades.

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

marginHeader

object (Dimension)

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

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá 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 no se establece el valor en la primera SectionBreak, se hereda de defaultHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

firstPageHeaderId

string

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

Esta propiedad es de solo lectura.

evenPageHeaderId

string

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

Esta propiedad es de solo lectura.

pageNumberStart

integer

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

Cuando se actualiza esta propiedad, se debe establecer un valor concreto. Si anulas la configuración de esta propiedad, se producirá un error 400 de solicitud incorrecta.

Propiedades de la columna de la sección

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)

El padding al final de la columna.

Estilo de separador de columna

El estilo de los separadores de columnas entre columnas.

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

SectionType

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

Enumeradores
SECTION_TYPE_UNSPECIFIED El tipo de sección no está especificado.
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 estilo de cada fila

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

tableStyle

object (TableStyle)

El estilo de la tabla.

TableRow

El contenido y el estilo de una fila en un Table

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (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 final basado en cero de esta fila, exclusivo en unidades de código UTF-16.

tableCells[]

object (TableCell)

El contenido y estilo de cada celda de esta fila

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones 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 a esta fila, marcada por el ID de sugerencia.

TableCell

El contenido y el estilo de una celda en 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

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 de unidades de código UTF-16.

content[]

object (StructuralElement)

El contenido de la celda

tableCellStyle

object (TableCellStyle)

El estilo de la celda.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

suggestedTableCellStyleChanges

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

Los cambios sugeridos en el estilo de celda de la tabla, basados en el ID de sugerencia.

Estilo de celda de tabla

El estilo de un TableCell.

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

El intervalo de columnas de la celda

Esta propiedad es de solo lectura.

backgroundColor

object (OptionalColor)

El color de fondo de la celda

borderLeft

object (TableCellBorder)

Es el borde izquierdo de la celda.

borderRight

object (TableCellBorder)

El borde derecho de la celda.

borderTop

object (TableCellBorder)

El borde superior de la celda

borderBottom

object (TableCellBorder)

El borde inferior de la celda.

paddingLeft

object (Dimension)

Relleno izquierdo de la celda.

paddingRight

object (Dimension)

Relleno derecho de la celda.

paddingTop

object (Dimension)

Relleno superior de la celda.

paddingBottom

object (Dimension)

Relleno inferior de la celda.

contentAlignment

enum (ContentAlignment)

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

Bordecelular

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 la celda de una tabla, establece el ancho en 0.

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

object (OptionalColor)

El color del borde.

Este color no puede ser transparente.

width

object (Dimension)

El ancho del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

Alineación de contenido

Los tipos de alineación del contenido

Derivado de un subconjunto de los valores del tipo simple "ST_TextAnchoringType" de la sección 20.1.10.59 de la sección sobre formatos de archivo XML de Office abiertos - Referencia del lenguaje de marcado y aspectos básicos, parte 1 de ECMA-376 4a edición.

Enumeradores
CONTENT_ALIGNMENT_UNSPECIFIED Alineación de contenido sin especificar. La alineación del contenido se hereda del elemento superior (si existe).
CONTENT_ALIGNMENT_UNSUPPORTED Alineación de contenido no admitida
TOP Alineación que alinea el contenido con la parte superior del titular del contenido. Corresponde a ECT-376 ST_TextAnchoringType 't'.
MIDDLE Alineación que alinea el contenido con el medio del titular del contenido. Corresponde a ECMA-376 ST_TextAnchoringType 'ctr'.
BOTTOM Alineación que alinea el contenido con la parte inferior del titular del contenido. Corresponde a ECMA-376 ST_TextAnchoringType 'b'.

SuggestedTableCellStyle

Se sugiere un cambio en TableCellStyle.

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

object (TableCellStyle)

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

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

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

Estado de celda de sugerencias de la tabla

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

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

boolean

Indica si se sugirió un cambio a rowSpan.

columnSpanSuggested

boolean

Indica si se sugirió un cambio a columnSpan.

backgroundColorSuggested

boolean

Indica si se sugirió un cambio a backgroundColor.

borderLeftSuggested

boolean

Indica si se sugirió un cambio a borderLeft.

borderRightSuggested

boolean

Indica si se sugirió un cambio a borderRight.

borderTopSuggested

boolean

Indica si se sugirió un cambio a borderTop.

borderBottomSuggested

boolean

Indica si se sugirió un cambio a borderBottom.

paddingLeftSuggested

boolean

Indica si se sugirió un cambio a paddingLeft.

paddingRightSuggested

boolean

Indica si se sugirió un cambio a paddingRight.

paddingTopSuggested

boolean

Indica si se sugirió un cambio a paddingTop.

paddingBottomSuggested

boolean

Indica si se sugirió un cambio a paddingBottom.

contentAlignmentSuggested

boolean

Indica si se sugirió un cambio a contentAlignment.

Estilo de fila de la tabla

Estilos que se aplican a una fila de la tabla.

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

object (Dimension)

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

tableHeader

boolean

Indica si la fila es un encabezado de tabla.

preventOverflow

boolean

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

Estilo de fila de la tabla sugerido

Se sugiere un cambio en TableRowStyle.

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

object (TableRowStyle)

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

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

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

Estado de tabla de estilo de fila

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

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

boolean

Indica si se sugirió un cambio a minRowHeight.

Estilo de tabla

Estilos que se aplican a una tabla

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

object (TableColumnProperties)

Las propiedades de cada columna.

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

Propiedades de la columna de la tabla

Las propiedades de una columna en una tabla.

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

enum (WidthType)

El tipo de ancho de la columna.

width

object (Dimension)

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

Tipo de ancho

Es el tipo de ancho de la columna.

Enumeradores
WIDTH_TYPE_UNSPECIFIED El tipo de ancho de columna no está especificado.
EVENLY_DISTRIBUTED

El ancho de la columna se distribuye de manera uniforme entre las otras columnas que se distribuyen de manera uniforme.

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

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

Índice

Un objeto StructuralElement que representa un índice.

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

object (StructuralElement)

El contenido del índice.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

Nota a pie de página

Una nota al pie en un documento.

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

string

Es el ID de la nota al pie.

content[]

object (StructuralElement)

El contenido de la nota al pie

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

DocumentStyle

Es el estilo del documento.

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

object (Background)

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

defaultHeaderId

string

Es el ID del encabezado predeterminado. Si no estableces la política, no habrá un encabezado predeterminado.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

El ID del encabezado que se usa solo para páginas pares. El valor de useEvenPageHeaderFooter determina si se debe usar defaultHeaderId o este valor para el encabezado en páginas pares. Si no la estableces, no habrá un encabezado de página uniforme.

Esta propiedad es de solo lectura.

firstPageHeaderId

string

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

Esta propiedad es de solo lectura.

pageNumberStart

integer

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

marginTop

object (Dimension)

El margen de la parte superior de la página.

La actualización del margen de la página superior en el estilo de documento borra el margen de la página superior en todos los estilos de sección.

marginBottom

object (Dimension)

El margen de la página inferior.

La actualización del margen de la página inferior en el estilo de documento borra el margen de la página inferior en todos los estilos de sección.

marginRight

object (Dimension)

El margen de la página correcto

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

marginLeft

object (Dimension)

El margen de la página ubicado a la izquierda.

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

pageSize

object (Size)

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.

Información general

Representa el fondo de un documento.

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

object (OptionalColor)

El color de fondo

Tamaño

Ancho y alto

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

object (Dimension)

La altura del objeto.

width

object (Dimension)

El ancho del objeto.

Estilo de documento sugerido

Se sugiere un cambio en DocumentStyle.

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

object (DocumentStyle)

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

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

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

Estado de la sugerencia de documento

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

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

object (BackgroundSuggestionState)

Es una máscara que indica cuál de los campos en background se modificó en esta sugerencia.

defaultHeaderIdSuggested

boolean

Indica si se sugirió un cambio a defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indica si se sugirió un cambio a evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indica si se sugirió un cambio a firstPageHeaderId.

pageNumberStartSuggested

boolean

Indica si se sugirió un cambio a pageNumberStart.

marginTopSuggested

boolean

Indica si se sugirió un cambio a marginTop.

marginBottomSuggested

boolean

Indica si se sugirió un cambio a marginBottom.

marginRightSuggested

boolean

Indica si se sugirió un cambio a marginRight.

marginLeftSuggested

boolean

Indica si se sugirió un cambio a marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

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

marginHeaderSuggested

boolean

Indica si se sugirió un cambio a marginHeader.

Estado de sugerencia de fondo

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

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

boolean

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

Estado de la sugerencia de tamaño

Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a height.

widthSuggested

boolean

Indica si se sugirió un cambio a width.

Estilos con nombre

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

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

object (NamedStyle)

Los estilos con nombre.

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

Estilo con nombre

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

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)

El estilo de párrafo de este estilo con nombre.

Sugerencias de nombres con estilos

Se sugiere un cambio en NamedStyles.

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

object (NamedStyles)

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

namedStylesSuggestionState

object (NamedStylesSuggestionState)

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

EstadoDeSugerenciaDeEstiloEstilo

Es el estado de 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 en el 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 de named styles.

EstadoDeSugerenciaDeEstiloDeNombre

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 del NamedStyleSuggestedionState con su NamedStyle correspondiente.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuál de los campos en text style se modificó en esta sugerencia.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Es una máscara que indica cuál de los campos en paragraph style se modificó en esta sugerencia.

Cómo mostrar en lista

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

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

object (ListProperties)

Las propiedades de la lista

suggestedListPropertiesChanges

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

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

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

Propiedades de lista

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 anidación con un nivel de anidamiento 0 que corresponde al nivel superior y un nivel de anidación 8 corresponde al nivel más anidado. Los niveles de anidamiento se muestran en orden ascendente, y el menos anidado se muestra primero.

Nivel de anidación

Contiene propiedades que describen el aspecto de una viñeta de lista en un nivel determinado de 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)

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

glyphFormat

string

La string de formato que usan las viñetas en este nivel de anidación.

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

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

A.

B.

C.

El formato del 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. con un nivel de anidamiento de 0 y un formato de glifo de %0.%1. en un nivel de anidación de 1. Si suponemos que ambos niveles de anidación tienen tipos de glifos de DECIMAL, esto generaría una lista con glifos renderizados

1.

2.

2.1.

2.2.

3.

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

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

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

textStyle

object (TextStyle)

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

startNumber

integer

El número del primer elemento de la lista en este nivel de anidación.

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

Este valor se ignora para anidar niveles con glifos sin ordenar.

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

enum (GlyphType)

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 anidación es 0, la 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 del elemento de la lista dentro de la lista.

glyphSymbol

string

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

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

Alineación de viñetas

Los tipos de alineación de una viñeta

Enumeradores
BULLET_ALIGNMENT_UNSPECIFIED La alineación de la viñeta no está especificada.
START La viñeta se alinea con el inicio del espacio asignado para renderizarla. Alineado hacia la izquierda para texto de izquierda a derecha, alineado hacia la derecha.
CENTER La viñeta está alineada con el centro del espacio asignado para renderizarla.
END La viñeta se alinea con el final del espacio asignado para renderizarla. Alineado a la derecha para texto de izquierda a derecha, a la izquierda, en caso contrario.

Tipo de glifo

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

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

PropiedadesListList

Un cambio sugerido para ListProperties.

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

object (ListProperties)

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

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

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

Estado de la lista de propiedades sugeridas

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

Es una máscara que indica cuáles de los campos en el NestingLevel correspondiente en nestingLevels se cambiaron en esta sugerencia.

Los estados de sugerencia del nivel de anidamiento se muestran en orden ascendente con respecto al nivel de anidamiento que se muestra primero.

Estado de sugerencia de nivel de anidación

Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a bulletAlignment.

glyphTypeSuggested

boolean

Indica si se sugirió un cambio a glyphType.

glyphFormatSuggested

boolean

Indica si se sugirió un cambio a glyphFormat.

glyphSymbolSuggested

boolean

Indica si se sugirió un cambio a glyphSymbol.

indentFirstLineSuggested

boolean

Indica si se sugirió un cambio a indentFirstLine.

indentStartSuggested

boolean

Indica si se sugirió un cambio a indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Es una máscara que indica cuál de los campos en text style se modificó en esta sugerencia.

startNumberSuggested

boolean

Indica si se sugirió un cambio a startNumber.

Rangos con nombre

Una colección de todas las NamedRange en el 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

RangoNombre

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

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

Un rango con nombre se crea con un solo elemento Range, y el contenido insertado dentro de un rango con nombre suele expandirlo. Sin embargo, ciertos cambios en el documento pueden dividir el rango en varios rangos.

Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tengan acceso al documento podrán ver los rangos con nombre.

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

string

El ID del rango con nombre.

name

string

El nombre del rango con nombre.

ranges[]

object (Range)

Los rangos que pertenecen a este rango con nombre.

Rango

Especifica un rango de texto contiguo.

Representación JSON
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer
}
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

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 Int32Value a fin de adaptarse a casos de uso futuros con rangos abiertos.

endIndex

integer

Es el índice final con base 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 Int32Value a fin de adaptarse a casos de uso futuros con rangos abiertos.

Modo de vista de sugerencias

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.

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

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

Las solicitudes para recuperar un documento mediante 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 que acepta todos los cambios sugeridos.

Las solicitudes para recuperar un documento mediante 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 alguna sugerencia en el documento.

Objeto intercalado

Es un objeto que aparece intercalado con 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 a las propiedades del objeto intercalado, codificados por ID de sugerencia.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

Propiedades de objetos intercalados

Propiedades de un InlineObject

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

object (EmbeddedObject)

El objeto incorporado de este objeto intercalado.

Objeto incorporado

Un objeto incorporado en el documento.

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

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

string

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

description

string

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

embeddedObjectBorder

object (EmbeddedObjectBorder)

El borde del objeto incorporado.

size

object (Size)

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

marginTop

object (Dimension)

El margen superior del objeto incorporado.

marginBottom

object (Dimension)

El margen inferior del objeto incorporado.

marginRight

object (Dimension)

El margen derecho del objeto incorporado.

marginLeft

object (Dimension)

El margen izquierdo del objeto incorporado.

linkedContentReference

object (LinkedContentReference)

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

Si no 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)

Las propiedades de un dibujo incorporado

imageProperties

object (ImageProperties)

Las propiedades de una imagen

Propiedades de dibujo incorporadas

Las propiedades de un dibujo incorporado y se usan para diferenciar el tipo de objeto. Un dibujo incorporado es aquel que se crea y edita en un documento. Ten en cuenta que no se admiten todos los detalles.

ImageProperties

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 de 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 solicitante original. Si cambia la configuración de uso compartido del documento, es posible que se pierda el acceso a la imagen.

sourceUri

string

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

brightness

number

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

contrast

number

Efecto de contraste de la imagen El valor debe estar en el intervalo [-1.0, 1.0], donde 0 significa sin efecto.

transparency

number

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

cropProperties

object (CropProperties)

Las propiedades de recorte de la imagen.

angle

number

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

Propiedades de recorte

Las propiedades de recorte de una imagen.

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

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

number

El desplazamiento especifica la distancia hacia el interior del borde izquierdo del rectángulo de recorte desde el borde izquierdo del contenido original como una fracción del ancho del contenido original.

offsetRight

number

El desplazamiento especifica la distancia hacia el interior del borde derecho del rectángulo de recorte desde el borde derecho del contenido original como una fracción del ancho del contenido original.

offsetTop

number

El desplazamiento especifica la distancia hacia el borde superior del rectángulo de recorte desde el borde superior del contenido original como una fracción de la altura del contenido original.

offsetBottom

number

El desplazamiento especifica la distancia hacia el interior del borde inferior del rectángulo de recorte desde el borde inferior del contenido original como una fracción de la altura del contenido original.

angle

number

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

BordeDeObjetoIncorporado

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)

El color del borde.

width

object (Dimension)

El ancho del borde.

dashStyle

enum (DashStyle)

El estilo de guion del borde.

propertyState

enum (PropertyState)

El estado de la propiedad de borde.

EstadoDePropiedad

Los posibles estados de una propiedad.

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

Referencia de contenido vinculado

Una referencia al contenido de la fuente externa vinculada.

Representación JSON
{

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

object (SheetsChartReference)

Una referencia al gráfico vinculado.

Referencia de SheetsChart

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 Google que contiene el gráfico fuente.

chartId

integer

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

Propiedades de objetos intercaladas sugeridas

Un cambio sugerido para InlineObjectProperties.

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

object (InlineObjectProperties)

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

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

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

Estado de las propiedades de objeto intercaladas

Es una máscara que indica cuáles de los campos en el InlineObjectProperties base se modificaron 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ál de los campos en embeddedObject se modificó en esta sugerencia.

Estado de la sugerencia del objeto incorporado

Es una máscara que indica cuáles de los campos en el EmbeddedObject base se modificaron 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ál de los campos en embeddedDrawingProperties se modificó en esta sugerencia.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Es una máscara que indica cuál de los campos en imageProperties se modificó en esta sugerencia.

titleSuggested

boolean

Indica si se sugirió un cambio a title.

descriptionSuggested

boolean

Indica si se sugirió un cambio a description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Es una máscara que indica cuál de los campos en embeddedObjectBorder se modificó en esta sugerencia.

sizeSuggestionState

object (SizeSuggestionState)

Es una máscara que indica cuál de los campos en size se modificó en esta sugerencia.

marginLeftSuggested

boolean

Indica si se sugirió un cambio a marginLeft.

marginRightSuggested

boolean

Indica si se sugirió un cambio a marginRight.

marginTopSuggested

boolean

Indica si se sugirió un cambio a marginTop.

marginBottomSuggested

boolean

Indica si se sugirió un cambio a marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Es una máscara que indica cuál de los campos en linkedContentReference se modificó en esta sugerencia.

Estado de las propiedades de dibujo incorporadas

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

Estado de las propiedades de las imágenes sugeridas

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

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

boolean

Indica si se sugirió un cambio a contentUri.

sourceUriSuggested

boolean

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

brightnessSuggested

boolean

Indica si se sugirió un cambio a [brightness] [google.apps.docs.v1.EmbedObject.brightness].

contrastSuggested

boolean

Indica si se sugirió un cambio a [googlest.docs.v1.EmbedObject.contrast].

transparencySuggested

boolean

Indica si se sugirió un cambio a [transparency] [google.apps.docs.v1.EmbedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Es una máscara que indica cuál de los campos en cropProperties se modificó en esta sugerencia.

angleSuggested

boolean

Indica si se sugirió un cambio a [google.apps.docs.v1.EmbedObject.angle].

Estado de las sugerencias de cultivo

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

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

boolean

Indica si se sugirió un cambio a offsetLeft.

offsetRightSuggested

boolean

Indica si se sugirió un cambio a offsetRight.

offsetTopSuggested

boolean

Indica si se sugirió un cambio a offsetTop.

offsetBottomSuggested

boolean

Indica si se sugirió un cambio a offsetBottom.

angleSuggested

boolean

Indica si se sugirió un cambio a angle.

Estado del borde incorporado de objetos

Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a [color] [google.apps.docs.v1.EmbedBorderObject.color].

widthSuggested

boolean

Indica si se sugirió un cambio para [width] [google.apps.docs.v1.EmbedBorderObject.width].

dashStyleSuggested

boolean

Indica si se sugirió un cambio a [dashStyle] [google.apps.docs.v1.EmbedBorderObject.dash_style].

propertyStateSuggested

boolean

Indica si se sugirió un cambio en [googleState.apps.docs.v1.EmbedBorderObject.property_state].

Estado de referencia de contenido vinculado

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

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

object (SheetsChartReferenceSuggestionState)

Es una máscara que indica cuál de los campos en sheetsChartReference se modificó en esta sugerencia.

Estado de referencia de gráfico de sugerencia

Es una máscara que indica cuáles de los campos en el 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 se sugirió un cambio a spreadsheetId.

chartIdSuggested

boolean

Indica si se sugirió un cambio a chartId.

Posición posicionada

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

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

string

El ID de este objeto posicionado.

positionedObjectProperties

object (PositionedObjectProperties)

Las propiedades de este objeto posicionado

suggestedPositionedObjectPropertiesChanges

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

Los cambios sugeridos en las propiedades de objeto posicionados, marcados por el ID de sugerencia.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no se sugieren eliminaciones de este contenido.

PositionedObjectProperties

Propiedades de un PositionedObject

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

object (PositionedObjectPositioning)

La posición de este objeto posicionado en relación con la nueva línea de Paragraph que hace referencia a este objeto posicionado

embeddedObject

object (EmbeddedObject)

El objeto incorporado de este objeto posicionado

PositionedObjectPositioning

El posicionamiento de un PositionedObject El objeto posicionado se posiciona en relación con el comienzo de la Paragraph a la que está conectado.

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

enum (PositionedObjectLayout)

El diseño de este objeto posicionado

leftOffset

object (Dimension)

El desplazamiento del borde izquierdo del objeto posicionado en relación con el comienzo de la Paragraph a la que se conecta. El posicionamiento exacto del objeto puede depender de otro contenido del documento y del estilo del documento.

topOffset

object (Dimension)

El desplazamiento del borde superior del objeto posicionado en relación con el comienzo de la Paragraph a la que se conecta. El posicionamiento exacto del objeto puede depender de otro contenido del documento y del estilo del documento.

Diseño de objeto posicionado

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

Enumeradores
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED El diseño no está especificado.
WRAP_TEXT El texto se ajusta alrededor del objeto posicionado.
BREAK_LEFT Divide el texto de modo que el objeto posicionado esté a la izquierda y el texto a la derecha.
BREAK_RIGHT Divide el texto de modo que el objeto posicionado se encuentre a la derecha y el texto esté a la izquierda.
BREAK_LEFT_RIGHT Rompe el texto de modo que no haya texto a la izquierda o 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.

PropertiesPositionedObjectProperties

Un cambio sugerido para PositionedObjectProperties.

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

object (PositionedObjectProperties)

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

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

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

PositionedObjectPropertiesSugerenciaionState

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

Es una máscara que indica cuál de los campos en positioning se modificó en esta sugerencia.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Es una máscara que indica cuál de los campos en embeddedObject se modificó en esta sugerencia.

PositionedObjectPositioningSugerenciaionState

Es una máscara que indica cuáles de los campos en el PositionedObjectPositioning base se modificaron 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 se sugirió un cambio a layout.

leftOffsetSuggested

boolean

Indica si se sugirió un cambio a leftOffset.

topOffsetSuggested

boolean

Indica si se sugirió un cambio a topOffset.

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.