REST Resource: documents

Recurso: Documento

Un documento 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. El cuerpo principal del documento.

headers

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

Solo salida. Los encabezados del documento, protegidos por el ID de encabezado.

footers

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

Solo salida. Los pies de página del documento, protegidos por el ID del pie de página.

footnotes

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

Solo salida. Las notas al pie en el documento, marcadas por el ID de la nota al pie.

documentStyle

object (DocumentStyle)

Solo salida. El estilo del documento

suggestedDocumentStyleChanges

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

Solo salida. Los cambios sugeridos para el estilo del documento, protegidos por 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 para los estilos con nombre del documento, protegidos por el ID de sugerencia.

lists

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

Solo salida. Las listas del documento, ordenadas por el ID de lista.

namedRanges

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

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

revisionId

string

Solo salida. El ID de revisión del documento. Se puede usar en las solicitudes de actualización para especificar a qué revisión de un documento 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. Solo se garantiza que un ID de revisión devuelto sea válido durante 24 horas después de haberse mostrado y no se puede compartir entre usuarios. Si el ID de revisión no cambia entre llamadas, el documento no se modifica. Por el contrario, un ID modificado (para el mismo documento y usuario) suele indicar que se actualizó el documento. Sin embargo, los IDs modificados también pueden deberse a factores internos, como modificaciones en el formato de los IDs.

suggestionsViewMode

enum (SuggestionsViewMode)

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

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

inlineObjects

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

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

positionedObjects

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

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

Cuerpo

Es el cuerpo del documento.

Por lo general, el cuerpo incluye 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 del contenido del cuerpo comienzan en cero.

StructuralElement

Un StructuralElement describe el contenido que proporciona estructura al documento.

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

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

integer

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

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

object (Paragraph)

Tipo de párrafo de elemento estructural.

sectionBreak

object (SectionBreak)

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

table

object (Table)

Es un tipo de tabla de elemento estructural.

tableOfContents

object (TableOfContents)

Es un tipo de índice de elemento estructural.

Párrafo

Es una StructuralElement que representa un párrafo. Un párrafo es un rango de contenido que termina con un carácter de 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, desglosado en sus partes componentes.

paragraphStyle

object (ParagraphStyle)

El estilo de este párrafo.

suggestedParagraphStyleChanges

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

El estilo de párrafo sugerido cambia a este, con clave por 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 en 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))

Los ID de los objetos posicionados que se sugieren adjuntar a este párrafo, ordenados por ID de sugerencia.

Elemento de párrafo

Un ParagraphElement describe contenido dentro de un Paragraph.

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

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

integer

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

endIndex

integer

El índice final 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 del 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 del párrafo de salto de página

columnBreak

object (ColumnBreak)

Un elemento del párrafo del salto de columna.

footnoteReference

object (FootnoteReference)

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

horizontalRule

object (HorizontalRule)

Un elemento de párrafo de regla horizontal.

equation

object (Equation)

Elemento de un párrafo de ecuación.

inlineObjectElement

object (InlineObjectElement)

Un elemento de párrafo de objeto intercalado.

person

object (Person)

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

TextRun

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

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

string

Es el texto de esta ejecución.

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Es el estilo de texto de esta ejecución.

suggestedTextStyleChanges

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

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

TextStyle

Representa el estilo que se puede aplicar al texto.

En este mensaje, los estilos de texto heredados se representan como campos sin configurar. El elemento superior de un estilo de texto depende de dónde se defina el estilo de texto:

  • El TextStyle del texto en una 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 de normal text hereda del estilo de texto predeterminado del editor de Documentos.
  • El TextStyle de un elemento Paragraph que se encuentra en una tabla puede heredar su estilo de texto del estilo de tabla.

Si el estilo de texto no se hereda de uno de los elementos superiores, cuando se anula la configuración de campos, se revertirá el estilo a un valor que coincida con los valores predeterminados del editor de Documentos.

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

boolean

Indica si el texto está en negrita o no.

italic

boolean

Indica si el texto está en cursiva o no.

underline

boolean

Indica si el texto está subrayado o no.

strikethrough

boolean

Indica si el texto está tachado o no.

smallCaps

boolean

Indica si el texto está en mayúsculas o no.

backgroundColor

object (OptionalColor)

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

foregroundColor

object (OptionalColor)

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

fontSize

object (Dimension)

Es el tamaño de la fuente del texto.

weightedFontFamily

object (WeightedFontFamily)

Es la familia de fuentes y el grosor representado del texto.

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

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

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

baselineOffset

enum (BaselineOffset)

Desplazamiento vertical del texto con respecto a su posición normal.

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

Color opcional

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 un color opaco. Si no se establece, representará un color transparente.

Color

Un color liso.

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

object (RgbColor)

Es el valor de color RGB.

Color RGB

Un color RGB

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

number

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

green

number

El componente verde del color, de 0.0 a 1.0.

blue

number

El componente azul del color, de 0.0 a 1.0.

Dimensión

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

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

number

La magnitud.

unit

enum (Unit)

Las unidades para magnitud.

Unidad

Unidades de medida.

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

WeightedFontFamily

Representa una familia de fuentes y el grosor del texto.

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

string

La familia de fuentes del texto

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

weight

integer

El grosor de la fuente. Este campo puede tener cualquier valor que sea múltiplo de 100 entre 100 y 900 inclusive. Este rango corresponde a los valores numéricos descritos en la sección 15.6 de la Especificación CSS 2.1, 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 renderizada. Una combinación de 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 la ponderación es mayor o igual que 700, la ponderación renderizada es igual a la ponderación.
  • Si el texto no está en negrita, el grosor renderizado es igual al grosor.

Desfase de referencia

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

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

Estilodetexto sugerido

Es un cambio sugerido para una TextStyle.

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

object (TextStyle)

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

textStyleSuggestionState

object (TextStyleSuggestionState)

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

EstadodeSugerenciadeEstiloTexto

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

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

boolean

Indica si se sugirió un cambio en bold.

italicSuggested

boolean

Indica si se sugirió un cambio en italic.

underlineSuggested

boolean

Indica si se sugirió un cambio en underline.

strikethroughSuggested

boolean

Indica si se sugirió un cambio en strikethrough.

smallCapsSuggested

boolean

Indica si se sugirió un cambio en smallCaps.

backgroundColorSuggested

boolean

Indica si se sugirió un cambio en backgroundColor.

foregroundColorSuggested

boolean

Indica si se sugirió un cambio en foregroundColor.

fontSizeSuggested

boolean

Indica si se sugirió un cambio en fontSize.

weightedFontFamilySuggested

boolean

Indica si se sugirió un cambio en weightedFontFamily.

baselineOffsetSuggested

boolean

Indica si se sugirió un cambio en baselineOffset.

Texto automático

Un elemento ParagraphElement que representa un punto 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 IDs de inserción sugeridos. Un elemento AutoText puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, no es una inserción sugerida.

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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 AutoText, codificado por ID de sugerencia.

Tipo

Los tipos de texto automático.

Enumeradores
TYPE_UNSPECIFIED Un tipo de texto automático no especificado.
PAGE_NUMBER El tipo de texto automático que representa el número de página actual.
PAGE_COUNT El tipo de texto automático que representa la cantidad total de páginas en el documento.

Salto de página

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

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

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

Al igual que el contenido de texto, como las ejecuciones de texto y las referencias de notas al pie, el estilo de texto de un salto de página puede afectar el diseño del contenido y el estilo del texto insertado 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 posterior comience en la parte superior de la siguiente columna.

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

El estilo de texto de este ColumnBreak.

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

suggestedTextStyleChanges

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

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

Referencia de la nota al pie

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

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

string

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

footnoteNumber

string

El número renderizado de esta nota al pie.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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 esta FootnoteReference, codificado por 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 IDs de inserción sugeridos. Un HorizontalRule puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, no es una inserción sugerida.

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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 de notas al pie, el estilo de texto de una regla horizontal puede afectar el diseño del contenido y el estilo del texto insertado junto a ella.

suggestedTextStyleChanges

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

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

Ecuación

Es una ParagraphElement que representa una ecuación.

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

string

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

suggestedDeletionIds[]

string

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

InlineObjectElement

Es un objeto ParagraphElement que contiene un InlineObject.

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

string

El ID de InlineObject que contiene este elemento.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

El estilo de texto de este InlineObjectElement.

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

suggestedTextStyleChanges

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

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

Person

Una persona o dirección de correo electrónico que se menciona en un documento. Estas se comportan como un único 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

ID para 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 (por ejemplo, una sugerencia dentro de una sugerencia realizada por un usuario diferente). Si este campo está vacío, significa que el vínculo de esta persona no es una inserción sugerida.

suggestedDeletionIds[]

string

ID para sugerencias que quitan el vínculo de esta persona del documento. Una Person puede tener varios IDs de eliminación si, por ejemplo, varios usuarios sugieren borrarlo. Si este campo está vacío, no se sugiere borrar este vínculo de persona.

textStyle

object (TextStyle)

Es el estilo de texto de este elemento Person.

suggestedTextStyleChanges

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

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

personProperties

object (PersonProperties)

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

Propiedades personales

Propiedades específicas de un Person vinculado

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

string

Solo salida. Es el nombre de la persona si se muestra en el texto del vínculo en lugar de la dirección de correo electrónico 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 vínculos enriquecidos

Propiedades específicas de un 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 título del recurso vinculado en el momento de la inserción o la última actualización del vínculo. Este campo siempre está presente.

uri

string

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

mimeType

string

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

ParagraphStyle

Estilos que se aplican a un párrafo completo.

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

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

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

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

string

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

Esta propiedad es de solo lectura.

namedStyleType

enum (NamedStyleType)

El tipo de estilo con nombre del párrafo.

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

alignment

enum (Alignment)

La alineación del texto para este párrafo.

lineSpacing

number

La cantidad de espacio entre líneas, como un porcentaje de normal, donde normal se representa como 100.0. Si no se establece, el valor se hereda del elemento superior.

direction

enum (ContentDirection)

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

spacingMode

enum (SpacingMode)

El modo de espaciado del párrafo.

spaceAbove

object (Dimension)

La cantidad de espacio adicional encima del párrafo. Si no se establece, el valor se hereda del elemento superior.

spaceBelow

object (Dimension)

La cantidad de espacio adicional debajo del párrafo. Si no se establece, el valor se hereda del elemento superior.

borderBetween

object (ParagraphBorder)

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

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo.

borderTop

object (ParagraphBorder)

Borde en la parte superior de este párrafo. Si no se establece, el valor se hereda del elemento superior.

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo.

borderBottom

object (ParagraphBorder)

Borde que aparece en la parte inferior de este párrafo. Si no se establece, el valor se hereda del elemento superior.

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo.

borderLeft

object (ParagraphBorder)

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

Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo.

borderRight

object (ParagraphBorder)

Borde a la derecha de este párrafo. Si no se establece, el valor se hereda del elemento superior.

Los bordes de los párrafos no se pueden actualizar parcialmente. Al cambiar el borde de un párrafo, el nuevo borde se debe especificar por completo.

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

La cantidad de sangría para el párrafo en el lado que corresponde al inicio del texto, en función de la dirección actual del párrafo. Si no se establece, el valor se hereda del elemento superior.

indentEnd

object (Dimension)

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

tabStops[]

object (TabStop)

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

Esta propiedad es de solo lectura.

keepLinesTogether

boolean

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

keepWithNext

boolean

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

avoidWidowAndOrphan

boolean

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

shading

object (Shading)

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

pageBreakBefore

boolean

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

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

TipoDeEstiloNombre

Los tipos de estilos con nombre.

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

Alineación

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

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 a la izquierda para texto de izquierda a derecha; de lo contrario, alineado a la derecha
CENTER El párrafo está centrado.
END El párrafo se alinea al final de la línea. Alineado a la derecha para el texto de izquierda a derecha; de lo contrario, alineado a la izquierda
JUSTIFIED El párrafo está justificado.

Dirección de contenido

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

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

Modo de espaciado

Los diferentes modos de espaciado entre párrafos.

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

Borde de párrafo

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)

Estilo de guion del borde

Estilo de Dash

Son los tipos de guiones con los que se puede renderizar la geometría lineal. Estos valores se basan en el tipo simple "ST_PresetLineDashVal" descrito en la sección 20.1.10.48 de "Office Open XML File Formats: Aspectos básicos y referencia del lenguaje de marcado", parte 1 de la 4a edición ECMA-376.

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

Parada de tabulación

Una tabulación en un párrafo.

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

object (Dimension)

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

alignment

enum (TabStopAlignment)

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

TabStopAlignment

La alineación de la tabulación

Enumeradores
TAB_STOP_ALIGNMENT_UNSPECIFIED La alineación de tabulación no está especificada.
START La tabulación está alineada con el inicio de la línea. Esta es la opción predeterminada.
CENTER La tabulación está alineada con el centro de la línea.
END La tabulación está alineada 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 del sombreado de este párrafo

EstiloPárrafo sugerido

Es un cambio sugerido para una ParagraphStyle.

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

object (ParagraphStyle)

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

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

Estado de sugerencia de estilo de párrafo

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

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

boolean

Indica si se sugirió un cambio en headingId.

namedStyleTypeSuggested

boolean

Indica si se sugirió un cambio en namedStyleType.

alignmentSuggested

boolean

Indica si se sugirió un cambio en alignment.

lineSpacingSuggested

boolean

Indica si se sugirió un cambio en lineSpacing.

directionSuggested

boolean

Indica si se sugirió un cambio en direction.

spacingModeSuggested

boolean

Indica si se sugirió un cambio en spacingMode.

spaceAboveSuggested

boolean

Indica si se sugirió un cambio en spaceAbove.

spaceBelowSuggested

boolean

Indica si se sugirió un cambio en spaceBelow.

borderBetweenSuggested

boolean

Indica si se sugirió un cambio en borderBetween.

borderTopSuggested

boolean

Indica si se sugirió un cambio en borderTop.

borderBottomSuggested

boolean

Indica si se sugirió un cambio en borderBottom.

borderLeftSuggested

boolean

Indica si se sugirió un cambio en borderLeft.

borderRightSuggested

boolean

Indica si se sugirió un cambio en borderRight.

indentFirstLineSuggested

boolean

Indica si se sugirió un cambio en indentFirstLine.

indentStartSuggested

boolean

Indica si se sugirió un cambio en indentStart.

indentEndSuggested

boolean

Indica si se sugirió un cambio en indentEnd.

keepLinesTogetherSuggested

boolean

Indica si se sugirió un cambio en keepLinesTogether.

keepWithNextSuggested

boolean

Indica si se sugirió un cambio en keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indica si se sugirió un cambio en avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

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

pageBreakBeforeSuggested

boolean

Indica si se sugirió un cambio en pageBreakBefore.

Estado de sugerencia de sombreado

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

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

boolean

Indica si 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

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

nestingLevel

integer

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

textStyle

object (TextStyle)

El estilo de texto específico del párrafo aplicado a esta viñeta.

Viñeta sugerida

Es un cambio sugerido para una Bullet.

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

object (Bullet)

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

bulletSuggestionState

object (BulletSuggestionState)

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

Estado de sugerencia de viñeta

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

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

boolean

Indica si se sugirió un cambio en listId.

nestingLevelSuggested

boolean

Indica si se sugirió un cambio en nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Una máscara que indica cuáles de los campos de text style se cambiaron 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 nueva sección, 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 IDs de inserción sugeridos. Un SectionBreak puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, no es una inserción sugerida.

suggestedDeletionIds[]

string

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

sectionStyle

object (SectionStyle)

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

Estilo de la 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,
  "flipPageOrientation": boolean
}
Campos
columnProperties[]

object (SectionColumnProperties)

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 actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se mostrará un error 400 de solicitud incorrecta.

columnSeparatorStyle

enum (ColumnSeparatorStyle)

El estilo de los separadores de columna.

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

contentDirection

enum (ContentDirection)

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

marginTop

object (Dimension)

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

marginBottom

object (Dimension)

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

marginRight

object (Dimension)

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

marginLeft

object (Dimension)

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

marginHeader

object (Dimension)

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

sectionType

enum (SectionType)

Solo salida. Es el tipo de sección.

defaultHeaderId

string

El ID del encabezado predeterminado. Si no se establece, se hereda del valor de la sección SectionBreak's anterior. Si no se establece el valor en el primer SliceBreak, se heredará del defaultHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

firstPageHeaderId

string

El ID del encabezado que se utiliza solo para la primera página de la sección. Si el elemento useFirstPageHeaderFooter es verdadero, se usa este valor 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 usará defaultHeaderId. Si no se establece, se hereda del valor de la sección SectionBreak's anterior. Si no se establece el valor en el primer SliceBreak, se heredará del firstPageHeaderId de DocumentStyle.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

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

Esta propiedad es de solo lectura.

pageNumberStart

integer

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

flipPageOrientation

boolean

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

Cuando actualices esta propiedad, debes establecer un valor concreto. Si se anula esta propiedad, se generará un error 400 de solicitud incorrecta.

Propiedades de la columna

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)

Relleno al final de la columna.

Estilo deSeparadordecolumnas

El estilo de los separadores de columna 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 separadora de columnas entre cada columna.

SectionType

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

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

Tabla

Es un objeto StructuralElement que representa una tabla.

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

integer

Cantidad de filas en la tabla.

columns

integer

Cantidad de columnas en la tabla.

Es posible que una tabla no sea rectangular, por lo que algunas filas pueden tener un número de celdas diferente.

tableRows[]

object (TableRow)

El contenido y el estilo de cada fila

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si este campo está vacío, no hay sugerencias de eliminación 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

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

endIndex

integer

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

tableCells[]

object (TableCell)

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

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

tableRowStyle

object (TableRowStyle)

El estilo de la fila de la tabla.

suggestedTableRowStyleChanges

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

El estilo sugerido cambia a esta fila, con clave por ID de sugerencia.

TableCell

El contenido y el estilo de una celda en una 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, en 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 IDs de inserción sugeridos. Un TableCell puede tener varios IDs de inserción si es un cambio sugerido anidado. Si está vacío, no es una inserción sugerida.

suggestedDeletionIds[]

string

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

suggestedTableCellStyleChanges

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

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

Estilo_CeldadeTabla

Es el estilo de un TableCell.

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

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

integer

El intervalo de filas de la celda.

Esta propiedad es de solo lectura.

columnSpan

integer

El intervalo de columnas de la celda.

Esta propiedad es de solo lectura.

backgroundColor

object (OptionalColor)

Color de fondo de la celda.

borderLeft

object (TableCellBorder)

Borde izquierdo de la celda.

borderRight

object (TableCellBorder)

Borde derecho de la celda

borderTop

object (TableCellBorder)

Borde superior de la celda

borderBottom

object (TableCellBorder)

Borde inferior de la celda

paddingLeft

object (Dimension)

Relleno izquierdo de la celda.

paddingRight

object (Dimension)

Relleno derecho de la celda.

paddingTop

object (Dimension)

Relleno superior de la celda.

paddingBottom

object (Dimension)

Relleno inferior de la celda.

contentAlignment

enum (ContentAlignment)

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

Bordedetabla

Borde alrededor de una celda de una tabla.

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

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

object (OptionalColor)

El color del borde

Este color no puede ser transparente.

width

object (Dimension)

El ancho del borde.

dashStyle

enum (DashStyle)

Estilo de guion del borde

Alineación de contenido

Los tipos de alineación de contenido.

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

Enumeradores
CONTENT_ALIGNMENT_UNSPECIFIED Una alineación de contenido no especificada La alineación del contenido se hereda del elemento superior, si existe.
CONTENT_ALIGNMENT_UNSUPPORTED Una alineación de contenido no compatible
TOP Una alineación que alinea el contenido con la parte superior del contenedor de contenido Corresponde a ECMA-376 ST_TextAnchoringType “t”.
MIDDLE Una alineación que alinea el contenido con el centro del contenedor de contenido Corresponde a ECMA-376 ST_TextAnchoringType “ctr”.
BOTTOM Una alineación que alinea el contenido con la parte inferior del contenedor de contenido Corresponde a ECMA-376 ST_TextAnchoringType "b".

SuggestedTableCellStyle

Es un cambio sugerido para una TableCellStyle.

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

object (TableCellStyle)

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

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

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

Estado de sugerencia de estilo de tabla

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

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

boolean

Indica si se sugirió un cambio en rowSpan.

columnSpanSuggested

boolean

Indica si se sugirió un cambio en columnSpan.

backgroundColorSuggested

boolean

Indica si se sugirió un cambio en backgroundColor.

borderLeftSuggested

boolean

Indica si se sugirió un cambio en borderLeft.

borderRightSuggested

boolean

Indica si se sugirió un cambio en borderRight.

borderTopSuggested

boolean

Indica si se sugirió un cambio en borderTop.

borderBottomSuggested

boolean

Indica si se sugirió un cambio en borderBottom.

paddingLeftSuggested

boolean

Indica si se sugirió un cambio en paddingLeft.

paddingRightSuggested

boolean

Indica si se sugirió un cambio en paddingRight.

paddingTopSuggested

boolean

Indica si se sugirió un cambio en paddingTop.

paddingBottomSuggested

boolean

Indica si se sugirió un cambio en paddingBottom.

contentAlignmentSuggested

boolean

Indica si se sugirió un cambio en contentAlignment.

Estilo TableRow

Estilos que se aplican a una fila de tabla.

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

object (Dimension)

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

tableHeader

boolean

Si la fila es un encabezado de tabla

preventOverflow

boolean

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

Estilo FilaTablaSugerida

Es un cambio sugerido para una TableRowStyle.

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

object (TableRowStyle)

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

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

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

Estado de sugerencia de estilo de tabla fila

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

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

boolean

Indica si se sugirió un cambio en 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 HTML. Por lo tanto, las propiedades de una fila se pueden encontrar en el tableRowStyle de la fila.

Propiedades 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 columna se distribuye de manera uniforme entre las demás columnas distribuidas de manera uniforme.

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

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

Tabla de contenidos

Es un objeto StructuralElement que representa un índice.

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

object (StructuralElement)

Es el contenido del índice.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

Nota a pie de página

Una nota al pie del 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

El estilo del documento

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

object (Background)

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

defaultHeaderId

string

El ID del encabezado predeterminado. Si no la estableces, no habrá un encabezado predeterminado.

Esta propiedad es de solo lectura.

evenPageHeaderId

string

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

Esta propiedad es de solo lectura.

firstPageHeaderId

string

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

Esta propiedad es de solo lectura.

pageNumberStart

integer

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

marginTop

object (Dimension)

Margen superior de la página.

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

marginBottom

object (Dimension)

Es el margen inferior de la página.

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

marginRight

object (Dimension)

El margen derecho de la página

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

marginLeft

object (Dimension)

Margen izquierdo de la página.

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

pageSize

object (Size)

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

marginHeader

object (Dimension)

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

flipPageOrientation

boolean

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

Información general

Representa el fondo de un documento.

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

object (OptionalColor)

Color de fondo

Tamaño

El ancho y la altura

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

object (Dimension)

La altura del objeto.

width

object (Dimension)

El ancho del objeto.

SuggestedDocumentStyle

Se sugiere un cambio en DocumentStyle.

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

object (DocumentStyle)

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

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

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

Estado de sugerencia de estilo de documento

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

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

object (BackgroundSuggestionState)

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

defaultHeaderIdSuggested

boolean

Indica si se sugirió un cambio en defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indica si se sugirió un cambio en evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indica si se sugirió un cambio en firstPageHeaderId.

pageNumberStartSuggested

boolean

Indica si se sugirió un cambio en pageNumberStart.

marginTopSuggested

boolean

Indica si se sugirió un cambio en marginTop.

marginBottomSuggested

boolean

Indica si se sugirió un cambio en marginBottom.

marginRightSuggested

boolean

Indica si se sugirió un cambio en marginRight.

marginLeftSuggested

boolean

Indica si se sugirió un cambio en marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Una máscara que indica cuáles de los campos de [tamaño] [google.apps.docs.v1.DocumentStyle.size] se cambiaron en esta sugerencia.

marginHeaderSuggested

boolean

Indica si se sugirió un cambio en marginHeader.

flipPageOrientationSuggested

boolean

Opcional. Indica si se sugirió un cambio en flipPageOrientation.

Estado de sugerencia de fondo

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

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

boolean

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

Estado de SugerenciasDeTamaño

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

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

boolean

Indica si se sugirió un cambio en height.

widthSuggested

boolean

Indica si se sugirió un cambio en width.

EstilosNombre

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

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

object (NamedStyle)

Los estilos con nombre

Hay una entrada para cada una de las named style types posibles.

EstiloNombre

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

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

enum (NamedStyleType)

Es el tipo de este estilo con nombre.

textStyle

object (TextStyle)

El estilo de texto de este estilo con nombre.

paragraphStyle

object (ParagraphStyle)

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

Estilos con nombre sugeridos

Se sugiere un cambio en NamedStyles.

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

object (NamedStyles)

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

namedStylesSuggestionState

object (NamedStylesSuggestionState)

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

EstadodeSugerenciadeEstilosNombre

El estado de sugerencia de un mensaje NamedStyles.

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

object (NamedStyleSuggestionState)

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

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

Estado de sugerencia de estilo con nombre

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 es útil para hacer coincidir el elemento NamedStyleSuggestionState con su NamedStyle correspondiente.

textStyleSuggestionState

object (TextStyleSuggestionState)

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

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

Ir a la lista

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

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

object (ListProperties)

Las propiedades de la lista.

suggestedListPropertiesChanges

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

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

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

Los IDs de eliminación sugeridos. Si está vacío, no hay eliminaciones sugeridas para esta lista.

ListProperties

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

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

object (NestingLevel)

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

Una lista tiene, como máximo, 9 niveles de anidamiento, en el que el nivel de anidamiento 0 corresponde al nivel superior y el nivel 8 de anidación, que corresponde al nivel más anidado. Los niveles de anidación 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 anidamiento.

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)

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

glyphFormat

string

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

El formato de glifo contiene uno o más marcadores de posición, que se reemplazan por los valores adecuados según 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 de 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 por el glifo correspondiente para el nivel de anidamiento 0 seguido de un punto como sufijo. Por lo tanto, una lista con un tipo de glifo UPPER_ALPHA y un formato de glifo %0. en el nivel de anidamiento 0 generará una lista con glifos renderizados.

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

indentFirstLine

object (Dimension)

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

indentStart

object (Dimension)

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

textStyle

object (TextStyle)

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

startNumber

integer

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

El valor igual a 0 se considera un valor de 1 en las listas con letras y con 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 niveles de anidación con glifos desordenados.

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

enum (GlyphType)

Es el tipo de glifo que usan las viñetas cuando los párrafos en este nivel de anidación están ordenados.

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

glyphSymbol

string

Es un símbolo de glifo personalizado que utilizan 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 en glyphFormat. Por ejemplo, si el símbolo glifo es el círculo sólido que corresponde al punto de código Unicode U+25cf y el glyphFormat es %0, el glifo renderizado sería el círculo sólido.

Alineación de viñetas

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

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

Tipo de glifos

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

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 Es 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 con más de un dígito no tienen el prefijo cero.
UPPER_ALPHA Una letra mayúscula, como A, B o C
ALPHA Una letra minúscula, como a, b o c.
UPPER_ROMAN Un número romano en mayúsculas, como I, II o III.
ROMAN Un número romano en minúscula, como i, ii o iii.

SuggestedListProperties

Se sugirió un cambio para ListProperties.

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

object (ListProperties)

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

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

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

Estado de sugerencia de ListProperties

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

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

object (NestingLevelSuggestionState)

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

Los estados de sugerencias del nivel de anidamiento se muestran en orden ascendente con respecto al nivel de anidación, con el menos anidado que se muestra primero.

Estado de sugerencia de nivel de anidación

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

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

boolean

Indica si se sugirió un cambio en bulletAlignment.

glyphTypeSuggested

boolean

Indica si se sugirió un cambio en glyphType.

glyphFormatSuggested

boolean

Indica si se sugirió un cambio en glyphFormat.

glyphSymbolSuggested

boolean

Indica si se sugirió un cambio en glyphSymbol.

indentFirstLineSuggested

boolean

Indica si se sugirió un cambio en indentFirstLine.

indentStartSuggested

boolean

Indica si se sugirió un cambio en indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

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

startNumberSuggested

boolean

Indica si se sugirió un cambio en startNumber.

RangosNombre

Es una colección de todas las NamedRange del documento que comparten un nombre determinado.

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

string

El nombre que comparten todos los named ranges.

namedRanges[]

object (NamedRange)

Los NamedRange que comparten el mismo nombre.

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 forma 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 Range, y el contenido insertado dentro de un rango con nombre generalmente expande ese rango. Sin embargo, ciertos cambios en los documentos pueden hacer que el rango se divida en varios.

Los rangos con nombre no son privados. Todas las aplicaciones y los colaboradores que tienen acceso al documento pueden 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 contiguo de texto.

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

string

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

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

endIndex

integer

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

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

Modo de vista de sugerencias

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

Enumeradores
DEFAULT_FOR_CURRENT_ACCESS El modo 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 con este modo mostrarán un error 403 si el usuario no tiene permiso para ver los cambios sugeridos.

PREVIEW_SUGGESTIONS_ACCEPTED

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

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

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

InlineObject

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

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

inlineObjectProperties

object (InlineObjectProperties)

Las propiedades de este objeto intercalado.

suggestedInlineObjectPropertiesChanges

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

Los cambios sugeridos para las propiedades del objeto intercalados, protegidos por el ID de sugerencia.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

InlineObjectProperties

Propiedades de un InlineObject

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

object (EmbeddedObject)

Es el objeto incorporado de este objeto intercalado.

Objeto incorporado

Es un objeto incorporado en el documento.

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

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

string

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

description

string

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

embeddedObjectBorder

object (EmbeddedObjectBorder)

Borde del objeto incorporado.

size

object (Size)

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

marginTop

object (Dimension)

Es el margen superior del objeto incorporado.

marginBottom

object (Dimension)

Es el margen inferior del objeto incorporado.

marginRight

object (Dimension)

El margen derecho del objeto incorporado

marginLeft

object (Dimension)

Es el margen izquierdo del objeto incorporado.

linkedContentReference

object (LinkedContentReference)

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

Si no la estableces, el objeto incorporado no se vinculará.

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

object (EmbeddedDrawingProperties)

Propiedades de un dibujo incorporado

imageProperties

object (ImageProperties)

Las propiedades de una imagen.

EmbedDrawingProperties

Este tipo no tiene campos.

Son las propiedades de un dibujo incorporado y se usan para diferenciar el tipo de objeto. Un dibujo incorporado es aquel que se crea y edita dentro de un documento. Ten en cuenta que no se admiten muchos 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 para la imagen con una vida útil predeterminada de 30 minutos. Este URI se etiqueta con la cuenta del solicitante. Cualquier persona con el URI accede de manera efectiva a la imagen como el solicitante original. Si cambia la configuración de uso compartido del documento, es posible que se pierda el acceso a la imagen.

sourceUri

string

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

brightness

number

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

contrast

number

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

transparency

number

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

cropProperties

object (CropProperties)

Las propiedades de recorte de la imagen.

angle

number

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

Propiedades de recorte

Las propiedades de recorte de una imagen.

El rectángulo de recorte 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 qué tan lejos se encuentra el borde izquierdo del rectángulo de recorte desde el borde izquierdo del contenido original como una fracción del ancho del contenido original.

offsetRight

number

El desplazamiento especifica qué tan lejos se encuentra el 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 qué tan lejos se encuentra 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 qué tan lejos se encuentra el 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 sentido horario del rectángulo de recorte alrededor de su centro, en radianes. La rotación se aplica después de las compensaciones.

EmbedObjectBorder

Es un borde alrededor de una EmbeddedObject.

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

object (OptionalColor)

El color del borde

width

object (Dimension)

El ancho del borde.

dashStyle

enum (DashStyle)

Estilo de guion del borde

propertyState

enum (PropertyState)

El estado de la propiedad fronteriza.

Estado de propiedad

Los estados posibles 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, entonces el elemento no tiene la propiedad correspondiente cuando se representa en el documento.

ReferenciadelContenidoLinked

Una referencia al contenido fuente vinculado externo.

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 al 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 gráficos de Hojas de cálculo

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

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

string

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

chartId

integer

ID del gráfico específico incorporado en la hoja de cálculo de Google.

SuggestedInlineObjectProperties

Se sugirió un cambio para InlineObjectProperties.

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

object (InlineObjectProperties)

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

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

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

InlineObjectPropertiesSuggestionState

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

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

object (EmbeddedObjectSuggestionState)

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

Estado de sugerencias de objetos incorporados

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

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

object (EmbeddedDrawingPropertiesSuggestionState)

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

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

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

titleSuggested

boolean

Indica si se sugirió un cambio en title.

descriptionSuggested

boolean

Indica si se sugirió un cambio en description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

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

sizeSuggestionState

object (SizeSuggestionState)

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

marginLeftSuggested

boolean

Indica si se sugirió un cambio en marginLeft.

marginRightSuggested

boolean

Indica si se sugirió un cambio en marginRight.

marginTopSuggested

boolean

Indica si se sugirió un cambio en marginTop.

marginBottomSuggested

boolean

Indica si se sugirió un cambio en marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

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

EmbedDrawingPropertiesSuggestionState

Este tipo no tiene campos.

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

Estado de sugerencia de propiedades de la imagen

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

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

boolean

Indica si se sugirió un cambio en contentUri.

sourceUriSuggested

boolean

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

brightnessSuggested

boolean

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

contrastSuggested

boolean

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

transparencySuggested

boolean

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

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

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

angleSuggested

boolean

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

Estado de sugerencia de propiedades de recorte

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

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

boolean

Indica si se sugirió un cambio en offsetLeft.

offsetRightSuggested

boolean

Indica si se sugirió un cambio en offsetRight.

offsetTopSuggested

boolean

Indica si se sugirió un cambio en offsetTop.

offsetBottomSuggested

boolean

Indica si se sugirió un cambio en offsetBottom.

angleSuggested

boolean

Indica si se sugirió un cambio en angle.

EmbedObjectBorderSuggestionState

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

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

boolean

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

widthSuggested

boolean

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

dashStyleSuggested

boolean

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

propertyStateSuggested

boolean

Indica si se sugirió un cambio en [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

Estado de sugerenciasdereferenciadecontenidovinculado

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

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

object (SheetsChartReferenceSuggestionState)

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

Estado de sugerencias de referencia de Hojas de cálculo

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

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

boolean

Indica si se sugirió un cambio en spreadsheetId.

chartIdSuggested

boolean

Indica si se sugirió un cambio en chartId.

PositionedObject

Un objeto que está anclado a un Paragraph y posicionado 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

Es 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 para las propiedades de objetos posicionados, protegidos por el ID de sugerencia.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

PositionedObjectProperties

Propiedades de un PositionedObject

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

object (PositionedObjectPositioning)

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

embeddedObject

object (EmbeddedObject)

Es el objeto incorporado de este objeto posicionado.

PositionedObjectPositioning

Es el posicionamiento de un PositionedObject. El objeto posicionado se posiciona respecto del comienzo del Paragraph al que está anclado.

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

enum (PositionedObjectLayout)

Es el diseño de este objeto posicionado.

leftOffset

object (Dimension)

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

topOffset

object (Dimension)

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

PositionedObjectLayout

Los diseños posibles de un [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 esté a la derecha.
BREAK_RIGHT Divide el texto de modo que el objeto posicionado esté a la derecha y el texto, a la izquierda.
BREAK_LEFT_RIGHT Divide el texto de modo que no haya texto a la izquierda o derecha del objeto posicionado.
IN_FRONT_OF_TEXT El objeto posicionado está delante del texto.
BEHIND_TEXT El objeto posicionado está detrás del texto.

SuggestedPositionedObjectProperties

Se sugirió un cambio para PositionedObjectProperties.

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

object (PositionedObjectProperties)

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

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

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

PositionedObjectPropertiesSuggestionState

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

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

object (PositionedObjectPositioningSuggestionState)

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

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

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

PositionedObjectPositioningSuggestionState

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

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

boolean

Indica si se sugirió un cambio en layout.

leftOffsetSuggested

boolean

Indica si se sugirió un cambio en leftOffset.

topOffsetSuggested

boolean

Indica si se sugirió un cambio en 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 última versión del documento especificado.