Hoja de cálculo
Una hoja en una hoja de cálculo.
Representación JSON |
---|
{ "properties": { object ( |
Campos | |
---|---|
properties
|
Las propiedades de la hoja. |
data[]
|
Datos en la cuadrícula, si se trata de una hoja de cuadrícula.
La cantidad de objetos GridData que se muestran depende de la cantidad de rangos solicitados en esta hoja. Por ejemplo, si esto representa
En el caso de una hoja |
merges[]
|
Los rangos que se combinan. |
conditionalFormats[]
|
Las reglas de formato condicional de esta hoja |
filterViews[]
|
Las vistas de filtro de esta hoja. |
protectedRanges[]
|
Los rangos protegidos de esta hoja. |
basicFilter
|
El filtro de esta hoja, si corresponde |
charts[]
|
Las especificaciones de cada gráfico de esta hoja |
bandedRanges[]
|
Los intervalos entre bandas (colores alternos) en esta hoja |
developerMetadata[]
|
Los metadatos del desarrollador asociados con una hoja. |
rowGroups[]
|
Todos los grupos de filas de esta hoja, ordenados por índice de inicio del rango creciente y, luego, por profundidad del grupo. |
columnGroups[]
|
Todos los grupos de columnas de esta hoja, ordenados por el índice de inicio del rango y, luego, por la profundidad del grupo. |
slicers[]
|
Los filtros de esta hoja. |
SheetProperties
Propiedades de una hoja
Representación JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
Campos | |
---|---|
sheetId
|
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). Una vez que se establece, este campo no se puede cambiar. |
title
|
Es el nombre de la hoja. |
index
|
Es el í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 hubiera tres hojas (Hoja1, Hoja2 y Hoja3) para mover la Hoja1 antes de la Hoja2, el índice se tendría que 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 índice nuevo solicitado es igual al índice actual de la hoja + 1. |
sheetType
|
Es el tipo de hoja. La configuración predeterminada es |
gridProperties
|
Propiedades adicionales de la hoja si esta es una cuadrícula (Si la hoja es una hoja de objeto que contiene un gráfico o una imagen, este campo estará ausente). 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 |
tabColor
|
Es el color de la pestaña en la IU. Obsoleto: Usa |
tabColorStyle
|
Es el color de la pestaña en la IU. Si también se establece |
rightToLeft
|
Es verdadero si la hoja es de derecha a izquierda en lugar de de izquierda a derecha. |
dataSourceSheetProperties
|
Solo salida. Si está presente, el campo contiene propiedades específicas de la hoja |
SheetType
Es el tipo de hoja.
Enumeraciones | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
Valor predeterminado, no usar. |
GRID
|
La hoja es una cuadrícula. |
OBJECT
|
La hoja no tiene cuadrícula y, en su lugar, tiene un objeto como un gráfico o una imagen. |
DATA_SOURCE
|
La hoja se conecta con un DataSource externo y muestra la vista previa de los datos.
|
GridProperties
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 en la cuadrícula. |
columnCount
|
Es la cantidad de columnas en la cuadrícula. |
frozenRowCount
|
Es la cantidad de filas que están fijas en la cuadrícula. |
frozenColumnCount
|
Es la cantidad de columnas que están inmovilizadas en la cuadrícula. |
hideGridlines
|
Es verdadero si la cuadrícula no muestra líneas de cuadrícula 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
Propiedades adicionales de una hoja DATA_SOURCE
.
Representación JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
Campos | |
---|---|
dataSourceId
|
Es el ID del |
columns[]
|
Son las columnas que se muestran en la hoja, que corresponden a los valores de |
dataExecutionStatus
|
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 se refiere GridData, basada en cero. |
startColumn
|
Es la primera columna a la que hace referencia GridData, basada en cero. |
rowData[]
|
Los datos de la cuadrícula, una entrada por fila, comenzando con la fila en startRow. Los valores de RowData corresponderán a las columnas que comienzan en |
rowMetadata[]
|
Metadatos sobre las filas solicitadas en la cuadrícula, a partir de la fila en |
columnMetadata[]
|
Metadatos sobre las columnas solicitadas en la cuadrícula, que comienzan con la columna en |
RowData
Datos sobre cada celda de una fila.
Representación JSON |
---|
{
"values": [
{
object ( |
Campos | |
---|---|
values[]
|
Los valores de la fila, uno por columna. |
DimensionProperties
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 con una sola fila o columna. |
dataSourceColumnReference
|
Solo salida. Si se establece, 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[]
|
Los rangos que se aplicarán si la condición es verdadera. Todos los rangos deben estar en la misma cuadrícula. |
Campo de unión rule . La regla que controla este formato condicional, se debe establecer exactamente una.
rule solo puede ser uno de los siguientes:
|
|
booleanRule
|
El formato está "activado" o "desactivado" según la regla. |
gradientRule
|
El formato variará según los gradientes de la regla. |
BooleanRule
Una regla que podría 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
|
El formato que se aplicará. El formato condicional solo puede aplicar un subconjunto de formato: |
GradientRule
Es una regla que aplica un formato de escala de colores de degradado según los puntos de interpolación enumerados. 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
|
El punto de interpolación inicial. |
midpoint
|
Es un punto de interpolación intermedia opcional. |
maxpoint
|
El punto de interpolación final. |
InterpolationPoint
Un solo punto de interpolación en un formato condicional de gradiente. Estos fijan la escala de colores del gradiente según el color, el tipo y el valor elegidos.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color
|
Es el color que debe usar este punto de interpolación. Obsoleto: Usa |
colorStyle
|
El color que debe usar este punto de interpolación. Si también se establece |
type
|
Cómo se debe interpretar el valor |
value
|
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.
Enumeraciones | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
Es el valor predeterminado, no se debe usar. |
MIN
|
El punto de interpolación usa el valor mínimo en las celdas dentro del rango del formato condicional. |
MAX
|
El punto de interpolación usa el valor máximo en las celdas dentro del rango del formato condicional. |
NUMBER
|
El punto de interpolación usa exactamente el valor de 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 en el rango del formato condicional. Esto equivale a NUMBER si el valor era =PERCENTILE(FLATTEN(range), value / 100) (donde los errores del rango se ignoran durante la compactación).
|
FilterView
Una vista de filtro.
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
|
El rango que abarca esta vista de filtro.
Cuando se escribe, solo se puede establecer uno de |
namedRangeId
|
El rango con nombre del que se respalda esta vista de filtro, si corresponde
Cuando se escribe, solo se puede establecer uno de |
sortSpecs[]
|
Es el orden de clasificación por columna. Las especificaciones posteriores se usan cuando los valores son iguales en las especificaciones anteriores. |
criteria
|
Los criterios para mostrar o ocultar valores por columna. La clave del mapa es el índice de la columna y el valor es el criterio de esa columna.
Este campo dejó de estar disponible y se reemplazó por |
filterSpecs[]
|
Los criterios de filtro para mostrar o ocultar valores por columna.
Tanto |
ProtectedRange
Un rango protegido
Representación JSON |
---|
{ "protectedRangeId": integer, "range": { object ( |
Campos | |
---|---|
protectedRangeId
|
El ID del rango protegido. Este campo es de solo lectura. |
range
|
El rango que se protege. El rango puede no tener límites, en cuyo caso se considera una hoja protegida.
Cuando se escribe, solo se puede establecer uno de |
namedRangeId
|
El rango con nombre del que se respalda este rango protegido, si corresponde
Cuando se escribe, solo se puede establecer uno de |
description
|
La descripción de este rango protegido. |
warningOnly
|
Es verdadero si este rango protegido muestra una advertencia durante la edición. La protección basada en advertencias significa que todos los usuarios pueden editar datos en el rango protegido, excepto que la edición mostrará 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 hojas protegidas. |
editors
|
Los 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 |
Editores
Los editores de un rango protegido.
Representación JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
Campos | |
---|---|
users[]
|
Las direcciones de correo electrónico de los usuarios con acceso de edición al rango protegido |
groups[]
|
Las direcciones de correo electrónico de los grupos con acceso de edición al rango protegido |
domainUsersCanEdit
|
Verdadero si cualquier usuario en el dominio del documento tiene acceso de edición al rango protegido. La protección de dominios solo se admite en documentos dentro de un dominio. |
BasicFilter
Es el filtro predeterminado asociado a una hoja.
Representación JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
El rango que cubre el filtro. |
sortSpecs[]
|
Es el orden de clasificación por columna. Las especificaciones posteriores se usan cuando los valores son iguales en las especificaciones anteriores. |
criteria
|
Los criterios para mostrar o ocultar valores por columna. La clave del mapa es el índice de la columna, y el valor es los criterios para esa columna.
Este campo dejó de estar disponible y se reemplazó por |
filterSpecs[]
|
Los criterios de filtro por columna.
Tanto |
BandedRange
Un rango de bandas (colores alternos) en una hoja.
Representación JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Campos | |
---|---|
bandedRangeId
|
El ID del rango con bandas. |
range
|
Es el rango sobre el que se aplican estas propiedades. |
rowProperties
|
Propiedades de las bandas de fila. Estas propiedades se aplican fila por fila en todas las filas del rango. Se debe especificar al menos uno de los siguientes valores: |
columnProperties
|
Propiedades de las bandas de columnas. Estas propiedades se aplican de forma individual 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:
-
headerColor
yfooterColor
tienen prioridad sobre los colores de las correas. -
firstBandColor
tiene prioridad sobresecondBandColor
. -
rowProperties
tiene 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. De manera similar, el encabezado de la fila tiene prioridad sobre el encabezado de la columna en la celda superior izquierda, pero el encabezado de la columna tiene prioridad sobre el color de la primera fila si no se establece el encabezado.
Representación JSON |
---|
{ "headerColor": { object ( |
Campos | |
---|---|
headerColor
|
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
|
Primer color alternado. (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 completa con |
footerColorStyle
|
El color de la última fila o columna. Si no estableces este campo, la última fila o columna se completará con |
DimensionGroup
Es un grupo sobre un intervalo de filas o columnas en una hoja, que puede contener otros grupos o estar contenido en ellos. Un grupo se puede contraer o expandir como una unidad en la hoja.
Representación JSON |
---|
{
"range": {
object ( |
Campos | |
---|---|
range
|
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á colapsado. Un grupo contraído permanecerá contraído si se expande un grupo superpuesto en una profundidad menor. Un valor verdadero no implica que todas las dimensiones 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 es falso. |
Control de filtro
Un filtro en una hoja
Representación JSON |
---|
{ "slicerId": integer, "spec": { object ( |
Campos | |
---|---|
slicerId
|
Es el ID del control de filtro. |
spec
|
La especificación del cortador |
position
|
Es la posición del filtro. Ten en cuenta que el control de filtro solo se puede colocar en una hoja existente. Además, el ancho y la altura del divisor se pueden ajustar automáticamente para mantenerlo dentro de los límites permitidos. |
SlicerSpec
Las especificaciones de una cortadora.
Representación JSON |
---|
{ "dataRange": { object ( |
Campos | |
---|---|
dataRange
|
El rango de datos del filtro. |
filterCriteria
|
Corresponde a los criterios de filtrado del control de filtro. |
columnIndex
|
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 filtro. |
textFormat
|
Es el formato de texto del título en el filtro. No se admite el campo de vínculo. |
backgroundColor
|
Es el color de fondo del filtro. Obsoleto: Usa |
backgroundColorStyle
|
Es el color de fondo del filtro. Si también se establece |
horizontalAlignment
|
Es la alineación horizontal del título en el control de filtro. Si no se especifica, el valor predeterminado es |