REST Resource: spreadsheets

{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}

string

O ID da planilha. Este campo é somente leitura.

object (SpreadsheetProperties)

Propriedades gerais de uma planilha.

object (Sheet)

As páginas que fazem parte de uma planilha.

object (NamedRange)

Os intervalos nomeados definidos em uma planilha.

string

O URL da planilha. Este campo é somente leitura.

object (DeveloperMetadata)

Os metadados do desenvolvedor associados a uma planilha.

object (DataSource)

Uma lista das fontes de dados externas conectadas à planilha.

object (DataSourceRefreshSchedule)

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

{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}

string

Título da planilha.

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 ISO e o código do país, como en_US

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

enum (RecalculationInterval)

O tempo de espera antes que as funções voláteis sejam recalculadas.

string

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

object (CellFormat)

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.

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.

object (SpreadsheetTheme)

Tema aplicado à planilha.

boolean

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.

{
  "maxIterations": integer,
  "convergenceThreshold": number
}

integer

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

number

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.

{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}

string

Nome da família de fontes principal.

object (ThemeColorPair)

Os pares de cores do tema da planilha. Para atualizar, você precisa fornecer todos os pares de cores do tema.

{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}

enum (ThemeColorType)

O tipo de cor do tema da planilha.

object (ColorStyle)

A cor do concreto correspondente ao tipo de cor do tema.

{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}

string

O ID do intervalo nomeado.

string

O nome do intervalo nomeado.

object (GridRange)

O intervalo representado.

{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}

string

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

object (DataSourceSpec)

O DataSourceSpec da fonte de dados conectada a esta planilha.

object (DataSourceColumn)

Todas as colunas calculadas na fonte de dados.

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.

{
  "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.
}

object (DataSourceParameter)

Os parâmetros da fonte de dados, usados ao consultá-la.

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.

object (LookerDataSourceSpec)

LookerDataSourceSpec.

{
  "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.
}

string

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.

object (BigQueryQuerySpec)

BigQueryQuerySpec.

object (BigQueryTableSpec)

BigQueryTableSpec.

{
  "rawQuery": string
}

string

A string de consulta bruta.

{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}

string

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

string

O ID da tabela do BigQuery.

string

O ID do conjunto de dados do BigQuery.

{
  "instanceUri": string,
  "model": string,
  "explore": string
}

string

Um URL de instância do Looker.

string

Nome de um modelo do Looker.

string

Nome de uma análise de modelo do Looker.

{

  // 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.
}

string

Parâmetro nomeado. Precisa ser um identificador legítimo do DataSource que oferece suporte a ele. Por exemplo, identificador do BigQuery.

string

ID de um NamedRange. O tamanho deve ser 1x1.

object (GridRange)

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

{
  "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.
}

boolean

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

enum (DataSourceRefreshScope)

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

object (Interval)

Apenas saída. O intervalo de tempo da próxima execução.

object (DataSourceRefreshDailySchedule)

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

object (DataSourceRefreshWeeklySchedule)

Programação de atualização semanal.

object (DataSourceRefreshMonthlySchedule)

Programação de atualização mensal.

{
  "startTime": {
    object (TimeOfDay)
  }
}

object (TimeOfDay)

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

{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}

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.

integer

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

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.

integer

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

{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}

object (TimeOfDay)

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

enum (DayOfWeek)

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

{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}

object (TimeOfDay)

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

integer

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.

{
  "startTime": string,
  "endTime": string
}

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.

string (Timestamp format)

Opcional. Término exclusivo do intervalo.

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