REST Resource: spreadsheets

Recurso: Hoja de cálculo

Recurso que representa una hoja de cálculo.

Representación JSON
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
Campos
spreadsheetId

string

Es el ID de la hoja de cálculo. Este campo es de solo lectura.

properties

object (SpreadsheetProperties)

Propiedades generales de una hoja de cálculo

sheets[]

object (Sheet)

Son las hojas que forman parte de una hoja de cálculo.

namedRanges[]

object (NamedRange)

Los rangos con nombre definidos en una hoja de cálculo.

spreadsheetUrl

string

La URL de la hoja de cálculo. Este campo es de solo lectura.

developerMetadata[]

object (DeveloperMetadata)

Los metadatos del desarrollador asociados con una hoja de cálculo.

dataSources[]

object (DataSource)

Una lista de fuentes de datos externas conectadas con la hoja de cálculo.

dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Solo salida. Una lista de programas de actualización de fuentes de datos.

Propiedades de la hoja de cálculo

Propiedades de una hoja de cálculo

Representación JSON
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
Campos
title

string

Es el título de la hoja de cálculo.

locale

string

La configuración regional de la hoja de cálculo en uno de los siguientes formatos:

  • Un código de lenguaje ISO 639-1, como en

  • Un código de idioma ISO 639-2, como fil, si no existe un código de este tipo

  • una combinación del código de idioma ISO y el código de país, como en_US

Nota: Cuando actualizas este campo, no se admiten todos los idiomas o configuraciones regionales.

autoRecalc

enum (RecalculationInterval)

El tiempo que se debe esperar para que se vuelvan a calcular las funciones volátiles.

timeZone

string

La zona horaria de la hoja de cálculo, en formato CLDR como America/New_York. Si no se reconoce la zona horaria, puede ser una zona horaria personalizada, como GMT-07:00.

defaultFormat

object (CellFormat)

El formato predeterminado de todas las celdas en la hoja de cálculo. No se establecerá CellData.effectiveFormat si el formato de la celda es igual al predeterminado. Este campo es de solo lectura.

iterativeCalculationSettings

object (IterativeCalculationSettings)

Determina si las referencias circulares se resuelven con el cálculo iterativo y de qué manera. La ausencia de este campo significa que las referencias circulares dan como resultado errores de cálculo.

spreadsheetTheme

object (SpreadsheetTheme)

Tema aplicado a la hoja de cálculo

Intervalo de recálculo

Una enumeración de las posibles opciones de intervalo de recálculo.

Enumeradores
RECALCULATION_INTERVAL_UNSPECIFIED Valor predeterminado No se debe usar este valor.
ON_CHANGE Las funciones volátiles se actualizan con cada cambio.
MINUTE Las funciones volátiles se actualizan con cada cambio y cada minuto.
HOUR Las funciones volátiles se actualizan en cada cambio y por hora.

Configuración de cálculos de iteración

Configuración para controlar cómo se resuelven las dependencias circulares con cálculos iterativos.

Representación JSON
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Campos
maxIterations

integer

Cuando el cálculo iterativo está habilitado, la cantidad máxima de cálculos que se realizarán

convergenceThreshold

number

Cuando se habilita el cálculo iterativo y los resultados sucesivos difieren en menos de este valor de umbral, se detienen los cálculos.

Tema de hoja de cálculo

Representa el tema de una hoja de cálculo

Representación JSON
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Campos
primaryFontFamily

string

Nombre de la familia de fuentes principal

themeColors[]

object (ThemeColorPair)

Pares de colores del tema de la hoja de cálculo. Para actualizarlo, debes proporcionar todos los pares de colores del tema.

Tema de color

Un par asigna el tipo de color de un tema de hoja de cálculo al color concreto que representa.

Representación JSON
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Campos
colorType

enum (ThemeColorType)

Es el tipo de color del tema de la hoja de cálculo.

color

object (ColorStyle)

El color concreto que corresponde al tipo de color del tema.

RangoNombre

Un rango con nombre.

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

string

El ID del rango con nombre.

name

string

El nombre del rango con nombre.

range

object (GridRange)

Rango que representa

DataSource

Información sobre una fuente de datos externa en la hoja de cálculo.

Representación JSON
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Campos
dataSourceId

string

El ID único con alcance de hoja de cálculo que identifica la fuente de datos. Ejemplo: 1080547365.

spec

object (DataSourceSpec)

El DataSourceSpec de la fuente de datos conectada con esta hoja de cálculo.

calculatedColumns[]

object (DataSourceColumn)

Todas las columnas calculadas en la fuente de datos.

sheetId

integer

Es el ID de Sheet conectado a la fuente de datos. Una vez que configures el campo, no podrás cambiarlo.

Cuando se crea una fuente de datos, también se crea una hoja de DATA_SOURCE asociada. Si no se especifica el campo, se generará de forma aleatoria el ID de la hoja creada.

DataSourceSpec

Esto especifica los detalles de la fuente de datos. Por ejemplo, para BigQuery, esto especifica información sobre la fuente de BigQuery.

Representación JSON
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Campos
parameters[]

object (DataSourceParameter)

Los parámetros de la fuente de datos, que se usan cuando se consulta la fuente de datos.

Campo de unión spec. La especificación real por tipo de fuente de datos. Las direcciones (spec) solo pueden ser una de las siguientes opciones:
bigQuery

object (BigQueryDataSourceSpec)

Un objeto BigQueryDataSourceSpec.

BigQueryDataSourceSpec.

La especificación de una fuente de datos de BigQuery conectada a una hoja.

Representación JSON
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
Campos
projectId

string

Es el ID de un proyecto de Google Cloud habilitado para BigQuery con una cuenta de facturación adjunta. En el caso de las consultas ejecutadas en la fuente de datos, se cobra el proyecto.

Campo de unión spec. La especificación real. Las direcciones (spec) solo pueden ser una de las siguientes opciones:
querySpec

object (BigQueryQuerySpec)

Un objeto BigQueryQuerySpec.

tableSpec

object (BigQueryTableSpec)

Un objeto BigQueryTableSpec.

BigQueryQuerySpec

Especifica una consulta personalizada de BigQuery.

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

string

La cadena de consulta sin procesar.

BigQueryTableSpec

Especifica una definición de tabla de BigQuery. Solo se permiten las tablas nativas.

Representación JSON
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Campos
tableProjectId

string

ID de un proyecto de BigQuery al que pertenece la tabla. Si no se especifica, se supone que es projectId.

tableId

string

El ID de la tabla de BigQuery.

datasetId

string

Es el ID del conjunto de datos de BigQuery.

DataSourceParameter

Un parámetro en la consulta de una fuente de datos. El parámetro le permite al usuario pasar valores de la hoja de cálculo a una consulta.

Representación JSON
{

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

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
Campos
Campo de unión identifier. El identificador del parámetro. Las direcciones (identifier) solo pueden ser una de las siguientes opciones:
name

string

Parámetro con nombre. Debe ser un identificador legítimo para el DataSource que lo admite. Por ejemplo, identificador de BigQuery.

Campo de unión value. Es el valor del parámetro. Las direcciones (value) solo pueden ser una de las siguientes opciones:
namedRangeId

string

Es el ID de un NamedRange. Su tamaño debe ser de 1 x 1.

range

object (GridRange)

Un rango que contiene el valor del parámetro. Su tamaño debe ser de 1 x 1.

DataSourceRefreshSchedule

Programa para actualizar la fuente de datos.

Las fuentes de datos de la hoja de cálculo se actualizan en un intervalo de tiempo. Puede especificar la hora de inicio haciendo clic en el botón de actualización programada en el editor de Hojas de cálculo, pero el intervalo se fija en 4 horas. Por ejemplo, si especificas una hora de inicio de las 8 a.m., la actualización se realizará entre las 8 a.m. y las 12 p.m. todos los días.

Representación JSON
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
Campos
enabled

boolean

Verdadero si el programa de actualización está habilitado o falso de lo contrario.

refreshScope

enum (DataSourceRefreshScope)

El alcance de la actualización. Debe ser ALL_DATA_SOURCES.

nextRun

object (Interval)

Solo salida. El intervalo de tiempo de la próxima ejecución.

Campo de unión schedule_config. La configuración del programa schedule_config puede ser solo una de las siguientes opciones:
dailySchedule

object (DataSourceRefreshDailySchedule)

Programa de actualización diario.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programa de actualización semanal.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Programa de actualización mensual.

DataSourceRefreshScope

Los permisos de actualización de la fuente de datos

Enumeradores
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Valor predeterminado, no usar.
ALL_DATA_SOURCES Actualiza todas las fuentes de datos y sus objetos de fuente de datos asociados en la hoja de cálculo.

DataSourceRefreshDailySchedule

Una programación de actualización de datos para todos los días en un período determinado.

Representación JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

La hora de inicio de un intervalo en el que se programa una actualización de la fuente de datos. Solo se usa hours parte. El tamaño del intervalo de tiempo predeterminado es el del editor de Hojas de cálculo.

TimeOfDay

Representa una hora del día. La fecha y la zona horaria no son significativas o se especifican en otro lugar. Una API puede optar por permitir segundos bisiestos. Los tipos relacionados son google.type.Date y google.protobuf.Timestamp.

Representación JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas del día en formato de 24 horas. Debe ser del 0 al 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.

minutes

integer

Minutos de horas del día. Debe ser un valor entre 0 y 59.

seconds

integer

Segundos de minutos de la hora. Por lo general, debe ser un valor entre 0 y 59. Una API puede permitir el valor 60 si permite segundos bisiestos.

nanos

integer

Fracciones de segundos en nanosegundos. Debe ser un valor entre 0 y 999,999,999.

DataSourceRefreshWeeklySchedule.

Una programación semanal para que los datos se actualicen en días específicos en un intervalo de tiempo determinado.

Representación JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Campos
startTime

object (TimeOfDay)

La hora de inicio de un intervalo en el que se programa una actualización de la fuente de datos. Solo se usa hours parte. El tamaño del intervalo de tiempo predeterminado es el del editor de Hojas de cálculo.

daysOfWeek[]

enum (DayOfWeek)

Días de la semana para actualizar Se debe especificar, al menos, un día.

DayOfWeek

Representa un día de la semana.

Enumeradores
DAY_OF_WEEK_UNSPECIFIED No se especifica el día de la semana.
MONDAY Lunes
TUESDAY Martes
WEDNESDAY miércoles".
THURSDAY Jueves
FRIDAY Viernes
SATURDAY Sábado
SUNDAY Domingo

DataSourceRefreshMonthSchedule

Una programación mensual para que los datos se actualicen en días específicos del mes en un intervalo de tiempo determinado.

Representación JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Campos
startTime

object (TimeOfDay)

La hora de inicio de un intervalo en el que se programa una actualización de la fuente de datos. Solo se usa hours parte. El tamaño del intervalo de tiempo predeterminado es el del editor de Hojas de cálculo.

daysOfMonth[]

integer

Días del mes para actualizar Solo se admiten de 1 a 28, que se asignan al día 1 al día 28. Se debe especificar, al menos, un día.

Intervalo

Representa un intervalo de tiempo, codificado como un inicio de marca de tiempo (inclusive) y un final de marca de tiempo (exclusivo).

El inicio debe ser menor o igual que el final. Cuando el inicio es igual al final, el intervalo está vacío (no coincide con ningún momento). Cuando no se especifican el inicio y el final, el intervalo coincide en cualquier momento.

Representación JSON
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Opcional. Inicio inclusivo del intervalo.

Si se especifica, una marca de tiempo que coincida con este intervalo deberá ser la misma o posterior al inicio.

endTime

string (Timestamp format)

Opcional. Final exclusivo del intervalo.

Si se especifica, una marca de tiempo que coincida con este intervalo deberá ser anterior al final.

Métodos

batchUpdate

Aplica una o más actualizaciones a la hoja de cálculo.

create

Crea una hoja de cálculo y muestra la hoja de cálculo recién creada.

get

Muestra la hoja de cálculo con el ID dado.

getByDataFilter

Muestra la hoja de cálculo con el ID dado.