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

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)

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

Es 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)

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

SpreadsheetProperties

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)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Campos
title

string

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

string

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

  • un código de idioma ISO 639-1, como en

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

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

Nota: Cuando se actualiza este campo, no se admiten todas las configuraciones regionales o idiomas.
autoRecalc

enum (RecalculationInterval)

La cantidad de tiempo que se debe esperar antes de que se vuelvan a calcular las funciones volátiles.
timeZone

string

Es 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 a este formato predeterminado. Este campo es de solo lectura.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Determina si se resuelven las referencias circulares y cómo se hace con el cálculo iterativo. La ausencia de este campo significa que las referencias circulares generan errores de cálculo.
spreadsheetTheme

object (SpreadsheetTheme)

Tema aplicado a la hoja de cálculo.
importFunctionsExternalUrlAccessAllowed

boolean

Especifica si se debe permitir el acceso de URL externa para las funciones de imagen y de importación. Solo lectura cuando es verdadero. Si es falso, puedes configurarlo como verdadero. Este valor se omitirá y siempre mostrará un valor verdadero si el administrador habilitó la función de lista de entidades permitidas.

RecalculationInterval

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

Enumeraciones
RECALCULATION_INTERVAL_UNSPECIFIED Valor predeterminado No se debe usar este valor.
ON_CHANGE Las funciones volátiles se actualizan en cada cambio.
MINUTE Las funciones volátiles se actualizan con cada cambio y cada minuto.
HOUR Las funciones volátiles se actualizan cada vez que se realiza un cambio y cada hora.

IterativeCalculationSettings

Configuración para controlar cómo se resuelven las dependencias circulares con un cálculo iterativo.

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

integer

Cuando se habilita el cálculo iterativo, 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 umbral, se detienen las rondas de cálculo.

SpreadsheetTheme

Representa el tema de la hoja de cálculo.

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

string

Es el nombre de la familia de fuentes principal.
themeColors[]

object (ThemeColorPair)

Los pares de colores del tema de la hoja de cálculo Para actualizar, debes proporcionar todos los pares de colores de temas.

ThemeColorPair

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

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

enum (ThemeColorType)

El tipo del color de tema de la hoja de cálculo.
color

object (ColorStyle)

El color concreto correspondiente al tipo de color del tema.

NamedRange

Un rango con nombre

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

string

Es el ID del rango con nombre.
name

string

Es el nombre del rango con nombre.
range

object (GridRange)

El 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 centrado en la 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 de la fuente de datos
sheetId

integer

El ID de Sheet conectado con la fuente de datos. Una vez establecido el campo, no se puede cambiar.

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

DataSourceSpec

Esta opción 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)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Campos
parameters[]

object (DataSourceParameter)

Son 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.
looker

object (LookerDataSourceSpec)

Un [LookerDatasourceSpec][].

BigQueryDataSourceSpec

Es la especificación de una fuente de datos de BigQuery que está 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

El ID de un proyecto de Google Cloud habilitado para BigQuery con una cuenta de facturación adjunta. Se cobrará el proyecto por cada consulta que se ejecute en la fuente de datos.
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

Es 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

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

string

Es el ID de la tabla de BigQuery.
datasetId

string

Es el ID del conjunto de datos de BigQuery.

LookerDataSourceSpec

La especificación de una fuente de datos de Looker.

Representación JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Campos
instanceUri

string

Una URL de instancia de Looker.
model

string

Nombre de un modelo de Looker.
explore

string

Nombre de la exploración de un modelo de Looker.

DataSourceParameter

Es 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. Es 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. El tamaño debe ser 1 x 1.
range

object (GridRange)

Es un rango que contiene el valor del parámetro. El tamaño debe ser 1 x 1.

DataSourceRefreshSchedule

Programa para actualizar la fuente de datos.

Las fuentes de datos de la hoja de cálculo se actualizan dentro de un intervalo de tiempo. Para especificar la hora de inicio, haz clic en el botón Actualización programada en el editor de Hojas de cálculo, pero el intervalo es fijo en 4 horas. Por ejemplo, si especificas la hora de inicio a 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

Es verdadero si está habilitada la programación de actualizaciones. De lo contrario, es falso.
refreshScope

enum (DataSourceRefreshScope)

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

object (Interval)

Solo salida. El intervalo de la próxima ejecución.
Campo de unión schedule_config. La configuración de programación schedule_config solo puede ser una de las siguientes opciones:
dailySchedule

object (DataSourceRefreshDailySchedule)

Programa de actualizaciones diarias.
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.

Enumeraciones
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

Es un programa para que los datos se actualicen todos los días en un intervalo de tiempo 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 la parte hours. 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

Es un programa 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)

Es la hora de inicio de un intervalo de tiempo en el que se programa una actualización de la fuente de datos. Solo se usa la parte hours. 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.

Enumeraciones
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

DataSourceRefreshMonthlySchedule

Es una programación mensual para que los datos se actualicen en días específicos del mes dentro de 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 la parte hours. El tamaño predeterminado del intervalo de tiempo es el que aparece en el editor de Hojas de cálculo.
daysOfMonth[]

integer

Son los días del mes que se actualizarán. Solo se admiten entre 1 y 28, con asignaciones del día 1 al 28. Se debe especificar al menos un día.

Intervalo

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

El inicio debe ser menor o igual que el final. Si el inicio es igual al final, el intervalo estará vacío (no coincide con ningún tiempo). Cuando no se especifican la hora de inicio ni la de finalización, el intervalo coincide con cualquier hora.

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 igual o posterior al inicio.
endTime

string (Timestamp format)

Opcional. Finalización exclusiva 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

 Devuelve la hoja de cálculo en el ID especificado.

getByDataFilter

 Devuelve la hoja de cálculo en el ID especificado.