- Recurso: planilha
- SpreadsheetProperties
- RecalculationInterval
- CellFormat
- NumberFormat
- NumberFormatType
- Color
- ColorStyle
- ThemeColorType
- Bordas
- Borda
- Estilo
- Espaçamento
- HorizontalAlign
- VerticalAlign
- WrapStrategy
- TextDirection
- TextFormat
- Vincular
- HyperlinkDisplayType
- TextRotation
- IterativeCalculationSettings
- SpreadsheetTheme
- ThemeColorPair
- Planilha
- SheetProperties
- SheetType
- GridProperties
- DataSourceSheetProperties
- DataSourceColumn
- DataSourceColumnReference
- DataExecutionStatus
- DataExecutionState
- DataExecutionErrorCode
- GridData
- RowData
- CellData
- ExtendedValue
- ErrorValue
- ErrorType
- TextFormatRun
- DataValidationRule
- BooleanCondition
- ConditionType
- ConditionValue
- RelativeDate
- PivotTable
- GridRange
- PivotGroup
- PivotGroupValueMetadata
- SortOrder
- PivotGroupSortValueBucket
- PivotGroupRule
- ManualRule
- ManualRuleGroup
- HistogramRule
- DateTimeRule
- DateTimeRuleType
- PivotGroupLimit
- PivotFilterCriteria
- PivotFilterSpec
- PivotValue
- PivotValueSummarizeFunction
- PivotValueCalculatedDisplayType
- PivotValueLayout
- DataSourceTable
- DataSourceTableColumnSelectionType
- FilterSpec
- FilterCriteria
- SortSpec
- DataSourceFormula
- DimensionProperties
- ConditionalFormatRule
- BooleanRule
- GradientRule
- InterpolationPoint
- InterpolationPointType
- FilterView
- ProtectedRange
- Editores
- BasicFilter
- EmbeddedChart
- ChartSpec
- TextPosition
- DataSourceChartProperties
- BasicChartSpec
- BasicChartType
- BasicChartLegendPosition
- BasicChartAxis
- BasicChartAxisPosition
- ChartAxisViewWindowOptions
- ViewWindowMode
- BasicChartDomain
- ChartData
- ChartSourceRange
- ChartGroupRule
- ChartDateTimeRule
- ChartDateTimeRuleType
- ChartHistogramRule
- ChartAggregateType
- BasicChartSeries
- LineStyle
- LineDashType
- DataLabel
- DataLabelType
- DataLabelPlacement
- PointStyle
- PointShape
- BasicSeriesDataPointStyleOverride
- BasicChartStackedType
- BasicChartCompareMode
- PieChartSpec
- PieChartLegendPosition
- BubbleChartSpec
- BubbleChartLegendPosition
- CandlestickChartSpec
- CandlestickDomain
- CandlestickData
- CandlestickSeries
- OrgChartSpec
- OrgChartNodeSize
- HistogramChartSpec
- HistogramSeries
- HistogramChartLegendPosition
- WaterfallChartSpec
- WaterfallChartDomain
- WaterfallChartSeries
- WaterfallChartColumnStyle
- WaterfallChartCustomSubtotal
- WaterfallChartStackedType
- TreemapChartSpec
- TreemapChartColorScale
- ScorecardChartSpec
- KeyValueFormat
- BaselineValueFormat
- ComparisonType
- ChartNumberFormatSource
- ChartCustomNumberFormatOptions
- ChartHiddenDimensionStrategy
- EmbeddedObjectPosition
- OverlayPosition
- GridCoordinate
- EmbeddedObjectBorder
- BandedRange
- BandingProperties
- DimensionGroup
- Controle de filtros
- SlicerSpec
- NamedRange
- DataSource
- DataSourceSpec
- BigQueryDataSourceSpec
- BigQueryQuerySpec
- BigQueryTableSpec
- LookerDataSourceSpec
- DataSourceParameter
- DataSourceRefreshSchedule
- DataSourceRefreshScope
- DataSourceRefreshDailySchedule
- TimeOfDay
- DataSourceRefreshWeeklySchedule
- DayOfWeek
- DataSourceRefreshMonthlySchedule
- Intervalo
- Métodos
Recurso: planilha
Recurso que representa uma planilha.
Representação JSON |
---|
{ "spreadsheetId": string, "properties": { object ( |
Campos | |
---|---|
spreadsheetId |
O ID da planilha. Este campo é somente leitura. |
properties |
Propriedades gerais de uma planilha. |
sheets[] |
As páginas que fazem parte de uma planilha. |
namedRanges[] |
Os intervalos nomeados definidos em uma planilha. |
spreadsheetUrl |
O URL da planilha. Este campo é somente leitura. |
developerMetadata[] |
Os metadados do desenvolvedor associados a uma planilha. |
dataSources[] |
Uma lista das fontes de dados externas conectadas à planilha. |
dataSourceSchedules[] |
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 ( |
Campos | |
---|---|
title |
Título da planilha. |
locale |
A localidade da planilha em um dos seguintes formatos:
Observação: ao atualizar este campo, nem todas as localidades/idiomas são compatíveis. |
autoRecalc |
O tempo de espera antes que as funções voláteis sejam recalculadas. |
timeZone |
O fuso horário da planilha, no formato CLDR, como |
defaultFormat |
Formato padrão de todas as células na planilha. |
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 |
Tema aplicado à planilha. |
importFunctionsExternalUrlAccessAllowed |
Define se o acesso de URL externo para funções de imagem e importação será permitido. Ler somente quando verdadeiro. Quando falso, você pode defini-lo como verdadeiro. Esse valor será ignorado e sempre vai retornar o valor "true" se o administrador tiver ativado o recurso da 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. Não use esse valor. |
ON_CHANGE |
As funções voláteis são atualizadas em cada mudança. |
MINUTE |
As funções voláteis são atualizadas a cada alteração e a cada minuto. |
HOUR |
As funções voláteis são atualizadas a cada alteração 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 |
Quando o cálculo iterativo está ativado, o número máximo de rodadas de cálculo a serem realizadas. |
convergenceThreshold |
Quando o cálculo iterativo está ativado e os resultados sucessivos diferem por menos do que esse valor limite, os ciclos de cálculo são interrompidos. |
SpreadsheetTheme
Representa o tema da planilha
Representação JSON |
---|
{
"primaryFontFamily": string,
"themeColors": [
{
object ( |
Campos | |
---|---|
primaryFontFamily |
Nome da família de fontes principal. |
themeColors[] |
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 com a cor concreta que ele representa.
Representação JSON |
---|
{ "colorType": enum ( |
Campos | |
---|---|
colorType |
O tipo de cor do tema da planilha. |
color |
A cor do concreto correspondente ao tipo de cor do tema. |
NamedRange
Um intervalo nomeado.
Representação JSON |
---|
{
"namedRangeId": string,
"name": string,
"range": {
object ( |
Campos | |
---|---|
namedRangeId |
O ID do intervalo nomeado. |
name |
O nome do intervalo nomeado. |
range |
O intervalo representado. |
DataSource
Informações sobre uma fonte de dados externa na planilha.
Representação JSON |
---|
{ "dataSourceId": string, "spec": { object ( |
Campos | |
---|---|
dataSourceId |
O ID exclusivo no escopo da planilha que identifica a fonte de dados. Exemplo: 1080547365. |
spec |
O |
calculatedColumns[] |
Todas as colunas calculadas na fonte de dados. |
sheetId |
O ID do Ao criar uma fonte de dados, uma página |
DataSourceSpec
Isso especifica os detalhes da fonte de dados. Por exemplo, para BigQuery, isso especifica informações sobre a origem da BigQuery.
Representação JSON |
---|
{ "parameters": [ { object ( |
Campos | |
---|---|
parameters[] |
Os parâmetros da fonte de dados, usados ao consultá-la. |
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 |
|
looker |
Um [LookerDatasourceSpec][]. |
BigQueryDataSourceSpec
A especificação de uma fonte de dados do BigQuery conectada a uma página.
Representação JSON |
---|
{ "projectId": string, // Union field |
Campos | |
---|---|
projectId |
O ID de um projeto do Google Cloud ativado para BigQuery com uma conta de faturamento anexada. O projeto é cobrado por todas as consultas executadas na fonte de dados. |
Campo de união spec . A especificação real. spec pode ser apenas de um dos tipos a seguir: |
|
querySpec |
|
tableSpec |
|
BigQueryQuerySpec
Especifica uma consulta personalizada do BigQuery.
Representação JSON |
---|
{ "rawQuery": string } |
Campos | |
---|---|
rawQuery |
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 |
O ID de um projeto do BigQuery a que a tabela pertence. Se não for especificado, o |
tableId |
O ID da tabela do BigQuery. |
datasetId |
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 |
Um URL de instância do Looker. |
model |
Nome de um modelo do Looker. |
explore |
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 |
Campos | |
---|---|
Campo de união identifier . O identificador de parâmetro. identifier pode ser apenas de um dos tipos a seguir: |
|
name |
Parâmetro nomeado. Precisa ser um identificador legítimo do |
Campo de união value . O valor do parâmetro. value pode ser apenas de um dos tipos a seguir: |
|
namedRangeId |
ID de um |
range |
Um intervalo que contém o valor do parâmetro. O tamanho deve ser 1x1. |
DataSourceRefreshSchedule
Programe a atualização da fonte de dados.
As fontes de dados na planilha são atualizadas dentro de um intervalo de tempo. Você pode especificar o horário de início clicando no botão "Atualização programada" no editor do Planilhas, mas o intervalo é fixo em quatro horas. Por exemplo, se você especificar o horário de início como 8h , a atualização ocorrerá entre 8h e 12h todos os dias.
Representação JSON |
---|
{ "enabled": boolean, "refreshScope": enum ( |
Campos | |
---|---|
enabled |
Verdadeiro se a programação de atualização estiver ativada. Caso contrário, será falso. |
refreshScope |
O escopo da atualização. Precisa ser |
nextRun |
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: |
|
dailySchedule |
Programação diária de atualização. |
weeklySchedule |
Programação de atualização semanal. |
monthlySchedule |
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 usar. |
ALL_DATA_SOURCES |
Atualiza todas as fontes de dados e os objetos de fontes de dados associados na planilha. |
DataSourceRefreshDailySchedule
Uma programação de atualização dos dados todos os dias em um determinado intervalo de tempo.
Representação JSON |
---|
{
"startTime": {
object ( |
Campos | |
---|---|
startTime |
O horário de início de um intervalo em que uma atualização de fonte de dados está programada. Apenas |
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 |
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 |
Minutos da hora do dia. Precisa ser de 0 a 59. |
seconds |
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 |
Frações de segundos em nanossegundos. Precisa ser de 0 a 999.999.999. |
DataSourceRefreshWeeklySchedule
Uma programação semanal para a atualização dos dados em dias específicos em um determinado intervalo de tempo.
Representação JSON |
---|
{ "startTime": { object ( |
Campos | |
---|---|
startTime |
O horário de início de um intervalo em que uma atualização de fonte de dados está programada. Apenas |
daysOfWeek[] |
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 a atualização dos dados em dias específicos do mês em um determinado período.
Representação JSON |
---|
{
"startTime": {
object ( |
Campos | |
---|---|
startTime |
O horário de início de um intervalo em que uma atualização de fonte de dados está programada. Apenas |
daysOfMonth[] |
Dias do mês para atualizar. Somente de 1 a 28 são aceitos, mapeando do 1o ao 28o dia. É 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 término de carimbo de data/hora (exclusivo).
O início precisa ser menor ou igual ao final. Quando o início é igual ao fim, o intervalo está vazio (sem correspondência de 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 |
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 |
Opcional. Término exclusivo do intervalo. Se especificado, um carimbo de data/hora que corresponde a esse intervalo precisa ser anterior ao fim. |
Métodos |
|
---|---|
|
Aplica uma ou mais atualizações à planilha. |
|
Cria uma planilha e retorna a planilha recém-criada. |
|
Retorna a planilha no ID fornecido. |
|
Retorna a planilha no ID fornecido. |