Requests

Solicitud

Es una sola actualización que se aplicará a un documento.

Representación JSON 
{

  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  }
}
Campos
Es la solicitud específica que se aplicará. Se requiere exactamente un campo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
replaceAllText

object (ReplaceAllTextRequest)

Reemplaza todas las instancias del texto especificado.

insertText

object (InsertTextRequest)

Inserta texto en la ubicación especificada.

updateTextStyle

object (UpdateTextStyleRequest)

Actualiza el estilo de texto en el rango especificado.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Crea viñetas para los párrafos.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Borra las viñetas de los párrafos.

createNamedRange

object (CreateNamedRangeRequest)

Crea un rango con nombre.

deleteNamedRange

object (DeleteNamedRangeRequest)

Borra un rango con nombre.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Actualiza el estilo de párrafo en el rango especificado.

deleteContentRange

object (DeleteContentRangeRequest)

Borra contenido del documento.

insertInlineImage

object (InsertInlineImageRequest)

Inserta una imagen intercalada en la ubicación especificada.

insertTable

object (InsertTableRequest)

Inserta una tabla en la ubicación especificada.

insertTableRow

object (InsertTableRowRequest)

Inserta una fila vacía en una tabla.

insertTableColumn

object (InsertTableColumnRequest)

Inserta una columna vacía en una tabla.

deleteTableRow

object (DeleteTableRowRequest)

Borra una fila de una tabla.

deleteTableColumn

object (DeleteTableColumnRequest)

Borra una columna de una tabla.

insertPageBreak

object (InsertPageBreakRequest)

Inserta un salto de página en la ubicación especificada.

deletePositionedObject

object (DeletePositionedObjectRequest)

Borra un objeto posicionado del documento.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Actualiza las propiedades de las columnas en una tabla.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Actualiza el diseño de las celdas de la tabla.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Actualiza el estilo de la fila en una tabla.

replaceImage

object (ReplaceImageRequest)

Reemplaza una imagen en el documento.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Actualiza el estilo del documento.

mergeTableCells

object (MergeTableCellsRequest)

Combina celdas en una tabla.

unmergeTableCells

object (UnmergeTableCellsRequest)

Descombina celdas en una tabla.

createHeader

object (CreateHeaderRequest)

Crea un encabezado.

createFootnote

object (CreateFootnoteRequest)

Crea una nota al pie.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Reemplaza el contenido de un rango con nombre.

updateSectionStyle

object (UpdateSectionStyleRequest)

Actualiza el estilo de sección del rango especificado.

insertSectionBreak

object (InsertSectionBreakRequest)

Inserta un salto de sección en la ubicación especificada.

deleteHeader

object (DeleteHeaderRequest)

Borra un encabezado del documento.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Actualiza la cantidad de filas de encabezado fijadas en una tabla.

addDocumentTab

object (AddDocumentTabRequest)

Agrega una pestaña de documento.

deleteTab

object (DeleteTabRequest)

Borra una pestaña de documento.

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

Actualiza las propiedades de una pestaña de documento.

insertPerson

object (InsertPersonRequest)

Inserta una mención de persona.

updateNamedStyle

object (UpdateNamedStyleRequest)

Actualiza un diseño con nombre.

insertDate

object (InsertDateRequest)

Inserta una fecha.

insertComment

object (InsertCommentRequest)

Inserta un CommentThread en el documento.

addCommentReply

object (AddCommentReplyRequest)

Agrega una respuesta a un CommentThread o un SuggestionThread.

updateCommentPost

object (UpdateCommentPostRequest)

Actualiza una publicación existente (publicación principal o respuesta) de un CommentThread o SuggestionThread.

deleteComment

object (DeleteCommentRequest)

Borra un CommentThread.

deleteCommentReply

object (DeleteCommentReplyRequest)

Borra una respuesta Post de un CommentThread o SuggestionThread.

acceptSuggestion

object (AcceptSuggestionRequest)

Acepta una sugerencia.

rejectSuggestion

object (RejectSuggestionRequest)

Rechaza una sugerencia.

deleteSuggestion

object (DeleteSuggestionRequest)

Borra una sugerencia.

Fin de los campos mutuamente excluyentes.

ReplaceAllTextRequest

Reemplaza todas las instancias de texto que coinciden con un criterio por replace text.

Representación JSON 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
Campos
replaceText

string

Es el texto que reemplazará el texto coincidente.

tabsCriteria

object (TabsCriteria)

Opcional. Son los criterios que se usan para especificar en qué pestañas se realiza el reemplazo.

Si se omite, el reemplazo se aplica a todas las pestañas.

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

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

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

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

  • Si se proporciona, el reemplazo se aplica a las pestañas especificadas.

  • Si se omite, el reemplazo se aplica a todas las pestañas.

Son los criterios que se usan para hacer coincidir el texto que se reemplazará. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
containsText

object (SubstringMatchCriteria)

Busca texto en el documento que coincida con esta subcadena.

Fin de los campos mutuamente excluyentes.

SubstringMatchCriteria

Es un criterio que coincide con una cadena de texto específica en el documento.

Representación JSON 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
Campos
text

string

Es el texto que se buscará en el documento.

matchCase

boolean

Indica si la búsqueda debe respetar el uso de mayúsculas y minúsculas:

  • True : La búsqueda distingue mayúsculas de minúsculas.
  • False : La búsqueda no distingue mayúsculas de minúsculas.
searchByRegex

boolean

Opcional. Es verdadero si el valor de búsqueda debe tratarse como una expresión regular. Se debe incluir un escape para cualquier barra inversa que aparezca en el patrón.

  • True : El texto de búsqueda se trata como una expresión regular.
  • False : El texto de búsqueda se trata como una subcadena para la coincidencia.

TabsCriteria

Es un criterio que especifica en qué pestañas se ejecuta una solicitud.

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

string

Es la lista de IDs de pestañas en las que se ejecuta la solicitud.

InsertTextRequest

Inserta texto en la ubicación especificada.

Representación JSON 
{
  "text": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
text

string

Es el texto que se insertará.

Si insertas un carácter de salto de línea, se creará implícitamente un nuevo Paragraph en ese índice. El estilo de párrafo del párrafo nuevo se copiará del párrafo en el índice de inserción actual, incluidas las listas y las viñetas.

Los estilos de texto para el texto insertado se determinarán automáticamente y, por lo general, se conservará el estilo del texto adyacente. En la mayoría de los casos, el estilo de texto del texto insertado coincidirá con el texto que se encuentra inmediatamente antes del índice de inserción.

Algunos caracteres de control (U+0000 a U+0008, U+000C a U+001F) y caracteres del área de uso privado del plano multilingüe básico de Unicode (U+E000 a U+F8FF) se quitarán del texto insertado.

Ubicación en la que se insertará el texto. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta el texto en un índice específico del documento.

El texto debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar texto en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior). El texto debe insertarse en el párrafo anterior.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta el texto al final de un encabezado, pie de página, nota al pie o el cuerpo del documento.

Fin de los campos mutuamente excluyentes.

Ubicación

Es una ubicación específica en el documento.

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

string

Es el ID del encabezado, el pie de página o la nota al pie en la que se encuentra la ubicación. Un ID de segmento vacío significa el cuerpo del documento.

index

integer

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

El índice es relativo al comienzo del segmento especificado por segmentId.

tabId

string

Es la pestaña en la que se encuentra la ubicación. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

EndOfSegmentLocation

Ubicación al final de un cuerpo, encabezado, pie de página o nota al pie. La ubicación se encuentra inmediatamente antes del último salto de línea en el segmento del documento.

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

string

Es el ID del encabezado, el pie de página o la nota al pie en la que se encuentra la ubicación. Un ID de segmento vacío significa el cuerpo del documento.

tabId

string

Es la pestaña en la que se encuentra la ubicación. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

UpdateTextStyleRequest

Actualiza el diseño del texto.

Representación JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
Campos
textStyle

object (TextStyle)

Son los estilos que se aplicarán al texto.

Si el valor de un diseño en particular coincide con el del diseño principal, se configurará ese diseño para que herede el diseño principal.

Algunos cambios en el estilo del texto pueden provocar otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de TextStyle para obtener más información.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz textStyle es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar el estilo de texto a negrita, configura fields en "bold".

Para restablecer una propiedad a su valor predeterminado, incluye su nombre de campo en la máscara de campo, pero deja el campo sin configurar.

Es el tipo de rango que se usa en el que se actualizará el estilo de texto. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
range

object (Range)

Es el rango de texto al que se le aplicará un estilo.

El rango se puede extender para incluir saltos de línea adyacentes.

Si el rango contiene por completo un párrafo que pertenece a una lista, la viñeta del párrafo también se actualiza con el estilo de texto coincidente.

No se pueden insertar rangos dentro de un UpdateTextStyleRequest relativo.

Fin de los campos mutuamente excluyentes.

CreateParagraphBulletsRequest

Crea viñetas para todos los párrafos que se superponen con el rango determinado.

El nivel de anidación de cada párrafo se determinará contando las tabulaciones iniciales delante de cada párrafo. Para evitar el exceso de espacio entre la viñeta y el párrafo correspondiente, esta solicitud quita estas tabulaciones iniciales. Esto puede cambiar los índices de las partes del texto.

Si el párrafo inmediatamente anterior a los párrafos que se actualizan está en una lista con un ajuste predeterminado coincidente, los párrafos que se actualizan se agregan a esa lista anterior.

Representación JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Campos
range

object (Range)

Es el rango al que se aplicará el ajuste predeterminado de viñetas.

bulletPreset

enum (BulletGlyphPreset)

Son los tipos de glifos de viñetas que se usarán.

BulletGlyphPreset

Son patrones predeterminados de glifos de viñetas para listas.

Estos patrones usan los siguientes tipos de viñetas:

  • ARROW : Una flecha, que corresponde a un punto de código Unicode U+2794
  • ARROW3D : Una flecha con sombreado en 3D, que corresponde a un punto de código Unicode U+27a2
  • CHECKBOX : Un cuadrado hueco, que corresponde a un punto de código Unicode U+274f
  • CIRCLE : Un círculo hueco, correspondiente a un punto de código Unicode U+25cb
  • DIAMOND : Un diamante sólido, que corresponde a un punto de código Unicode U+25c6
  • DIAMONDX : Un diamante con una "X", que corresponde a un punto de código Unicode U+2756
  • HOLLOWDIAMOND : Un diamante hueco, que corresponde a un punto de código Unicode U+25c7
  • DISC : Un círculo sólido, correspondiente a un punto de código Unicode U+25cf
  • SQUARE : Un cuadrado sólido, que corresponde a un punto de código Unicode U+25a0
  • STAR : Una estrella, que corresponde a un punto de código Unicode U+2605
  • ALPHA : Una letra en minúscula, como "a", "b" o "c".
  • UPPERALPHA : Una letra mayúscula, como "A", "B" o "C".
  • DECIMAL : Un número, como "1", "2" o "3".
  • ZERODECIMAL : Es un número en el que los números de un solo dígito tienen un cero como prefijo, como "01", "02" o "03". Los números con más de un dígito no tienen un cero como prefijo.
  • ROMAN : Es un número romano en minúsculas, como "i", "ii" o "iii".
  • UPPERROMAN : Un número romano en mayúsculas, como "I", "II" o "III".
  • LEFTTRIANGLE : Un triángulo que apunta hacia la izquierda, correspondiente a un punto de código Unicode U+25c4
Enums
BULLET_GLYPH_PRESET_UNSPECIFIED El ajuste predeterminado del glifo de viñeta no está especificado.
BULLET_DISC_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta DISC, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de la lista.
BULLET_DIAMONDX_ARROW3D_SQUARE Una lista con viñetas con un glifo de viñeta DIAMONDX, ARROW3D y SQUARE para los primeros 3 niveles de anidamiento de la lista.
BULLET_CHECKBOX Una lista con viñetas que incluye CHECKBOX glifos de viñetas para todos los niveles de anidación de la lista.
BULLET_ARROW_DIAMOND_DISC Una lista con viñetas con un glifo de viñeta ARROW, DIAMOND y DISC para los primeros 3 niveles de anidamiento de la lista.
BULLET_STAR_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta STAR, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de la lista.
BULLET_ARROW3D_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta ARROW3D, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de la lista.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Una lista con viñetas con un glifo de viñeta LEFTTRIANGLE, DIAMOND y DISC para los primeros 3 niveles de anidamiento de la lista.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Una lista con viñetas con un glifo de viñeta DIAMONDX, HOLLOWDIAMOND y SQUARE para los primeros 3 niveles de anidamiento de la lista.
BULLET_DIAMOND_CIRCLE_SQUARE Una lista con viñetas con un glifo de viñeta DIAMOND, CIRCLE y SQUARE para los primeros 3 niveles de anidamiento de la lista.
NUMBERED_DECIMAL_ALPHA_ROMAN Una lista numerada con glifos numéricos DECIMAL, ALPHA y ROMAN para los primeros 3 niveles de anidamiento de la lista, seguidos de puntos.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Una lista numerada con DECIMAL, ALPHA y ROMAN glifos numéricos para los primeros 3 niveles de anidamiento de la lista, seguidos de paréntesis.
NUMBERED_DECIMAL_NESTED Una lista numerada con DECIMAL glifos numéricos separados por puntos, en la que cada nivel de anidación usa el glifo del nivel de anidación anterior como prefijo. Por ejemplo, "1.". '1.1.', '2.', "2.2".
NUMBERED_UPPERALPHA_ALPHA_ROMAN Una lista numerada con glifos numéricos UPPERALPHA, ALPHA y ROMAN para los primeros 3 niveles de anidamiento de la lista, seguidos de puntos.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Una lista numerada con glifos numéricos UPPERROMAN, UPPERALPHA y DECIMAL para los primeros 3 niveles de anidamiento de la lista, seguidos de puntos.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Una lista numerada con glifos numéricos ZERODECIMAL, ALPHA y ROMAN para los primeros 3 niveles de anidamiento de la lista, seguidos de puntos.

DeleteParagraphBulletsRequest

Borra las viñetas de todos los párrafos que se superponen con el rango determinado.

El nivel de anidación de cada párrafo se conservará visualmente agregando una sangría al comienzo del párrafo correspondiente.

Representación JSON 
{
  "range": {
    object (Range)
  }
}
Campos
range

object (Range)

Es el rango del que se borrarán las viñetas.

CreateNamedRangeRequest

Crea un objeto NamedRange que hace referencia al rango determinado.

Representación JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
Campos
name

string

Es el nombre del rango con nombre. No es necesario que los nombres sean únicos.

Los nombres deben tener al menos 1 carácter y no más de 256, medidos en unidades de código UTF-16.

range

object (Range)

Es el rango al que se aplicará el nombre.

DeleteNamedRangeRequest

Borra un NamedRange.

Representación JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "namedRangeId": string,
  "name": string
}
Campos
tabsCriteria

object (TabsCriteria)

Opcional. Son los criterios que se usan para especificar en qué pestañas se debe realizar el borrado del rango. Si se omite, el borrado del rango se aplica a todas las pestañas.

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

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

  • Si se omite, el borrado del rango se aplica a la pestaña única.

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

  • Si se proporciona, el borrado del rango se aplica a las pestañas especificadas.

  • Si no se proporciona, el borrado del rango se aplica a todas las pestañas.

Es el valor que determina qué rango o rangos se deben borrar. Se debe configurar exactamente uno. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
namedRangeId

string

Es el ID del rango con nombre que se borrará.

name

string

Nombre de los rangos que se borrarán. Se borrarán todos los rangos con nombres que tengan el nombre determinado.

Fin de los campos mutuamente excluyentes.

UpdateParagraphStyleRequest

Actualiza el diseño de todos los párrafos que se superponen con el rango determinado.

Representación JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
Campos
paragraphStyle

object (ParagraphStyle)

Son los diseños que se establecerán en los párrafos.

Algunos cambios en el estilo de párrafo pueden provocar otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de ParagraphStyle para obtener más información.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz paragraphStyle es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar la propiedad de alineación del estilo de párrafo, establece fields en "alignment".

Para restablecer una propiedad a su valor predeterminado, incluye su nombre de campo en la máscara de campo, pero deja el campo sin configurar.

Es el tipo de rango que se usa cuando se actualizará el estilo de párrafo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
range

object (Range)

Es el rango que se superpone con los párrafos a los que se les aplicará un diseño.

Fin de los campos mutuamente excluyentes.

DeleteContentRangeRequest

Borra contenido del documento.

Representación JSON 
{
  "range": {
    object (Range)
  }
}
Campos
range

object (Range)

Es el rango de contenido que se borrará.

Borrar texto que cruza el límite de un párrafo puede generar cambios en los estilos de párrafo, las listas, los objetos posicionados y los marcadores, ya que los dos párrafos se combinan.

Si intentas borrar ciertos rangos, es posible que se genere una estructura de documento no válida, en cuyo caso se devolverá un error 400 de solicitud incorrecta.

Estos son algunos ejemplos de solicitudes de eliminación no válidas:

InsertInlineImageRequest

Inserta un objeto InlineObject que contiene una imagen en la ubicación determinada.

Representación JSON 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
uri

string

Es el URI de la imagen.

La imagen se recupera una vez en el momento de la inserción y se almacena una copia para mostrarla dentro del documento. Las imágenes deben pesar menos de 50 MB, no pueden superar los 25 megapíxeles y deben estar en formato PNG, JPEG o GIF.

El URI proporcionado debe ser de acceso público y tener una longitud máxima de 2 kB. El URI en sí se guarda con la imagen y se expone a través del campo ImageProperties.content_uri.

objectSize

object (Size)

Es el tamaño con el que debe aparecer la imagen en el documento. Esta propiedad es opcional, y el tamaño final de la imagen en el documento se determina según las siguientes reglas: * Si no se especifican el ancho ni la altura, se calcula un tamaño predeterminado de la imagen según su resolución. * Si se especifica una dimensión, la otra se calcula para conservar la relación de aspecto de la imagen. * Si se especifican el ancho y la altura, la imagen se ajusta para que quepa dentro de las dimensiones proporcionadas y, al mismo tiempo, se mantiene su relación de aspecto.

Ubicación en la que se insertará la imagen. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta la imagen en un índice específico del documento.

La imagen debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior).

Las imágenes intercaladas no se pueden insertar dentro de una nota al pie o una ecuación.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta el texto al final de un encabezado, un pie de página o el cuerpo del documento.

Las imágenes intercaladas no se pueden insertar dentro de una nota al pie.

Fin de los campos mutuamente excluyentes.

InsertTableRequest

Inserta una tabla en la ubicación especificada.

Se insertará un carácter de salto de línea antes de la tabla insertada.

Representación JSON 
{
  "rows": integer,
  "columns": integer,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
rows

integer

Es la cantidad de filas de la tabla.

columns

integer

Es la cantidad de columnas de la tabla.

Ubicación en la que se insertará la tabla. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta la tabla en un índice de modelo específico.

Se insertará un carácter de nueva línea antes de la tabla insertada, por lo que el índice de inicio de la tabla estará en el índice de ubicación especificado + 1.

La tabla debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre una tabla existente y su párrafo anterior).

No se pueden insertar tablas dentro de una nota al pie o una ecuación.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta la tabla al final del encabezado, el pie de página o el cuerpo del documento especificados. Se insertará un carácter de salto de línea antes de la tabla insertada.

No se pueden insertar tablas dentro de una nota al pie.

Fin de los campos mutuamente excluyentes.

InsertTableRowRequest

Inserta una fila vacía en una tabla.

Representación JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Campos
tableCellLocation

object (TableCellLocation)

Es la ubicación de la celda de la tabla de referencia desde la que se insertarán las filas.

Se insertará una fila nueva arriba (o debajo) de la fila en la que se encuentra la celda de referencia. Si la celda de referencia es una celda combinada, se insertará una fila nueva arriba (o debajo) de la celda combinada.

insertBelow

boolean

Indica si se debe insertar una fila nueva debajo de la ubicación de la celda de referencia.

  • True : Se inserta debajo de la celda.
  • False : Se inserta sobre la celda.

TableCellLocation

Ubicación de una sola celda dentro de una tabla.

Representación JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Campos
tableStartLocation

object (Location)

Es la ubicación donde comienza la tabla en el documento.

rowIndex

integer

Índice de fila basado en cero. Por ejemplo, la segunda fila de la tabla tiene un índice de fila de 1.

columnIndex

integer

Índice de columna basado en cero. Por ejemplo, la segunda columna de la tabla tiene un índice de columna de 1.

InsertTableColumnRequest

Inserta una columna vacía en una tabla.

Representación JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Campos
tableCellLocation

object (TableCellLocation)

Ubicación de la celda de la tabla de referencia desde la que se insertarán las columnas.

Se insertará una columna nueva a la izquierda (o a la derecha) de la columna en la que se encuentra la celda de referencia. Si la celda de referencia es una celda combinada, se insertará una columna nueva a la izquierda (o a la derecha) de la celda combinada.

insertRight

boolean

Indica si se debe insertar una columna nueva a la derecha de la ubicación de la celda de referencia.

  • True : Inserta a la derecha.
  • False : Inserta a la izquierda.

DeleteTableRowRequest

Borra una fila de una tabla.

Representación JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableCellLocation

object (TableCellLocation)

Ubicación de la celda de la tabla de referencia desde la que se borrará la fila.

Se borrará la fila que abarca esta celda. Si se trata de una celda combinada que abarca varias filas, se borrarán todas las filas que abarque la celda. Si no quedan filas en la tabla después de esta eliminación, se borrará toda la tabla.

DeleteTableColumnRequest

Borra una columna de una tabla.

Representación JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableCellLocation

object (TableCellLocation)

Ubicación de la celda de la tabla de referencia desde la que se borrará la columna.

Se borrará la columna que abarca esta celda. Si se trata de una celda combinada que abarca varias columnas, se borrarán todas las columnas que abarca la celda. Si no quedan columnas en la tabla después de esta eliminación, se borra toda la tabla.

InsertPageBreakRequest

Inserta un salto de página seguido de un salto de línea en la ubicación especificada.

Representación JSON 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
Ubicación en la que se insertará el salto de página. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta el salto de página en un índice específico del documento.

El salto de página debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior).

No se pueden insertar saltos de página dentro de una tabla, una ecuación, una nota al pie, un encabezado o un pie de página. Como los saltos de página solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta el salto de página al final del cuerpo del documento.

Los saltos de página no se pueden insertar dentro de una nota al pie, un encabezado o un pie de página. Como los saltos de página solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

Fin de los campos mutuamente excluyentes.

DeletePositionedObjectRequest

Borra un objeto PositionedObject del documento.

Representación JSON 
{
  "objectId": string,
  "tabId": string
}
Campos
objectId

string

Es el ID del objeto posicionado que se borrará.

tabId

string

Es la pestaña en la que se encuentra el objeto posicionado que se borrará. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

UpdateTableColumnPropertiesRequest

Actualiza el TableColumnProperties de las columnas en una tabla.

Representación JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Campos
tableStartLocation

object (Location)

Es la ubicación donde comienza la tabla en el documento.

columnIndices[]

integer

Es la lista de índices de columna basados en cero cuya propiedad se debe actualizar. Si no se especifican índices, se actualizarán todas las columnas.

tableColumnProperties

object (TableColumnProperties)

Son las propiedades de la columna de la tabla que se actualizarán.

Si el valor de tableColumnProperties#width es inferior a 5 puntos (5/72 pulgadas), se devuelve un error 400 de solicitud incorrecta.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tableColumnProperties es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar el ancho de la columna, establece fields en "width".

UpdateTableCellStyleRequest

Actualiza el estilo de un rango de celdas de la tabla.

Representación JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
Campos
tableCellStyle

object (TableCellStyle)

Es el estilo que se establecerá en las celdas de la tabla.

Cuando se actualizan los bordes, si una celda comparte un borde con una celda adyacente, también se actualiza la propiedad de borde correspondiente de la celda adyacente. No se actualizan los bordes combinados ni los invisibles.

Dado que actualizar un borde compartido por celdas adyacentes en la misma solicitud puede causar actualizaciones de bordes en conflicto, las actualizaciones de bordes se aplican en el siguiente orden:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tableCellStyle es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar el color de fondo de la celda de la tabla, configura fields en "backgroundColor".

Para restablecer una propiedad a su valor predeterminado, incluye su nombre de campo en la máscara de campo, pero deja el campo sin configurar.

Son las celdas que se actualizarán. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
tableRange

object (TableRange)

Es el rango de la tabla que representa el subconjunto de la tabla al que se aplican las actualizaciones.

tableStartLocation

object (Location)

Es la ubicación donde comienza la tabla en el documento. Cuando se especifica, las actualizaciones se aplican a todas las celdas de la tabla.

Fin de los campos mutuamente excluyentes.

TableRange

Un rango de tabla representa una referencia a un subconjunto de una tabla.

Es importante tener en cuenta que las celdas especificadas por un rango de tabla no necesariamente forman un rectángulo. Por ejemplo, supongamos que tenemos una tabla de 3 x 3 en la que todas las celdas de la última fila están combinadas. La tabla se ve de la siguiente manera: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Un rango de tabla con la ubicación de la celda de la tabla = (tableStartLocation, row = 0, column = 0), un intervalo de filas = 3 y un intervalo de columnas = 2 especifica las siguientes celdas: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Representación JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Campos
tableCellLocation

object (TableCellLocation)

Ubicación de la celda donde comienza el rango de la tabla.

rowSpan

integer

Es el intervalo de filas del rango de la tabla.

columnSpan

integer

Es la extensión de la columna del rango de la tabla.

UpdateTableRowStyleRequest

Actualiza el TableRowStyle de las filas de una tabla.

Representación JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Campos
tableStartLocation

object (Location)

Es la ubicación donde comienza la tabla en el documento.

rowIndices[]

integer

Es la lista de índices de fila basados en cero cuyo diseño se debe actualizar. Si no se especifican índices, se actualizarán todas las filas.

tableRowStyle

object (TableRowStyle)

Son los estilos que se establecerán en las filas.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tableRowStyle es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar la altura mínima de la fila, establece fields en "minRowHeight".

ReplaceImageRequest

Reemplaza una imagen existente por una nueva.

Reemplazar una imagen quita algunos image effects de la imagen existente para reflejar el comportamiento del editor de Documentos.

Representación JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Campos
imageObjectId

string

ID de la imagen existente que se reemplazará. El ID se puede recuperar de la respuesta de una solicitud de obtención.

uri

string

Es el URI de la imagen nueva.

La imagen se recupera una vez en el momento de la inserción y se almacena una copia para mostrarla dentro del documento. Las imágenes deben pesar menos de 50 MB, no pueden superar los 25 megapíxeles y deben estar en formato PNG, JPEG o GIF.

La URI proporcionada no puede superar los 2 KB de longitud. El URI se guarda con la imagen y se expone a través del campo ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Es el método de reemplazo.

tabId

string

Es la pestaña en la que se encuentra la imagen que se reemplazará. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

ImageReplaceMethod

Es el método de reemplazo de imágenes.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED No se especificó el método de reemplazo de la imagen. No se debe usar este valor.
CENTER_CROP Ajusta la escala y centra la imagen para que ocupe los límites de la imagen original. Es posible que la imagen se recorte para llenar los límites de la imagen original. El tamaño renderizado de la imagen será el mismo que el de la imagen original.

UpdateDocumentStyleRequest

Actualiza el DocumentStyle.

Representación JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Campos
documentStyle

object (DocumentStyle)

Son los estilos que se establecerán en el documento.

Algunos cambios en el diseño del documento pueden provocar otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de DocumentStyle para obtener más información.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz documentStyle es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar el fondo, configura fields en "background".

tabId

string

Es la pestaña que contiene el diseño que se actualizará. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

MergeTableCellsRequest

Combina celdas en un Table.

Representación JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Campos
tableRange

object (TableRange)

Es el rango de la tabla que especifica qué celdas de la tabla se combinarán.

Todo el texto de las celdas que se combinan se concatenará y almacenará en la celda "principal" del rango. Es la celda superior izquierda del rango cuando la dirección del contenido es de izquierda a derecha y la celda superior derecha del rango en los demás casos.

Si el rango no es rectangular (lo que puede ocurrir en algunos casos en los que el rango abarca celdas que ya están combinadas o en los que la tabla no es rectangular), se devuelve un error 400 de solicitud incorrecta.

UnmergeTableCellsRequest

Separa las celdas en un Table.

Representación JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Campos
tableRange

object (TableRange)

Es el rango de la tabla que especifica qué celdas de la tabla se deben separar.

Se descombinarán todas las celdas combinadas en este rango, y las celdas que ya estén descombinadas no se verán afectadas. Si el rango no tiene celdas combinadas, la solicitud no hará nada.

Si hay texto en alguna de las celdas combinadas, este permanecerá en la celda "principal" del bloque resultante de celdas no combinadas. La celda "encabezado" es la celda superior izquierda cuando la dirección del contenido es de izquierda a derecha y la superior derecha en los demás casos.

CreateHeaderRequest

Crea un Header. El encabezado nuevo se aplica al SectionStyle en la ubicación del SectionBreak si se especifica; de lo contrario, se aplica al DocumentStyle.

Si ya existe un encabezado del tipo especificado, se devuelve un error 400 de solicitud incorrecta.

Representación JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

Es el tipo de encabezado que se creará.

sectionBreakLocation

object (Location)

Ubicación del SectionBreak que inicia la sección a la que debe pertenecer este encabezado. Si `sectionBreakLocation` no está configurado o si hace referencia al primer salto de sección del cuerpo del documento, el encabezado se aplica a DocumentStyle.

HeaderFooterType

Los tipos de encabezados y pies de página que se pueden crear

Enums
DEFAULT Un encabezado o pie de página predeterminado

CreateFooterRequest

Crea un Footer. El nuevo pie de página se aplica al SectionStyle en la ubicación del SectionBreak si se especifica; de lo contrario, se aplica al DocumentStyle.

Si ya existe un pie de página del tipo especificado, se devuelve un error 400 Bad Request.

Representación JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

Es el tipo de pie de página que se creará.

sectionBreakLocation

object (Location)

Ubicación del elemento SectionBreak que precede inmediatamente a la sección a la que debe pertenecer este pie de página.SectionStyle Si no se configura o hace referencia al primer salto de sección del documento, el pie de página se aplica al estilo del documento.

CreateFootnoteRequest

Crea un segmento Footnote y, luego, inserta un FootnoteReference nuevo en él en la ubicación especificada.

El nuevo segmento Footnote contendrá un espacio seguido de un carácter de salto de línea.

Representación JSON 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
Ubicación en la que se insertará la referencia de la nota al pie. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta la referencia de nota al pie en un índice específico del documento.

La referencia de la nota al pie debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior).

Las referencias de notas al pie no se pueden insertar dentro de una ecuación, un encabezado, un pie de página o una nota al pie. Como las referencias a pie de página solo se pueden insertar en el cuerpo, el campo segment ID debe estar vacío.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta la referencia de la nota al pie al final del cuerpo del documento.

Las referencias de notas al pie no se pueden insertar dentro de un encabezado, un pie de página o una nota al pie. Como las referencias a pie de página solo se pueden insertar en el cuerpo, el campo segment ID debe estar vacío.

Fin de los campos mutuamente excluyentes.

ReplaceNamedRangeContentRequest

Reemplaza el contenido del NamedRange o el NamedRanges especificados con el contenido de reemplazo proporcionado.

Ten en cuenta que un NamedRange individual puede constar de varios ranges discontinuos. En este caso, solo se reemplazará el contenido del primer rango. Se borrarán los demás rangos y su contenido.

En los casos en que reemplazar o borrar cualquier rango generaría una estructura de documento no válida, se devuelve un error 400 de solicitud incorrecta.

Representación JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
Campos
tabsCriteria

object (TabsCriteria)

Opcional. Son los criterios que se usan para especificar en qué pestañas se realiza el reemplazo. Si se omite, el reemplazo se aplica a todas las pestañas.

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

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

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

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

  • Si se proporciona, el reemplazo se aplica a las pestañas especificadas.

  • Si se omite, el reemplazo se aplica a todas las pestañas.

Es el contenido con el que se reemplazará el contenido existente del rango con nombre. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
text

string

Reemplaza el contenido de los rangos con nombre especificados por el texto proporcionado.

Fin de los campos mutuamente excluyentes.
Es una referencia a los rangos con nombre cuyo contenido se reemplazará. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
namedRangeId

string

Es el ID del rango con nombre cuyo contenido se reemplazará.

Si no hay un rango con nombre con el ID determinado, se devuelve un error 400 de solicitud incorrecta.

namedRangeName

string

Nombre del NamedRanges cuyo contenido se reemplazará.

Si hay varios named ranges con el nombre determinado, se reemplazará el contenido de cada uno. Si no hay rangos con nombre con el nombre determinado, la solicitud no realizará ninguna operación.

Fin de los campos mutuamente excluyentes.

UpdateSectionStyleRequest

Actualiza el SectionStyle.

Representación JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Campos
range

object (Range)

Es el rango que se superpone con las secciones a las que se les aplicará un diseño.

Como los saltos de sección solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

sectionStyle

object (SectionStyle)

Son los estilos que se establecerán en la sección.

Algunos cambios en el estilo de la sección pueden provocar otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de SectionStyle para obtener más información.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz sectionStyle está implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar el margen izquierdo, establece fields en "marginLeft".

InsertSectionBreakRequest

Inserta un salto de sección en la ubicación especificada.

Se insertará un carácter de salto de línea antes del salto de sección.

Representación JSON 
{
  "sectionType": enum (SectionType),

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
sectionType

enum (SectionType)

Es el tipo de sección que se insertará.

Es la ubicación en la que se insertará el corte. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta un salto de línea y un salto de sección en un índice específico del documento.

El salto de sección se debe insertar dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior).

Los saltos de sección no se pueden insertar dentro de una tabla, una ecuación, una nota al pie, un encabezado o un pie de página. Como los saltos de sección solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta un salto de línea y un salto de sección al final del cuerpo del documento.

Los saltos de sección no se pueden insertar dentro de una nota al pie, un encabezado o un pie de página. Como los saltos de sección solo se pueden insertar dentro del cuerpo, el campo segment ID debe estar vacío.

Fin de los campos mutuamente excluyentes.

DeleteHeaderRequest

Borra un objeto Header del documento.

Representación JSON 
{
  "headerId": string,
  "tabId": string
}
Campos
headerId

string

Es el ID del encabezado que se borrará. Si este encabezado se define en DocumentStyle, se quita la referencia a este encabezado, lo que hace que no haya encabezado de ese tipo para la primera sección del documento. Si este encabezado se define en un SectionStyle, se quita la referencia a este encabezado y el encabezado de ese tipo ahora continúa desde la sección anterior.

tabId

string

Es la pestaña que contiene el encabezado que se borrará. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

DeleteFooterRequest

Borra un objeto Footer del documento.

Representación JSON 
{
  "footerId": string,
  "tabId": string
}
Campos
footerId

string

Es el ID del pie de página que se borrará. Si este pie de página se define en DocumentStyle, se quitará la referencia a este pie de página, lo que hará que no haya ningún pie de página de ese tipo para la primera sección del documento. Si este pie de página se define en un SectionStyle, se quita la referencia a este pie de página y el pie de página de ese tipo ahora continúa desde la sección anterior.

tabId

string

Es la pestaña que contiene el pie de página que se borrará. Si se omite, la solicitud se aplica a la primera pestaña.

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

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

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

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

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

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

PinTableHeaderRowsRequest

Actualiza la cantidad de filas de encabezado de tabla fijadas en una tabla.

Representación JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Campos
tableStartLocation

object (Location)

Es la ubicación donde comienza la tabla en el documento.

pinnedHeaderRowsCount

integer

Cantidad de filas de la tabla que se fijarán, donde 0 implica que no se fijará ninguna fila.

AddDocumentTabRequest

Agrega una pestaña de documento. Cuando se agrega una pestaña en un índice determinado, se incrementan los índices de todas las pestañas posteriores.

Representación JSON 
{
  "tabProperties": {
    object (TabProperties)
  }
}
Campos
tabProperties

object (TabProperties)

Son las propiedades de la pestaña que se agregará. Todas las propiedades son opcionales.

DeleteTabRequest

Borra una pestaña. Si la pestaña tiene pestañas secundarias, estas también se borrarán.

Representación JSON 
{
  "tabId": string
}
Campos
tabId

string

Es el ID de la pestaña que se borrará.

UpdateDocumentTabPropertiesRequest

Actualiza las propiedades de una pestaña de documento.

Representación JSON 
{
  "tabProperties": {
    object (TabProperties)
  },
  "fields": string
}
Campos
tabProperties

object (TabProperties)

Son las propiedades de la pestaña que se actualizarán.

fields

string (FieldMask format)

Son los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz tabProperties es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

InsertPersonRequest

Inserta una mención de persona.

Representación JSON 
{
  "personProperties": {
    object (PersonProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
personProperties

object (PersonProperties)

Son las propiedades de la mención de persona que se insertará.

Es la ubicación en la que se insertará la mención de la persona. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta la mención de persona en un índice específico del documento.

La mención de la persona debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior).

No se pueden insertar menciones de personas dentro de una ecuación.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta la mención de la persona al final de un encabezado, un pie de página, una nota al pie o el cuerpo del documento.

Fin de los campos mutuamente excluyentes.

UpdateNamedStyleRequest

Actualiza un diseño con nombre.

Representación JSON 
{
  "namedStyle": {
    object (NamedStyle)
  },
  "fields": string,
  "tabId": string
}
Campos
namedStyle

object (NamedStyle)

Es el diseño del documento que se actualizará.

fields

string (FieldMask format)

Son los campos de NamedStyle que se deben actualizar.

Se debe especificar, al menos, namedStyleType. La raíz namedStyle es implícita y no se debe especificar. Se puede usar un solo "*" como abreviatura para enumerar todos los campos.

Por ejemplo, para actualizar el estilo de texto a negrita, configura fields para que incluya "textStyle" y "textStyle.bold". Para actualizar la propiedad de alineación del estilo de párrafo, configura fields para incluir "paragraphStyle" y "paragraphStyle.alignment".

Para restablecer una propiedad a su valor predeterminado, incluye su nombre de campo en la máscara de campo, pero deja el campo sin configurar. Si se especifica "textStyle" o "paragraphStyle" con un TextStyle o un ParagraphStyle vacío, se restablecerán todos sus campos anidados.

tabId

string

Es la pestaña del documento que se actualizará. De forma predeterminada, la actualización se aplica a la primera pestaña.

InsertRichLinkRequest

Inserta un objeto RichLink en la ubicación especificada.

Representación JSON 
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
Ubicación en la que se insertará el vínculo enriquecido. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta el vínculo enriquecido en un índice específico del documento.

El vínculo enriquecido debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y el párrafo anterior).

El vínculo enriquecido no se puede insertar dentro de una ecuación.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta el vínculo enriquecido al final de un encabezado, un pie de página, una nota al pie o el cuerpo del documento.

Fin de los campos mutuamente excluyentes.

InsertDateRequest

Inserta una fecha en la ubicación especificada.

Representación JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Campos
dateElementProperties

object (DateElementProperties)

Son las propiedades de la fecha que se insertará.

Es la ubicación en la que se insertará la fecha. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Inserta la fecha en un índice específico del documento.

La fecha debe insertarse dentro de los límites de un Paragraph existente. Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre una tabla existente y su párrafo anterior).

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserta la fecha al final del encabezado, el pie de página o el cuerpo del documento especificados.

Fin de los campos mutuamente excluyentes.

InsertCommentRequest

Inserta un objeto CommentThread en el documento.

Representación JSON 
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
Campos
content

string

Texto del comentario, como texto sin formato.

Este contenido de texto se manejará de manera similar a los comentarios creados en el editor de Documentos. Tendrá comportamientos similares para el formato, las notificaciones, etcétera.

Este campo no puede estar vacío y no debe superar las 2, 048 unidades de código UTF-8.

assigneeEmailAddress

string

Opcional. Es la dirección de correo electrónico del asignatario del comentario.

Déjalo vacío si el comentario no está asignado.

No puede superar las 2,048 unidades de código UTF-8.

Ubicación en el documento vinculada a este comentario. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
range

object (Range)

El objeto Range del documento asociado a este comentario.

Fin de los campos mutuamente excluyentes.

AddCommentReplyRequest

Inserta una respuesta Post en un CommentThread o SuggestionThread.

Representación JSON 
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
Campos
post

object (Post)

El objeto Post que representa la respuesta.

ID del subproceso al que se agregará la respuesta. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
commentId

string

ID del objeto CommentThread al que se agregará la respuesta.

suggestionId

string

ID del objeto SuggestionThread al que se agregará la respuesta.

Fin de los campos mutuamente excluyentes.

UpdateCommentPostRequest

Actualiza un objeto Post en un objeto CommentThread o SuggestionThread.

Devuelve un error 400 de solicitud incorrecta en los siguientes casos:

  • La publicación es el headPost de un SuggestionThread.

  • El usuario solicitante no es el autor de la publicación.

Representación JSON 
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
Campos
postId

string

Es el ID de la publicación que se actualizará.

content

string

Texto nuevo del comentario, como texto sin formato.

Este contenido de texto se manejará de manera similar a los comentarios creados en el editor de Documentos. Tendrá comportamientos similares para el formato, las notificaciones, etcétera.

Este campo no puede estar vacío y no debe superar las 2, 048 unidades de código UTF-8.

ID del subproceso al que pertenece la publicación. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
commentId

string

ID del CommentThread al que pertenece la publicación.

suggestionId

string

ID del SuggestionThread al que pertenece la publicación.

Fin de los campos mutuamente excluyentes.

DeleteCommentRequest

Borra un CommentThread.

Devuelve un error 400 de solicitud incorrecta si el usuario solicitante no es el autor del headPost.

Representación JSON 
{
  "commentId": string
}
Campos
commentId

string

ID del objeto CommentThread que se borrará.

DeleteCommentReplyRequest

Borra una respuesta Post de un CommentThread o SuggestionThread.

Devuelve un error 400 de solicitud incorrecta en los siguientes casos:

  • El usuario solicitante no es el autor de la publicación.

  • La publicación de respuesta contiene una [acción][google.apps.docs.v1.Post.action].

  • La publicación de respuesta contiene un assignee.

Representación JSON 
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
Campos
postId

string

ID de la respuesta Post que se borrará.

ID del subproceso al que pertenece la publicación. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
commentId

string

ID del CommentThread al que pertenece la publicación.

suggestionId

string

ID del SuggestionThread al que pertenece la publicación.

Fin de los campos mutuamente excluyentes.

AcceptSuggestionRequest

Acepta una sugerencia.

Devuelve un error 403 (prohibido) si el usuario solicitante no tiene acceso de edición al documento.

Representación JSON 
{
  "suggestionId": string
}
Campos
suggestionId

string

Es el ID de la sugerencia.

RejectSuggestionRequest

Rechaza una sugerencia.

Devuelve un error 403 (prohibido) si el usuario que realiza la solicitud no tiene acceso de edición al documento y no es el autor de la sugerencia.

Representación JSON 
{
  "suggestionId": string
}
Campos
suggestionId

string

Es el ID de la sugerencia.

DeleteSuggestionRequest

Borra una sugerencia.

Devuelve un error 403 (prohibido) si el usuario solicitante no es el autor de la sugerencia.

Representación JSON 
{
  "suggestionId": string
}
Campos
suggestionId

string

Es el ID de la sugerencia.