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

SpreadsheetProperties

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)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
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 houver um código 639-1

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

Observação: ao atualizar esse campo, nem todas as localidades/idiomas são compatíveis.
autoRecalc

enum (RecalculationInterval)

O tempo de espera antes que as funções voláteis sejam 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 as referências circulares resultam em erros de cálculo.
spreadsheetTheme

object (SpreadsheetTheme)

Tema aplicado à planilha.
importFunctionsExternalUrlAccessAllowed

boolean

Permite o acesso a URLs externos para funções de imagem e importação. Somente leitura quando verdadeiro. Quando for falso, defina como verdadeiro. Esse valor será ignorado e sempre retornará verdadeiro se o administrador tiver ativado o recurso de inclusão na lista de permissões.

RecalculationInterval

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

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

IterativeCalculationSettings

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

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 é ativado e os resultados sucessivos diferem em menos do que esse valor de limite, as rodadas de cálculo são interrompidas.

SpreadsheetTheme

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, você precisa fornecer todos os pares de cores do tema.

ThemeColorPair

Um par que mapeia 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.

NamedRange

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 isso 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 no 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. O campo não pode ser alterado depois de definido.

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

DataSourceSpec

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

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

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)

É um BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

Um [LookerDatasourceSpec][].

BigQueryDataSourceSpec

A especificação de uma origem de dados do BigQuery conectada a uma planilha.

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 com o BigQuery ativado e uma conta de faturamento anexada. Para todas 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)

É um BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

É um BigQueryTableSpec.

BigQueryQuerySpec

Especifica uma consulta personalizada do BigQuery.

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

string

A string de consulta bruta.

BigQueryTableSpec

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, projectId será usado.
tableId

string

O ID da tabela do BigQuery.
datasetId

string

O ID do conjunto de dados do BigQuery.

LookerDataSourceSpec

A especificação de uma fonte de dados do Looker.

Representação JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Campos
instanceUri

string

Um URL da instância do Looker.
model

string

Nome de um modelo do Looker.
explore

string

Nome de uma análise de modelo do Looker.

DataSourceParameter

Um parâmetro na consulta de uma fonte de dados. O parâmetro permite que o usuário transmita valores da planilha para 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 do parâmetro. identifier pode ser apenas de um dos tipos a seguir:
name

string

Parâmetro nomeado. Precisa ser um identificador legítimo para o DataSource que o oferece. 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 uma NamedRange. O tamanho precisa ser 1 x 1.
range

object (GridRange)

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

DataSourceRefreshSchedule

Programe a atualização da fonte de dados.

As fontes de dados na planilha são atualizadas em um intervalo de tempo. É possível especificar o horário de início clicando no botão "Atualização programada" no editor do Planilhas, mas o intervalo é fixado em 4 horas. Por exemplo, se você especificar um horário de início às 8h , a atualização vai ocorrer entre 8h e 12h todos os dias.

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 ou falso, caso contrário.
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 podem ser apenas uma das seguintes opções:
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 na planilha.

DataSourceRefreshDailySchedule

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

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

object (TimeOfDay)

É a hora de início de um intervalo em que uma atualização da fonte de dados está programada. Somente a parte hours é usada. O tamanho do intervalo de tempo é padrão no 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 de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e normalmente precisa ser menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59.
seconds

integer

Segundos de um minuto. Precisa ser maior ou igual a 0 e normalmente precisa ser menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999.

DataSourceRefreshWeeklySchedule

Uma programação semanal para atualizar dados em dias específicos em um determinado intervalo de tempo.

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

object (TimeOfDay)

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

enum (DayOfWeek)

Dias da semana para atualizar. É necessário especificar pelo menos um dia.

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 atualizar dados em dias específicos do mês em um determinado intervalo de tempo.

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

object (TimeOfDay)

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

integer

Dias do mês para atualizar. Somente os dias de 1 a 28 são aceitos, mapeando para o dia 1 ao 28. É necessário especificar pelo menos um dia.

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 fim. Quando o início é igual ao fim, o intervalo fica vazio (não corresponde a nenhum horário). Quando o início e o término não são especificados, o intervalo corresponde a qualquer horário.

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 correspondente a esse intervalo precisa ser igual ou posterior ao início.
endTime

string (Timestamp format)

Opcional. Término exclusivo do intervalo.

Se especificado, um carimbo de data/hora correspondente a esse intervalo precisa ser anterior ao fim.

Métodos

batchUpdate

 Aplica uma ou mais atualizações à planilha.

create

 Cria uma planilha e a retorna.

get

 Retorna a planilha com o ID fornecido.

getByDataFilter

 Retorna a planilha com o ID fornecido.