REST Resource: spreadsheets

Recurso: planilha

Recurso que representa uma planilha.

Representação 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

O ID da planilha. Este campo é somente leitura.
properties

object (SpreadsheetProperties)

Propriedades gerais de uma planilha.
sheets[]

object (Sheet)

As páginas que são parte de uma planilha.
namedRanges[]

object (NamedRange)

Os intervalos nomeados definidos em uma planilha.
spreadsheetUrl

string

O URL da planilha. Este campo é somente leitura.
developerMetadata[]

object (DeveloperMetadata)

Os metadados do desenvolvedor associados a uma planilha.
dataSources[]

object (DataSource)

Uma lista de fontes de dados externas conectadas à planilha.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Apenas saída. Uma lista de programações de atualização da fonte de dados.

Propriedades da planilha

Propriedades de uma planilha.

Representação JSON 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
Campos
title

string

O título da planilha.
locale

string

A localidade da planilha em um dos seguintes formatos:

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

  • um código de idioma ISO 639-2, como fil, se não existir um código de idioma 639-1

  • uma combinação do código de idioma ISO e do código do país, como en_US

Observação: Nem todos os locais/idiomas são compatíveis com a atualização deste campo.
autoRecalc

enum (RecalculationInterval)

O tempo a ser aguardado antes de as funções voláteis serem recalculadas.
timeZone

string

O fuso horário da planilha, no formato CLDR, como America/New_York. Se o fuso horário não for reconhecido, ele pode ser personalizado, como GMT-07:00.
defaultFormat

object (CellFormat)

O formato padrão de todas as células na planilha. CellData.effectiveFormat não será definido se o formato da célula for igual a esse formato padrão. Este campo é somente leitura.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Determina se e como as referências circulares são resolvidas com cálculo iterativo. A ausência desse campo significa que referências circulares resultam em erros de cálculo.
spreadsheetTheme

object (SpreadsheetTheme)

Tema aplicado à planilha.

Intervalo de recálculo

Uma enumeração das possíveis opções de intervalo de recálculo.

Enums
RECALCULATION_INTERVAL_UNSPECIFIED Valor padrão. Este valor não pode ser usado.
ON_CHANGE As funções voláteis são atualizadas a cada alteração.
MINUTE As funções voláteis são atualizadas a cada minuto e alteração.
HOUR As funções voláteis são atualizadas a cada hora e a cada alteração.

Configurações de cálculo de iteração

Configurações para controlar como as dependências circulares são resolvidas com cálculo iterativo.

Representação JSON 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Campos
maxIterations

integer

Quando o cálculo iterativo está ativado, o número máximo de rodadas de cálculo a serem realizadas.
convergenceThreshold

number

Quando o cálculo iterativo está ativado e os resultados sucessivos diferem menos do que esse valor limite, as rodadas de cálculo são interrompidas.

Tema da planilha

Representa o tema da planilha

Representação JSON 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Campos
primaryFontFamily

string

Nome da família de fontes principal.
themeColors[]

object (ThemeColorPair)

Os pares de cores do tema da planilha. Para atualizar, é necessário fornecer todos os pares de cores do tema.

ThemeColorPair

Um par mapeando um tipo de cor de tema de planilha para a cor concreta que ele representa.

Representação JSON 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Campos
colorType

enum (ThemeColorType)

É o tipo de cor do tema da planilha.
color

object (ColorStyle)

A cor concreta correspondente ao tipo de cor do tema.

Intervalo nomeado

Um intervalo nomeado.

Representação JSON 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Campos
namedRangeId

string

O ID do intervalo nomeado.
name

string

O nome do intervalo nomeado.
range

object (GridRange)

O intervalo que ele representa.

DataSource

Informações sobre uma fonte de dados externa na planilha.

Representação JSON 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Campos
dataSourceId

string

O ID exclusivo do escopo da planilha que identifica a fonte de dados. Exemplo: 1080547365.
spec

object (DataSourceSpec)

O DataSourceSpec da fonte de dados conectada a esta planilha.
calculatedColumns[]

object (DataSourceColumn)

Todas as colunas calculadas na fonte de dados.
sheetId

integer

O ID do Sheet conectado à fonte de dados. Depois de definido, o campo não pode ser alterado.

Ao criar uma fonte de dados, uma página DATA_SOURCE associada também é criada. Se o campo não for especificado, o ID da página criada será gerado aleatoriamente.

DataSourceSpec

Especifica os detalhes da fonte de dados. Por exemplo, no BigQuery, isso especifica informações sobre a origem do BigQuery.

Representação 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)

Os parâmetros da fonte de dados, usados ao consultar a fonte de dados.
Campo de união spec. A especificação real por tipo de fonte de dados. spec pode ser apenas de um dos tipos a seguir:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.

BigQueryDataSourceSpec

A especificação de uma fonte de dados do BigQuery conectada a uma página.

Representação 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

O ID de um projeto do Google Cloud ativado para BigQuery com uma conta de faturamento anexada. Para as consultas executadas na fonte de dados, o projeto é cobrado.
Campo de união spec. A especificação real. spec pode ser apenas de um dos tipos a seguir:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec.

BigQueryQuerySpec

Especifica uma consulta personalizada do BigQuery.

Representação JSON 
{
  "rawQuery": string
}
Campos
rawQuery

string

A string de consulta bruta.

Tabela do BigQuery

Especifica uma definição de tabela do BigQuery. Somente tabelas nativas são permitidas.

Representação JSON 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Campos
tableProjectId

string

O ID de um projeto do BigQuery ao qual a tabela pertence. Se não for especificado, o projectId será usado.
tableId

string

O código da tabela do BigQuery.
datasetId

string

O ID do conjunto de dados do BigQuery.

DataSourceParameter

Um parâmetro na consulta de uma fonte de dados. O parâmetro permite que o usuário insira valores da planilha em uma consulta.

Representação 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ão identifier. O identificador de parâmetro. identifier pode ser apenas de um dos tipos a seguir:
name

string

Parâmetro nomeado. Precisa ser um identificador legítimo da DataSource compatível. Por exemplo, identificador do BigQuery.
Campo de união value. O valor do parâmetro. value pode ser apenas de um dos tipos a seguir:
namedRangeId

string

ID de um NamedRange. O tamanho precisa ser 1x1.
range

object (GridRange)

Um intervalo que contém o valor do parâmetro. O tamanho precisa ser 1x1.

DataSourceRefreshSchedule (em inglês)

Programe para atualizar a fonte de dados.

As fontes de dados na planilha são atualizadas em um intervalo de tempo. Para especificar o horário de início, clique no botão "Atualização programada" no editor do Planilhas, mas o intervalo será fixado em quatro horas. Por exemplo, se você especificar um horário de início às 8h, a atualização ocorrerá todos os dias, das 8h às 12h.

Representação 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

Verdadeiro se a programação de atualização estiver ativada. Caso contrário, será falso.
refreshScope

enum (DataSourceRefreshScope)

O escopo da atualização. Precisa ser ALL_DATA_SOURCES.
nextRun

object (Interval)

Apenas saída. O intervalo de tempo da próxima execução.
Campo de união schedule_config. As configurações de programação schedule_config só podem ser uma das seguintes:
dailySchedule

object (DataSourceRefreshDailySchedule)

Programação de atualização diária.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programação de atualização semanal.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Programação de atualização mensal.

DataSourceRefreshScope

Os escopos de atualização da fonte de dados.

Enums
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Valor padrão, não use.
ALL_DATA_SOURCES Atualiza todas as fontes de dados e os objetos associados a elas na planilha.

DataSourceRefreshDailySchedule

Uma programação para os dados serem atualizados todos os dias em um determinado intervalo de tempo.

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

O horário de início de um intervalo de tempo em que uma atualização da fonte de dados está programada. Somente hours parte é usada. O tamanho padrão do intervalo é o do editor do Planilhas.

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas do dia no formato de 24 horas. Precisa ser de 0 a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos da hora do dia. Precisa ser de 0 a 59.
seconds

integer

Segundos do minutos do horário. Normalmente precisa ser de 0 a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos em nanossegundos. Precisa ser de 0 a 999.999.999.

DataSourceRefreshSemanal

Uma programação semanal para que os dados sejam atualizados em dias específicos em um determinado período.

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Campos
startTime

object (TimeOfDay)

O horário de início de um intervalo de tempo em que uma atualização da fonte de dados está programada. Somente hours parte é usada. O tamanho padrão do intervalo é o do editor do Planilhas.
daysOfWeek[]

enum (DayOfWeek)

Dias da semana a serem atualizados. Pelo menos um dia deve ser especificado.

DayOfWeek

Representa um dia da semana.

Enums
DAY_OF_WEEK_UNSPECIFIED O dia da semana não é especificado.
MONDAY Segunda-feira
TUESDAY Terça-feira
WEDNESDAY Quarta-feira
THURSDAY Quinta-feira
FRIDAY Sexta-feira
SATURDAY Sábado
SUNDAY Domingo

DataSourceRefreshMonthlySchedule

Uma programação mensal para que os dados sejam atualizados em dias específicos do mês em um determinado período.

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Campos
startTime

object (TimeOfDay)

O horário de início de um intervalo de tempo em que uma atualização da fonte de dados está programada. Somente hours parte é usada. O tamanho padrão do intervalo é o do editor do Planilhas.
daysOfMonth[]

integer

Dias do mês a serem atualizados. Somente os números de 1 a 28 são compatíveis, com mapeamento do 1o ao 28o dia. Pelo menos um dia deve ser especificado.

Intervalo

Representa um intervalo de tempo, codificado como um início de carimbo de data/hora (inclusivo) e um fim de carimbo de data/hora (exclusivo).

O início precisa ser menor ou igual ao final. Quando o início é igual ao final, o intervalo fica vazio (não corresponde a nenhum horário). Quando o início e o fim não são especificados, o intervalo corresponde a qualquer momento.

Representação JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Opcional. Início inclusivo do intervalo.

Se especificado, um carimbo de data/hora que corresponde a esse intervalo terá que ser o mesmo ou depois do início.
endTime

string (Timestamp format)

Opcional. Fim exclusivo do intervalo.

Se especificado, um carimbo de data/hora que corresponde a esse intervalo terá que ser antes do final.

Métodos

batchUpdate

 Aplica uma ou mais atualizações à planilha.

create

 Cria uma planilha, retornando a planilha recém-criada.

get

 Retorna a planilha no ID fornecido.

getByDataFilter

 Retorna a planilha no ID fornecido.