Requests

{

  // Union field request can be only one of the following:
  "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)
  }
  // End of list of possible types for union field request.
}

object (ReplaceAllTextRequest)

Reemplaza todas las instancias del texto especificado.

object (InsertTextRequest)

Inserta texto en la ubicación especificada.

object (UpdateTextStyleRequest)

Actualiza el estilo de texto en el rango especificado.

object (CreateParagraphBulletsRequest)

Crea viñetas para los párrafos.

object (DeleteParagraphBulletsRequest)

Borra los viñetas de los párrafos.

object (CreateNamedRangeRequest)

Crea un rango con nombre.

object (DeleteNamedRangeRequest)

Borra un rango con nombre.

object (UpdateParagraphStyleRequest)

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

object (DeleteContentRangeRequest)

Borra el contenido del documento.

object (InsertInlineImageRequest)

Inserta una imagen intercalada en la ubicación especificada.

object (InsertTableRequest)

Inserta una tabla en la ubicación especificada.

object (InsertTableRowRequest)

Inserta una fila vacía en una tabla.

object (InsertTableColumnRequest)

Inserta una columna vacía en una tabla.

object (DeleteTableRowRequest)

Borra una fila de una tabla.

object (DeleteTableColumnRequest)

Borra una columna de una tabla.

object (InsertPageBreakRequest)

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

object (DeletePositionedObjectRequest)

Borra un objeto posicionado del documento.

object (UpdateTableColumnPropertiesRequest)

Actualiza las propiedades de las columnas de una tabla.

object (UpdateTableCellStyleRequest)

Actualiza el estilo de las celdas de la tabla.

object (UpdateTableRowStyleRequest)

Actualiza el estilo de fila en una tabla.

object (ReplaceImageRequest)

Reemplaza una imagen en el documento.

object (UpdateDocumentStyleRequest)

Actualiza el estilo del documento.

object (MergeTableCellsRequest)

Combina celdas en una tabla.

object (UnmergeTableCellsRequest)

Descombina celdas en una tabla.

object (CreateHeaderRequest)

Crea un encabezado.

object (CreateFooterRequest)

Crea un pie de página.

object (CreateFootnoteRequest)

Crea una nota al pie.

object (ReplaceNamedRangeContentRequest)

Reemplaza el contenido de un rango nombrado.

object (UpdateSectionStyleRequest)

Actualiza el estilo de la sección del rango especificado.

object (InsertSectionBreakRequest)

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

object (DeleteHeaderRequest)

Borra un encabezado del documento.

object (DeleteFooterRequest)

Borra un pie de página del documento.

object (PinTableHeaderRowsRequest)

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

{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}

string

Es el texto que reemplazará el texto que coincide.

object (TabsCriteria)

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

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

En un documento que contiene una sola pestaña:

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

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

En un documento que contiene varias pestañas:

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

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

object (SubstringMatchCriteria)

Busca texto en el documento que coincida con esta subcadena.

{
  "text": string,
  "matchCase": boolean
}

string

Es el texto que se busca en el documento.

boolean

Indica si la búsqueda debe respetar 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.

{
  "tabIds": [
    string
  ]
}

string

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

{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

Texto que se va a insertar

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

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

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

object (Location)

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

El texto se debe insertar 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.

object (EndOfSegmentLocation)

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

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

string

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

integer

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

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

string

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:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "segmentId": string,
  "tabId": string
}

string

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

string

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:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (TextStyle)

Los estilos que se establecerán en el texto.

Si el valor de un estilo en particular coincide con el del elemento superior, ese estilo se establecerá para heredar.

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

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. El textStyle raíz se da por sentado y no se debe especificar. Se puede usar un solo "*" como atajo para enumerar todos los campos.

Por ejemplo, para actualizar el estilo de texto a negrita, establece 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 definir.

object (Range)

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

El rango se puede extender para incluir líneas nuevas 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 una UpdateTextStyleRequest relativa.

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

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

enum (BulletGlyphPreset)

Los tipos de glifos de viñeta que se usarán.

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

object (Range)

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

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

Es el nombre del NamedRange. 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.

object (Range)

El rango al que se le aplicará el nombre.

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}

object (TabsCriteria)

Opcional. Los criterios que se usan para especificar en qué pestañas debe ocurrir la eliminación del rango. Cuando se omite, la eliminación del rango se aplica a todas las pestañas.

En un documento que contiene una sola pestaña:

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

• Si se omite, la eliminación del rango se aplica a la pestaña única.

En un documento que contiene varias pestañas:

• Si se proporciona, la eliminación del rango se aplica a las pestañas especificadas.

• Si no se proporciona, la eliminación del rango se aplica a todas las pestañas.

string

El ID del rango con nombre que se borrará.

string

El nombre de los rangos que se borrarán. Se borrarán todos los rangos con ese nombre.

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (ParagraphStyle)

Los estilos que se establecerán en los párrafos.

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

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. La raíz paragraphStyle está implícita y no debe especificarse. Un solo "*" se puede usar como abreviatura para enumerar cada campo.

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 el nombre de su campo en la máscara de campo, pero no configures el campo.

object (Range)

El rango que se superpone a los párrafos al que se le quiere aplicar diseño.

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

object (Range)

El rango de contenido que se borrará.

Si borras texto que cruza los límites de un párrafo, es posible que se produzcan cambios en los estilos de párrafo, las listas, los objetos de posición y los marcadores, ya que se combinan los dos párrafos.

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

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

• Borrar una unidad de código de un par subrogado
• Borrar el último carácter de línea nueva de un Body, Header, Footer, Footnote, TableCell o TableOfContents
• Eliminar el inicio o el final de una Table, TableOfContents o Equation sin borrar todo el elemento.
• Borrar el carácter de línea nueva antes de un Table, TableOfContents o SectionBreak sin borrar el elemento
• Borrar filas o celdas individuales de una tabla Se puede borrar el contenido de una celda de una tabla.

{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

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 tener un tamaño inferior a 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 se guarda con la imagen y se expone a través del ImageProperties.content_uri .

object (Size)

Es el tamaño en 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 con las siguientes reglas: * Si no se especifica el ancho ni la altura, se calcula un tamaño predeterminado de la imagen en función de 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 ajustarse a las dimensiones proporcionadas y se mantiene su relación de aspecto.

object (Location)

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

La imagen 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 su párrafo anterior).

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

object (EndOfSegmentLocation)

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

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

{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

integer

Es la cantidad de filas en la tabla.

integer

Es la cantidad de columnas de la tabla.

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 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 en una nota al pie ni en una ecuación.

object (EndOfSegmentLocation)

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

No se pueden insertar tablas en una nota al pie.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

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.

boolean

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

• True : insertar debajo de la celda.
• False : insertar arriba de la celda.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

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

integer

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

integer

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object (TableCellLocation)

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

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

boolean

Establece 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 : insertar a la izquierda.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

La ubicación de la celda de la tabla de referencia de 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 abarca. Si no quedan filas en la tabla después de esta eliminación, se borra toda la tabla.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

Es la 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. Si no queda ninguna columna en la tabla después de esta eliminación, se borrará toda la tabla.

{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

object (Location)

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

El salto de página 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).

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

object (EndOfSegmentLocation)

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

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

{
  "objectId": string,
  "tabId": string
}

string

El ID del objeto posicionado que se borrará.

string

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

En un documento que contiene una sola pestaña:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object (Location)

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

integer

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

object (TableColumnProperties)

Las propiedades de columna de la tabla que se actualizarán.

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

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. El tableColumnProperties raíz se da por sentado y no se debe especificar. Se puede usar un solo "*" como atajo para enumerar todos los campos.

Por ejemplo, para actualizar el ancho de columna, establece fields a "width"

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}

object (TableCellStyle)

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

Al actualizar bordes, si una celda comparte un borde con una celda adyacente, también se actualiza la propiedad del borde correspondiente de la celda adyacente. No se actualizan los bordes que están combinados y son invisibles.

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

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. El tableCellStyle raíz se da por sentado y no se debe especificar. Se puede usar un solo "*" como atajo para enumerar todos los campos.

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

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

object (TableRange)

El rango de la tabla que representa el subconjunto de la tabla a la que se aplican las actualizaciones.

object (Location)

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

Es la ubicación de la celda donde comienza el rango de la tabla.

integer

Es el intervalo de filas del rango de la tabla.

integer

El intervalo de columnas del rango de la tabla.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object (Location)

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

integer

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

object (TableRowStyle)

Los estilos que se establecerán en las filas.

string (FieldMask format)

Los campos que se deben actualizar.

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

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

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

string

Es el ID de la imagen existente que se reemplazará. El ID se puede recuperar a partir de la respuesta de una solicitud get.

string

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.

El URI proporcionado 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.

enum (ImageReplaceMethod)

Es el método de reemplazo.

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:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

object (DocumentStyle)

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

Es posible que ciertos cambios en el estilo del documento provoquen otros cambios para reflejar el comportamiento del editor de Documentos. Consulta la documentación de DocumentStyle para obtener más información.

string (FieldMask format)

Los campos que se deben actualizar.

Se debe especificar al menos un campo. El documentStyle raíz se da por sentado y no se debe especificar. Se puede usar un solo "*" como atajo para enumerar todos los campos.

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

string

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

En un documento que contiene una sola pestaña:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

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

Cualquier texto en las celdas que se combinen se concatenará y se almacenará en el encabezado celda del rango. Es la celda superior izquierda del rango cuando la dirección del contenido es de izquierda a derecha; de lo contrario, es la celda superior derecha del rango.

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 cuando la tabla no es rectangular), se muestra un error de solicitud incorrecta 400.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

El rango de la tabla que especifica qué celdas de la tabla se separarán.

Se desunirán todas las celdas combinadas de este rango, y las celdas que ya no estén combinadas 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 el "encabezado". del bloque resultante de celdas separadas. La "cabeza" es la celda superior izquierda cuando la dirección del contenido es de izquierda a derecha; de lo contrario, la esquina superior derecha.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

El tipo de encabezado que se creará.

object (Location)

Es la ubicación del SectionBreak que comienza la sección a la que debe pertenecer este encabezado. Si no se establece "sectionBreakLocation" o si hace referencia a la primera pausa de sección en el cuerpo del documento, el encabezado se aplica a la sección DocumentStyle.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

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

object (Location)

Es la ubicación del SectionBreak que precede inmediatamente a la sección a la que pertenece este pie de página. Si no se establece o hace referencia al primer salto de sección del documento, el pie de página se aplicará al estilo del documento.

{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}

object (Location)

Inserta la referencia de la 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 su 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. Dado que las referencias de notas al pie solo se pueden insertar en el cuerpo, segment ID el campo debe estar vacío.

object (EndOfSegmentLocation)

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

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

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}

object (TabsCriteria)

Opcional. 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:

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

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

En un documento que contiene varias pestañas:

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

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

string

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

string

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

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

string

Es el nombre del NamedRanges cuyo contenido se reemplazará.

Si hay varios named ranges con el nombre dado, se reemplazará el contenido de cada uno. Si no hay rangos nombrados con el nombre determinado, la solicitud no se realizará.

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

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

Debido a que los saltos de sección solo se pueden insertar en el interior del cuerpo, segment ID el campo debe estar vacío.

object (SectionStyle)

Los estilos que se configurarán en la sección.

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

string (FieldMask format)

Los campos que se deben actualizar.

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

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

{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

enum (SectionType)

El tipo de sección a insertar.

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 debe insertarse dentro de los límites de un Paragraph Por ejemplo, no se puede insertar en el índice de inicio de una tabla (es decir, entre la tabla y su párrafo anterior).

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

object (EndOfSegmentLocation)

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

No se pueden insertar saltos de sección en una nota al pie, un encabezado ni un pie de página. Debido a que los saltos de sección solo se pueden insertar en el interior del cuerpo, segment ID el campo debe estar vacío.

{
  "headerId": string,
  "tabId": string
}

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

string

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:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "footerId": string,
  "tabId": string
}

string

El ID del pie de página que se borrará. Si este pie de página se define en DocumentStyle, se quita la referencia a este pie de página, lo que genera que no haya un 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.

string

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

En un documento que contiene una sola pestaña:

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

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

En un documento que contiene varias pestañas:

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

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

integer

La cantidad de filas de la tabla que se fijarán, donde 0 implica que todas las filas no están fijadas.