Hoja de cálculo
Es una hoja en una hoja de cálculo.
| Representación JSON |
|---|
{ "properties": { object ( |
| Campos | |
|---|---|
properties
|
Son las propiedades de la hoja. |
data[]
|
Son los datos de la cuadrícula, si se trata de una hoja de cuadrícula.
La cantidad de objetos GridData que se devuelven depende de la cantidad de rangos solicitados en esta hoja. Por ejemplo, si esto representa
En el caso de una hoja de cálculo de |
merges[]
|
Son los rangos que se combinan. |
conditionalFormats[]
|
Son las reglas de formato condicional de esta hoja. |
filterViews[]
|
Son las vistas de filtro de esta hoja. |
protectedRanges[]
|
Son los rangos protegidos en esta hoja. |
basicFilter
|
Es el filtro de esta hoja, si hay alguno. |
charts[]
|
Son las especificaciones de cada gráfico de esta hoja. |
bandedRanges[]
|
Son los rangos con bandas (colores alternados) de esta hoja. |
developerMetadata[]
|
Son los metadatos del desarrollador asociados con una hoja. |
rowGroups[]
|
Todos los grupos de filas de esta hoja, ordenados por índice de inicio del rango en aumento y, luego, por profundidad del grupo. |
columnGroups[]
|
Todos los grupos de columnas de esta hoja, ordenados por índice de inicio del rango en aumento y, luego, por profundidad del grupo. |
slicers[]
|
Son las segmentaciones de esta hoja. |
tables[]
|
Son las tablas de esta hoja. |
SheetProperties
Son las propiedades de una hoja.
| Representación JSON |
|---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
| Campos | |
|---|---|
sheetId
|
Es el ID de la hoja. Must be non-negative (La precisión de las coordenadas de latitud y longitud, en metros. No debe ser un valor negativo). Este campo no se puede cambiar una vez que se configura. |
title
|
Es el nombre de la hoja. |
index
|
Índice de la hoja dentro de la hoja de cálculo. Cuando se agregan o actualizan propiedades de la hoja, si se excluye este campo, la hoja se agrega o se mueve al final de la lista de hojas. Cuando se actualizan los índices de las hojas o se insertan hojas, el movimiento se considera en los índices "antes del movimiento". Por ejemplo, si hay tres hojas (H1, H2 y H3) y quieres mover H1 antes de H2, el índice se debe establecer en 2. Se ignora una solicitud de actualización del índice de la hoja si el índice solicitado es idéntico al índice actual de la hoja o si el nuevo índice solicitado es igual al índice actual de la hoja + 1. |
sheetType
|
Es el tipo de hoja. El valor predeterminado es |
gridProperties
|
Son las propiedades adicionales de la hoja si esta es una cuadrícula. (Si la hoja es una hoja de objeto y contiene un gráfico o una imagen, este campo no estará presente). Cuando se escribe, es un error establecer propiedades de cuadrícula en hojas que no son de cuadrícula.
Si esta hoja es una hoja de |
tabColor
|
Color de la pestaña en la IU. Obsoleto: Usa
|
tabColorStyle
|
Color de la pestaña en la IU. Si también se establece |
rightToLeft
|
Es verdadero si la hoja es RTL en lugar de LTR. |
dataSourceSheetProperties
|
Solo salida. Si está presente, el campo contiene propiedades específicas de la hoja |
SheetType
Es el tipo de hoja.
| Enums | |
|---|---|
SHEET_TYPE_UNSPECIFIED
|
Es un valor predeterminado que no se debe usar. |
GRID
|
La hoja es una cuadrícula. |
OBJECT
|
La hoja no tiene cuadrícula y, en cambio, tiene un objeto, como un gráfico o una imagen. |
DATA_SOURCE
|
La hoja se conecta con un DataSource externo
DataSource
y muestra la vista previa de los datos.
|
GridProperties
Son las propiedades de una cuadrícula.
| Representación JSON |
|---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
| Campos | |
|---|---|
rowCount
|
Es la cantidad de filas de la cuadrícula. |
columnCount
|
Es la cantidad de columnas de la cuadrícula. |
frozenRowCount
|
Cantidad de filas inmovilizadas en la cuadrícula. |
frozenColumnCount
|
Cantidad de columnas inmovilizadas en la cuadrícula. |
hideGridlines
|
Es verdadero si la cuadrícula no muestra líneas en la IU. |
rowGroupControlAfter
|
Es verdadero si el botón de activación del control de agrupación de filas se muestra después del grupo. |
columnGroupControlAfter
|
Es verdadero si el botón de activación del control de agrupación de columnas se muestra después del grupo. |
DataSourceSheetProperties
Son propiedades adicionales de una hoja de cálculo de DATA_SOURCE.
| Representación JSON |
|---|
{ "dataSourceId": string, "columns": [ { object ( |
| Campos | |
|---|---|
dataSourceId
|
ID de la
|
columns[]
|
Son las columnas que se muestran en la hoja y que corresponden a los valores de |
dataExecutionStatus
|
Es el estado de ejecución de los datos. |
GridData
Datos en la cuadrícula, así como metadatos sobre las dimensiones
| Representación JSON |
|---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
| Campos | |
|---|---|
startRow
|
Es la primera fila a la que hace referencia este GridData, con base cero. |
startColumn
|
Es la primera columna a la que hace referencia este GridData, con base cero. |
rowData[]
|
Son los datos de la cuadrícula, con una entrada por fila, comenzando con la fila en startRow. Los valores de RowData corresponderán a las columnas que comienzan en |
rowMetadata[]
|
Son los metadatos sobre las filas solicitadas en la cuadrícula, comenzando por la fila en |
columnMetadata[]
|
Son los metadatos sobre las columnas solicitadas en la cuadrícula, comenzando por la columna en |
RowData
Son los datos sobre cada celda de una fila.
| Representación JSON |
|---|
{
"values": [
{
object ( |
| Campos | |
|---|---|
values[]
|
Son los valores de la fila, uno por columna. |
DimensionProperties
Son propiedades sobre una dimensión.
| Representación JSON |
|---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
| Campos | |
|---|---|
pixelSize
|
Es la altura (si es una fila) o el ancho (si es una columna) de la dimensión en píxeles. |
developerMetadata[]
|
Son los metadatos del desarrollador asociados a una sola fila o columna. |
dataSourceColumnReference
|
Solo salida. Si se configura, esta es una columna en una hoja de la fuente de datos. |
ConditionalFormatRule
Es una regla que describe un formato condicional.
| Representación JSON |
|---|
{ "ranges": [ { object ( |
| Campos | |
|---|---|
ranges[]
|
Son los rangos que se formatean si la condición es verdadera. Todos los rangos deben estar en la misma cuadrícula. |
Campo de unión
rule. Es la regla que controla este formato condicional. Se debe establecer exactamente una.
rule
puede ser solo uno de los siguientes valores:
|
|
booleanRule
|
El formato está "activado" o "desactivado" según la regla. |
gradientRule
|
El formato variará según los gradientes de la regla. |
BooleanRule
Es una regla que puede coincidir o no, según la condición.
| Representación JSON |
|---|
{ "condition": { object ( |
| Campos | |
|---|---|
condition
|
Es la condición de la regla. Si la condición se evalúa como verdadera, se aplica el formato. |
format
|
Es el formato que se aplicará. El formato condicional solo puede aplicar un subconjunto de formatos:
|
GradientRule
Es una regla que aplica un formato de escala de color de gradiente según los puntos de interpolación que se indican. El formato de una celda variará según su contenido en comparación con los valores de los puntos de interpolación.
| Representación JSON |
|---|
{ "minpoint": { object ( |
| Campos | |
|---|---|
minpoint
|
Es el punto de interpolación inicial. |
midpoint
|
Es un punto de interpolación intermedio opcional. |
maxpoint
|
Es el punto de interpolación final. |
InterpolationPoint
Es un solo punto de interpolación en un formato condicional de gradiente. Estos fijan la escala de gradientes de color según el color, el tipo y el valor elegidos.
| Representación JSON |
|---|
{ "color": { object ( |
| Campos | |
|---|---|
color
|
Color que debe usar este punto de interpolación. Obsoleto: Usa
|
colorStyle
|
Color que debe usar este punto de interpolación. Si también se establece |
type
|
Indica cómo se debe interpretar el valor. |
value
|
Es el valor que usa este punto de interpolación. Puede ser una fórmula. No se usa si |
InterpolationPointType
Es el tipo de punto de interpolación.
| Enums | |
|---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
Es el valor predeterminado y no se debe usar. |
MIN
|
El punto de interpolación usa el valor mínimo en las celdas del rango del formato condicional. |
MAX
|
El punto de interpolación usa el valor máximo en las celdas del rango del formato condicional. |
NUMBER
|
El punto de interpolación usa exactamente el valor en InterpolationPoint.value.
|
PERCENT
|
El punto de interpolación es el porcentaje determinado en todas las celdas del rango del formato condicional. Esto equivale a |
PERCENTILE
|
El punto de interpolación es el percentil determinado en todas las celdas del rango del formato condicional. Esto equivale a
NUMBER
si el valor era:
=PERCENTILE(FLATTEN(range), value / 100)
(donde se ignoran los errores en el rango cuando se aplana).
|
FilterView
Es una vista de filtro. Para obtener más información, consulta Administra la visibilidad de los datos con filtros.
| Representación JSON |
|---|
{ "filterViewId": integer, "title": string, "range": { object ( |
| Campos | |
|---|---|
filterViewId
|
Es el ID de la vista de filtro. |
title
|
Es el nombre de la vista de filtro. |
range
|
Es el rango que abarca esta vista de filtro.
Cuando escribas, solo se puede establecer uno de los siguientes valores:
|
namedRangeId
|
Es el rango con nombre en el que se basa esta vista de filtro, si existe.
Cuando escribas, solo se puede establecer uno de los siguientes valores:
|
tableId
|
Es la tabla en la que se basa esta vista de filtro, si la hay.
Cuando escribas, solo se puede establecer uno de los siguientes valores:
|
sortSpecs[]
|
Es el orden de clasificación por columna. Las especificaciones posteriores se usan cuando los valores son iguales en las especificaciones anteriores. |
criteria
|
Son los criterios para mostrar u ocultar valores por columna. La clave del mapa es el índice de la columna, y el valor es el criterio para esa columna.
Este campo dejó de estar disponible y se reemplazó por |
filterSpecs[]
|
Son los criterios de filtro para mostrar u ocultar valores por columna.
Tanto |
ProtectedRange
Es un rango protegido.
| Representación JSON |
|---|
{ "protectedRangeId": integer, "range": { object ( |
| Campos | |
|---|---|
protectedRangeId
|
Es el ID del rango protegido. Este campo es de solo lectura. |
range
|
Es el rango que se protege. El rango puede no tener límites, en cuyo caso se considera una hoja protegida.
Cuando escribas, solo se puede establecer uno de los siguientes valores:
|
namedRangeId
|
Es el rango con nombre en el que se basa este rango protegido, si corresponde.
Cuando escribas, solo se puede establecer uno de los siguientes valores:
|
tableId
|
Es la tabla que respalda este rango protegido, si existe.
Cuando escribas, solo se puede establecer uno de los siguientes valores:
|
description
|
Es la descripción de este rango protegido. |
warningOnly
|
Es verdadero si este rango protegido mostrará una advertencia cuando se edite. La protección basada en advertencias significa que todos los usuarios pueden editar datos en el rango protegido, pero la edición generará una advertencia que le pedirá al usuario que confirme la edición.
Cuando se escribe: Si este campo es verdadero, se ignoran |
requestingUserCanEdit
|
Es verdadero si el usuario que solicitó este rango protegido puede editar el área protegida. Este campo es de solo lectura. |
unprotectedRanges[]
|
Es la lista de rangos sin protección dentro de una hoja protegida. Los rangos sin protección solo se admiten en las hojas protegidas. |
editors
|
Usuarios y grupos con acceso de edición al rango protegido. Este campo solo es visible para los usuarios con acceso de edición al rango protegido y al documento. Los editores no son compatibles con la protección de
|
Editores
Son los editores de un rango protegido.
| Representación JSON |
|---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
| Campos | |
|---|---|
users[]
|
Son las direcciones de correo electrónico de los usuarios con acceso de edición al rango protegido. |
groups[]
|
Son las direcciones de correo electrónico de los grupos con acceso de edición al rango protegido. |
domainUsersCanEdit
|
Es verdadero si cualquier persona del dominio del documento tiene acceso de edición al rango protegido. La protección del dominio solo se admite en documentos dentro de un dominio. |
BasicFilter
Es el filtro predeterminado asociado a una hoja. Para obtener más información, consulta Administra la visibilidad de los datos con filtros.
| Representación JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
Es el rango que abarca el filtro. |
tableId
|
Es la tabla en la que se basa este filtro, si la hay. Cuando se escribe, solo se puede establecer uno de los siguientes valores:
|
sortSpecs[]
|
Es el orden de clasificación por columna. Las especificaciones posteriores se usan cuando los valores son iguales en las especificaciones anteriores. |
criteria
|
Son los criterios para mostrar u ocultar valores por columna. La clave del mapa es el índice de la columna, y el valor es el criterio para esa columna.
Este campo dejó de estar disponible y se reemplazó por |
filterSpecs[]
|
Son los criterios de filtro por columna.
Tanto |
BandedRange
Es un rango con bandas (colores alternados) en una hoja.
| Representación JSON |
|---|
{ "bandedRangeId": integer, "bandedRangeReference": string, "range": { object ( |
| Campos | |
|---|---|
bandedRangeId
|
Es el ID del rango agrupado. Si no se configura, consulta |
bandedRangeReference
|
Solo salida. Es la referencia del rango agrupado, que se usa para identificar el ID que no admite |
range
|
Es el rango en el que se aplican estas propiedades. |
rowProperties
|
Son las propiedades de las bandas de filas. Estas propiedades se aplican fila por fila en todo el rango. Se debe especificar al menos uno de los siguientes valores:
|
columnProperties
|
Son las propiedades de las bandas de columnas. Estas propiedades se aplican columna por columna en todas las columnas del rango. Se debe especificar al menos uno de los siguientes valores:
|
BandingProperties
Son propiedades que hacen referencia a una sola dimensión (ya sea fila o columna). Si se configuran BandedRange.row_properties y BandedRange.column_properties, los colores de relleno se aplican a las celdas según las siguientes reglas:
-
headerColoryfooterColortienen prioridad sobre los colores de la correa. -
firstBandColortiene prioridad sobresecondBandColor. -
rowPropertiestiene prioridad sobrecolumnProperties.
Por ejemplo, el color de la primera fila tiene prioridad sobre el color de la primera columna, pero el color de la primera columna tiene prioridad sobre el color de la segunda fila. Del mismo modo, el encabezado de fila tiene prioridad sobre el encabezado de columna en la celda superior izquierda, pero el encabezado de columna tiene prioridad sobre el color de la primera fila si no se configura el encabezado de fila.
| Representación JSON |
|---|
{ "headerColor": { object ( |
| Campos | |
|---|---|
headerColor
|
Es el color de la primera fila o columna. Si se configura este campo, la primera fila o columna se completa con este color, y los colores alternan entre
|
headerColorStyle
|
Es el color de la primera fila o columna. Si se configura este campo, la primera fila o columna se completa con este color, y los colores alternan entre
|
firstBandColor
|
Es el primer color que se alterna. (Obligatorio) Obsoleto: Usa |
firstBandColorStyle
|
Es el primer color que se alterna. (Obligatorio) Si también se establece |
secondBandColor
|
Es el segundo color que se alterna. (Obligatorio) Obsoleto: Usa |
secondBandColorStyle
|
Es el segundo color que se alterna. (Obligatorio) Si también se establece |
footerColor
|
Es el color de la última fila o columna. Si no se configura este campo, la última fila o columna se completará con |
footerColorStyle
|
Es el color de la última fila o columna. Si no se configura este campo, la última fila o columna se completará con |
DimensionGroup
Es un grupo que abarca un intervalo de filas o columnas en una hoja y que puede contener otros grupos o estar contenido dentro de ellos. Un grupo se puede contraer o expandir como una unidad en la hoja.
| Representación JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
Es el rango en el que existe este grupo. |
depth
|
Es la profundidad del grupo, que representa cuántos grupos tienen un rango que contiene por completo el rango de este grupo. |
collapsed
|
Este campo es verdadero si este grupo está contraído. Un grupo contraído permanece contraído si se expande un grupo superpuesto a una profundidad menor. Un valor verdadero no implica que todas las dimensiones dentro del grupo estén ocultas, ya que la visibilidad de una dimensión puede cambiar independientemente de esta propiedad del grupo. Sin embargo, cuando se actualiza esta propiedad, todas las dimensiones que contiene se establecen como ocultas si este campo es verdadero o como visibles si este campo es falso. |
Control de filtro
Es un filtro en una hoja.
| Representación JSON |
|---|
{ "slicerId": integer, "spec": { object ( |
| Campos | |
|---|---|
slicerId
|
Es el ID del segmentador. |
spec
|
Es la especificación del segmentador. |
position
|
Es la posición del segmentador. Ten en cuenta que el segmentador solo se puede colocar en una hoja existente. Además, el ancho y el alto de la segmentación se pueden ajustar automáticamente para mantenerla dentro de los límites permitidos. |
SlicerSpec
Son las especificaciones de un segmentador.
| Representación JSON |
|---|
{ "dataRange": { object ( |
| Campos | |
|---|---|
dataRange
|
Es el rango de datos del segmentador. |
filterCriteria
|
Son los criterios de filtrado de la segmentación. |
columnIndex
|
Es el índice de columna basado en cero en la tabla de datos en la que se aplica el filtro. |
applyToPivotTables
|
Es verdadero si el filtro se debe aplicar a las tablas dinámicas. Si no se establece, el valor predeterminado es |
title
|
Es el título del segmentador. |
textFormat
|
Es el formato de texto del título en la segmentación. No se admite el campo de vínculo. |
backgroundColor
|
Es el color de fondo del segmentador. Obsoleto: Usa
|
backgroundColorStyle
|
Es el color de fondo del segmentador. Si también se establece |
horizontalAlignment
|
Es la alineación horizontal del título en el segmentador. Si no se especifica, el valor predeterminado es |
Tabla
Una mesa
| Representación JSON |
|---|
{ "tableId": string, "name": string, "range": { object ( |
| Campos | |
|---|---|
tableId
|
Es el ID de la tabla. |
name
|
Es el nombre de la tabla. Es único para todas las tablas de la misma hoja de cálculo. |
range
|
Es el rango de la tabla. |
rowsProperties
|
Son las propiedades de las filas de la tabla. |
columnProperties[]
|
Son las propiedades de la columna de la tabla. |
TableRowsProperties
Son las propiedades de la fila de la tabla.
| Representación JSON |
|---|
{ "headerColorStyle": { object ( |
| Campos | |
|---|---|
headerColorStyle
|
Es el color de la fila del encabezado. Si se configura este campo, la fila de encabezado se completará con el color especificado. De lo contrario, la fila de encabezado se completará con un color predeterminado. |
firstBandColorStyle
|
Es el primer color que se alterna. Si se configura este campo, la primera fila con bandas se rellena con el color especificado. De lo contrario, la primera fila con bandas se completará con un color predeterminado. |
secondBandColorStyle
|
Es el segundo color que se alterna. Si se configura este campo, la segunda fila con bandas se rellena con el color especificado. De lo contrario, la segunda fila con bandas se completará con un color predeterminado. |
footerColorStyle
|
Es el color de la última fila. Si no se configura este campo, no se agrega un pie de página y la última fila se completa con |
TableColumnProperties
Columna de la tabla.
| Representación JSON |
|---|
{ "columnIndex": integer, "columnName": string, "columnType": enum ( |
| Campos | |
|---|---|
columnIndex
|
Índice de columna basado en 0. Este índice es relativo a su posición en la tabla y no necesariamente es el mismo que el índice de columna en la hoja. |
columnName
|
El nombre de la columna. |
columnType
|
Es el tipo de columna. |
dataValidationRule
|
Es la regla de validación de datos de la columna. Solo se establece para el tipo de columna de menú desplegable. |
ColumnType
Es el tipo de columna para una columna determinada en una tabla.
| Enums | |
|---|---|
COLUMN_TYPE_UNSPECIFIED
|
Es un tipo de columna no especificado. |
DOUBLE
|
Es el tipo de columna de número. |
CURRENCY
|
Es el tipo de columna de moneda. |
PERCENT
|
Es el tipo de columna de porcentaje. |
DATE
|
Es el tipo de columna de fecha. |
TIME
|
Es el tipo de columna de tiempo. |
DATE_TIME
|
Es el tipo de columna de fecha y hora. |
TEXT
|
Es el tipo de columna de texto. |
BOOLEAN
|
Es el tipo de columna booleana. |
DROPDOWN
|
Es el tipo de columna de menú desplegable. |
FILES_CHIP
|
Es el tipo de columna de chip de archivos. |
PEOPLE_CHIP
|
Es el tipo de columna de chip de persona. |
FINANCE_CHIP
|
El tipo de columna de chip de Finance |
PLACE_CHIP
|
El tipo de columna de chip de lugar |
RATINGS_CHIP
|
El tipo de columna de chip de calificaciones |
TableColumnDataValidationRule
Es una regla de validación de datos para una columna en una tabla.
| Representación JSON |
|---|
{
"condition": {
object ( |
| Campos | |
|---|---|
condition
|
Es la condición que deben cumplir los datos de la celda. Solo es válido si [BooleanCondition.type] es ONE_OF_LIST. |