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

object (CommentThread)

As conversas associadas à planilha.

commentsViewMode

enum (CommentsViewMode)

Apenas saída. O modo de leitura de comentários aplicado à planilha.

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: nem todas as localidades/idiomas são compatíveis ao atualizar esse campo.
autoRecalc

enum (RecalculationInterval)

O tempo de espera 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, talvez seja um fuso horário 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

Se o acesso a URLs externos para funções de imagem e importação deve ser permitido. Somente leitura quando o valor for "true". Quando for "false", você poderá definir como "true". Esse valor será ignorado e sempre retornará "true" se o administrador tiver ativado o recurso de lista de permissão.

RecalculationInterval

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

Tipos enumerados
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 está 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 da 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, para o BigQuery, isso especifica informações sobre a origem do BigQuery.

Representação JSON 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
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 fonte de dados do BigQuery conectada a uma planilha.

Representação JSON 
{
  "projectId": string,

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

string

O ID de um projeto na nuvem do Google Cloud com o BigQuery ativado e 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

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. Apenas tabelas nativas são permitidas.

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

string

O ID de um projeto do BigQuery a que a tabela pertence. Se não for especificado, o 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 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
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 aceita. Por exemplo, Identificador do BigQuery.
Campo de união value. O valor de parâmetro. value pode ser apenas de um dos tipos a seguir:
namedRangeId

string

ID de uma 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

Programação para atualizar a 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 é fixo em 4 horas. Por exemplo, se você especificar um horário de início de 8h , a atualização será feita entre 8h e 12h todos os dias.

Representação JSON 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

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

boolean

True se a programação de atualização estiver ativada. Caso contrário, será false.
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.

Tipos enumerados
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Valor padrão. Não usar.
ALL_DATA_SOURCES Atualiza todas as fontes de dados e os objetos associados a elas na planilha.

DataSourceRefreshDailySchedule

Uma programação para atualização diária de dados 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. Apenas a parte hours é usada. O tamanho do intervalo de tempo é o mesmo do editor do Google Sheets.

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 geralmente 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 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 atualização de dados em dias específicos em um determinado intervalo de tempo.

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. Apenas a parte hours é usada. O tamanho do intervalo de tempo é o mesmo do editor do Google Sheets.
daysOfWeek[]

enum (DayOfWeek)

Dias da semana para atualização. É 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 atualização de 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)

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

integer

Dias do mês para atualização. Apenas 1 a 28 são aceitos, correspondendo do 1º ao 28º dia. É necessário especificar pelo menos um dia.

Intervalo

Representa um intervalo de tempo, codificado como um início de carimbo de data/hora (incluído) e um fim de carimbo de data/hora (não incluído).

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

string (Timestamp format)

Opcional. Fim exclusivo do intervalo.

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

CommentThread

Representa uma única conversa em uma planilha.

Representação JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Campos
commentId

string

O ID exclusivo da conversa de comentários.
anchorId

string

O ID do CommentAnchor na planilha a que a conversa está vinculada.
headPost

object (Post)

A primeira postagem na conversa.
replies[]

object (Post)

Respostas à postagem principal.
status

enum (Status)

Se a conversa está aberta ou resolvida.
Campo de união quote. O texto citado do documento quando o comentário foi criado. quote pode ser apenas de um dos tipos a seguir:
plainTextQuote

string

O texto citado da planilha quando o comentário foi criado, formatado como texto simples.

Postar

Representa uma única postagem em uma conversa.

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

Apenas saída. O ID exclusivo da postagem.
content

string

O conteúdo da postagem.

Obrigatório se commentAction não for RESOLVE ou REOPEN.

Esse conteúdo de texto será tratado de maneira semelhante aos comentários criados no editor das Planilhas. Ele terá comportamentos semelhantes para formatação, notificações etc.

Não pode exceder 2.048 unidades de código UTF-8.
contentHtml

string

Apenas saída. O conteúdo da postagem em HTML.
author

object (PostAuthor)

Apenas saída. O usuário que criou a postagem.
createTime

string (Timestamp format)

Apenas saída. A hora em que a postagem foi criada.
updateTime

string (Timestamp format)

Apenas saída. A hora em que a postagem foi atualizada pela última vez.
deleted

boolean

Apenas saída. Indica se a postagem foi excluída. Se os campos true, content e author estiverem vazios.
fromImportedSpreadsheet

boolean

Apenas saída. Se a postagem é de uma planilha importada. Este campo não pode ser definido diretamente pelos chamadores.
fromCopiedSpreadsheet

boolean

Apenas saída. Se a postagem é de uma planilha copiada. Este campo não pode ser definido diretamente pelos chamadores.
assigneeEmail

string

Opcional. O e-mail do usuário que está sendo atribuído à conversa como parte desta postagem.

Retorna um erro 400 Bad Request se:

  • A conversa principal é um CommentThread cujo headPost não tem um atribuidor.

  • commentAction é especificado como RESOLVE ou REOPEN.

  • assigneeEmail excede 2.048 unidades de código UTF-8.
commentAction

enum (CommentActionType)

Ação realizada como parte da criação da postagem.

PostAuthor

Representa um usuário que criou uma postagem de comentário.

Representação JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Campos
displayName

string

O nome de exibição do usuário. Pode estar ausente se o autor for anônimo.
me

boolean

Se o usuário é o usuário autenticado que está fazendo a solicitação.
anonymous

boolean

Se o usuário é anônimo.
user

string

O nome do recurso do usuário autor da postagem, que também pode ser usado para identificar o usuário na API Google People. Formato: users/{user}. Não será preenchido se o campo anônimo for true ou se a postagem for de uma planilha importada.

CommentActionType

A ação realizada com esta resposta a uma conversa.

Tipos enumerados
COMMENT_ACTION_TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
NO_COMMENT_ACTION_CHANGE Nenhuma mudança de ação nesta postagem.
RESOLVE Esta postagem resolve a conversa.
REOPEN Essa postagem reabre a conversa.

Status

As opções de status da conversa de comentários.

Tipos enumerados
STATUS_UNSPECIFIED Valor padrão. Esse valor não é usado.
OPEN A conversa de comentários está aberta.
RESOLVED A sequência de comentários é resolvida.

CommentsViewMode

O modo de visualização de comentários aplicado à planilha, que indica se os comentários estão incluídos. Ele oferece opções para ler a planilha com ou sem comentários e âncoras de comentários.

Tipos enumerados
COMMENTS_VIEW_MODE_UNSPECIFIED O CommentsViewMode não está especificado. COMMENTS_VIEW_MODE_OMITTED é aplicado.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS O CommentsViewMode aplicado à planilha retornada depende do nível de acesso atual do usuário. Se o usuário tiver apenas acesso de visualização, COMMENTS_VIEW_MODE_OMITTED será aplicado. Caso contrário, COMMENTS_VIEW_MODE_INCLUDED será aplicado.
COMMENTS_VIEW_MODE_OMITTED A planilha retornada tem comentários omitidos.
COMMENTS_VIEW_MODE_INCLUDED

A planilha retornada tem comentários incluídos.

As solicitações para recuperar uma planilha usando esse modo vão retornar um erro 403 se o usuário não tiver permissão para ver comentários.

Métodos

batchUpdate

 Aplica uma ou mais atualizações à planilha.

create

 Cria uma planilha e a retorna.

get

 Retorna a planilha com o ID especificado.

getByDataFilter

 Retorna a planilha com o ID especificado.