REST Resource: spreadsheets

Recurso: Hoja de cálculo

Es un 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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
Campos
spreadsheetId

string

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

object (SpreadsheetProperties)

Son las 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)

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

Son los metadatos del desarrollador asociados a una hoja de cálculo.
dataSources[]

object (DataSource)

Es una lista de las fuentes de datos externas conectadas a la hoja de cálculo.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Solo salida. Es una lista de las programaciones de actualización de la fuente de datos.
comments[]

object (CommentThread)

Son los hilos de comentarios asociados con la hoja de cálculo.

commentsViewMode

enum (CommentsViewMode)

Solo salida. Es el modo de vista de comentarios aplicado a la hoja de cálculo.

SpreadsheetProperties

Son las 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 y el código de país según la norma ISO, como en_US

Nota: Cuando actualices este campo, ten en cuenta que no se admiten todos los idiomas ni todas las configuraciones regionales.
autoRecalc

enum (RecalculationInterval)

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

string

Zona horaria de la hoja de cálculo, en formato CLDR, como America/New_York. Si no se reconoce la zona horaria, es posible que se trate de una zona horaria personalizada, como GMT-07:00.
defaultFormat

object (CellFormat)

Es el formato predeterminado de todas las celdas de la hoja de cálculo. CellData.effectiveFormat no se establecerá si el formato de la celda es igual a este formato predeterminado. Este campo es de solo lectura.
iterativeCalculationSettings

object (IterativeCalculationSettings)

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

object (SpreadsheetTheme)

Se aplicó el tema a la hoja de cálculo.
importFunctionsExternalUrlAccessAllowed

boolean

Indica si se permite el acceso a URLs externas para las funciones de importación y de imágenes. Solo lectura cuando es verdadero. Cuando es falso, puedes establecerlo como verdadero. Este valor se omitirá y siempre devolverá verdadero si el administrador habilitó la función de lista de entidades permitidas.

RecalculationInterval

Es una enumeración de las posibles opciones de intervalo de nuevo cálculo.

Enums
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 con cada cambio y cada hora.

IterativeCalculationSettings

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

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

integer

Cuando el cálculo iterativo está habilitado, es la cantidad máxima de rondas de cálculo que se pueden realizar.
convergenceThreshold

number

Cuando se habilita el cálculo iterativo y los resultados sucesivos difieren en menos de este valor de 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)

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

ThemeColorPair

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

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

object (ColorStyle)

Es el color concreto que corresponde al tipo de color del tema.

NamedRange

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

Es el rango que representa.

DataSource

Es 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

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

object (DataSourceSpec)

Es el DataSourceSpec de la fuente de datos conectada a esta hoja de cálculo.
calculatedColumns[]

object (DataSourceColumn)

Son todas las columnas calculadas en la fuente de datos.
sheetId

integer

Es el ID del Sheet conectado con la fuente de datos. Una vez que se establece el campo, no se puede cambiar.

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

DataSourceSpec

Aquí se especifican los detalles de la fuente de datos. Por ejemplo, en el caso de BigQuery, se especifica información sobre la fuente de BigQuery.

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

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
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. Es la especificación real por tipo de fuente de datos. spec puede ser solo uno de los parámetros siguientes:
bigQuery

object (BigQueryDataSourceSpec)

Un objeto BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

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

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
Campos
projectId

string

Es el ID de un proyecto de Google Cloud habilitado para BigQuery con una cuenta de facturación adjunta. Se cobra el proyecto por cada consulta que se ejecute en la fuente de datos.
Campo de unión spec. Es la especificación real. spec puede ser solo uno de los parámetros siguientes:
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

Es la especificación de una fuente de datos de Looker.

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

string

Es la URL de una instancia de Looker.
model

string

Nombre de un modelo de Looker.
explore

string

Nombre de una exploración del modelo de Looker.

DataSourceParameter

Es un parámetro en la consulta de una fuente de datos. El parámetro permite que el usuario pase valores de la hoja de cálculo a una consulta.

Representación JSON 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
Campos
Campo de unión identifier. Es el identificador del parámetro. identifier puede ser solo uno de los parámetros siguientes:
name

string

Es un 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. value puede ser solo uno de los parámetros siguientes:
namedRangeId

string

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

object (GridRange)

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

DataSourceRefreshSchedule

Es la programación para actualizar la fuente de datos.

Las fuentes de datos de la hoja de cálculo se actualizan dentro de un intervalo de tiempo. Puedes especificar la hora de inicio haciendo clic en el botón 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 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)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
Campos
enabled

boolean

Es verdadero si el programa de actualización está habilitado; de lo contrario, es falso.
refreshScope

enum (DataSourceRefreshScope)

Es el alcance de la actualización. Debe ser ALL_DATA_SOURCES.
nextRun

object (Interval)

Solo salida. Intervalo de tiempo de la próxima ejecución.
Campo de unión schedule_config. Las configuraciones de programación schedule_config solo pueden ser una de las siguientes:
dailySchedule

object (DataSourceRefreshDailySchedule)

Programación de actualización diaria.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programa de actualización semanal.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Programa de actualización mensual.

DataSourceRefreshScope

Son los alcances de actualización de la fuente de datos.

Enums
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Es un valor predeterminado que no se debe 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 una programación 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)

Es 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 se establece de forma predeterminada en el 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 de un día en formato de 24 horas. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.
minutes

integer

Minutos de una hora. Debe ser mayor o igual que 0 y menor o igual que 59.
seconds

integer

Segundos de un minuto. Debe ser mayor o igual que 0 y, por lo general, menor o igual que 59. Una API puede permitir el valor 60 si permite segundos bisiestos.
nanos

integer

Fracciones de segundos, en nanosegundos. Debe ser mayor o igual que 0 y menor o igual que 999,999,999.

DataSourceRefreshWeeklySchedule

Es un programa semanal para que los datos se actualicen en días específicos dentro de 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 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 se establece de forma predeterminada en el 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 un programa mensual para actualizar los datos 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)

Es 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 se establece de forma predeterminada en el editor de Hojas de cálculo.
daysOfMonth[]

integer

Días del mes para actualizar. Solo se admiten los números del 1 al 28, que corresponden del 1ᵉʳ al 28º día. Se debe especificar al menos un día.

Intervalo

Representa un intervalo de tiempo, codificado como una marca de tiempo de inicio (inclusiva) y una marca de tiempo de finalización (exclusiva).

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 ninguna hora). Cuando no se especifican el inicio ni el final, el intervalo coincide con cualquier hora.

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

string (Timestamp format)

Opcional. Es el inicio inclusivo del intervalo.

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

string (Timestamp format)

Opcional. Es el final exclusivo del intervalo.

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

CommentThread

Representa un solo subproceso de comentarios dentro de una hoja de cálculo.

Representación JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Campos
commentId

string

Es el ID único del subproceso de comentarios.
anchorId

string

Es el ID del objeto CommentAnchor en la hoja a la que está vinculado este subproceso.
headPost

object (Post)

Es la primera publicación del hilo.
replies[]

object (Post)

Son las respuestas a la publicación principal.
status

enum (Status)

Indica si el hilo está abierto o resuelto.
Campo de unión quote. Es el texto citado del documento cuando se creó el comentario. quote puede ser solo uno de los parámetros siguientes:
plainTextQuote

string

El texto citado de la hoja de cálculo cuando se creó el comentario, con formato de texto sin formato.

Publicar

Representa una sola publicación en un hilo de comentarios.

Representación JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
Campos
postId

string

Solo salida. Es el ID único de la publicación.
content

string

Es el contenido de la publicación.

Debe no estar vacío si commentAction no es RESOLVE ni REOPEN.

Este contenido de texto se manejará de manera similar a los comentarios creados en el editor de Hojas de cálculo. Tendrá comportamientos similares para el formato, las notificaciones, etcétera.

No puede superar las 2,048 unidades de código UTF-8.
contentHtml

string

Solo salida. Es el contenido de la publicación en formato HTML.
author

object (PostAuthor)

Solo salida. Es el usuario que creó la publicación.
createTime

string (Timestamp format)

Solo salida. Fecha y hora en que se creó la publicación.
updateTime

string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó la publicación por última vez.
deleted

boolean

Solo salida. Indica si se borró la publicación. Los campos true, content y author estarán vacíos.
fromImportedSpreadsheet

boolean

Solo salida. Indica si la publicación proviene de una hoja de cálculo importada. Los llamadores no pueden establecer este campo directamente.
fromCopiedSpreadsheet

boolean

Solo salida. Indica si la publicación proviene de una hoja de cálculo copiada. Los llamadores no pueden establecer este campo directamente.
assigneeEmail

string

Opcional. Es el correo electrónico del usuario que se asigna al hilo como parte de esta publicación.

Devuelve un error 400 de solicitud incorrecta en los siguientes casos:

  • El subproceso principal es un CommentThread cuyo headPost no tiene un asignatario.

  • commentAction se especifica como RESOLVE o REOPEN.

  • assigneeEmail supera las 2,048 unidades de código UTF-8.
commentAction

enum (CommentActionType)

Es la acción que se realiza como parte de la creación de la publicación.

PostAuthor

Representa a un usuario que escribió una publicación de comentario.

Representación JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Campos
displayName

string

Es el nombre visible del usuario. Puede no estar presente si el autor es anónimo.
me

boolean

Indica si el usuario es el usuario autenticado que realiza la solicitud.
anonymous

boolean

Indica si el usuario es anónimo.
user

string

Es el nombre del recurso del usuario autor de la publicación, que también se puede usar para identificar al usuario en la API de Google People. Formato: users/{user}. No se propagará si el campo anónimo es true o si la publicación proviene de una hoja de cálculo importada.

CommentActionType

Es la acción que se realizó con esta respuesta a un hilo de comentarios.

Enums
COMMENT_ACTION_TYPE_UNSPECIFIED Valor predeterminado Este valor no se usa.
NO_COMMENT_ACTION_CHANGE No hay cambios en las acciones de esta publicación.
RESOLVE Esta publicación resuelve el hilo.
REOPEN Esta publicación vuelve a abrir el hilo.

Estado

Son las opciones de estado del hilo de comentarios.

Enums
STATUS_UNSPECIFIED Valor predeterminado Este valor no se usa.
OPEN El hilo de comentarios está abierto.
RESOLVED Se resolvió el hilo de comentarios.

CommentsViewMode

Es el modo de vista de comentarios aplicado a la hoja de cálculo que indica si se incluyen comentarios. Proporciona opciones para leer la hoja de cálculo con o sin comentarios y anclajes de comentarios.

Enums
COMMENTS_VIEW_MODE_UNSPECIFIED El CommentsViewMode no está especificado; se aplica COMMENTS_VIEW_MODE_OMITTED.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS El CommentsViewMode que se aplica a la hoja de cálculo devuelta depende del nivel de acceso actual del usuario. Si el usuario solo tiene acceso de lectura, se aplica COMMENTS_VIEW_MODE_OMITTED. De lo contrario, se aplica COMMENTS_VIEW_MODE_INCLUDED.
COMMENTS_VIEW_MODE_OMITTED La hoja de cálculo que se devolvió no incluye comentarios.
COMMENTS_VIEW_MODE_INCLUDED

La hoja de cálculo que se devolvió incluye comentarios.

Las solicitudes para recuperar una hoja de cálculo con este modo mostrarán un error 403 si el usuario no tiene permiso para ver comentarios.

Métodos

batchUpdate

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

create

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

get

 Devuelve la hoja de cálculo con el ID determinado.

getByDataFilter

 Devuelve la hoja de cálculo con el ID determinado.