Além dos dados de valor contidos nas células, uma planilha inclui muitos outros tipos de dados, como:
- Dimensões
- Formatos e bordas de células
- Intervalos nomeados
- Intervalos protegidos
- Formatação condicional
Esses são alguns dos muitos tipos de dados que controlam a aparência e a operação de uma planilha. O método spreadsheets.batchUpdate
permite que você atualize qualquer um desses detalhes da planilha. As alterações são agrupadas em um lote para que,
se uma solicitação falhar, nenhuma das outras (possivelmente dependentes)
seja gravada.
Nesta página, descrevemos os princípios básicos de uso do
método
spreadsheets.batchUpdate
. Se você precisar ler e gravar dados de valores de células, também poderá usar o recurso
spreadsheets.values
descrito em Ler e gravar valores de células.
Categorias de operação
As operações específicas compatíveis com spreadsheets.batchUpdate
podem ser agrupadas nas seguintes categorias amplas:
Categoria | Descrição |
---|---|
Adicionar (e Duplicar) | Adicione novos objetos (às vezes com base nos antigos, como nas solicitações duplicadas). |
Atualizar (e Definir) | Atualizar determinadas propriedades de um objeto, geralmente deixando as propriedades antigas sozinhas (enquanto uma solicitação Set substitui os dados anteriores). |
Excluir | Remova objetos. |
Essas categorias são usadas na próxima seção para descrever o comportamento de operações específicas.
Operações de atualização em lote
O método spreadsheets.batchUpdate
recebe um ou mais objetos Request, cada um especificando um único tipo de solicitação a ser executada. Há muitos tipos diferentes de solicitações. Veja a seguir um detalhamento dos tipos de solicitações,
agrupados em diferentes categorias.
Há também algumas outras solicitações que imitam as ações do usuário para manipular dados:
- AutoFillRequest
- CutPasteRequest
- CopyPasteRequest
- FindReplaceRequest
- PasteDataRequest
- TextToColumnsRequest
- SortRangeRequest
Limites
Para saber mais sobre os limites de células e linhas no Planilhas Google, consulte Arquivos que você pode armazenar no Google Drive.
Máscaras de campo
Muitas das solicitações de "atualização" exigem máscaras de campo. Trata-se de uma lista de campos separada por vírgulas para atualizar apenas determinados campos em um objeto, deixando os outros inalterados. Uma máscara de campo de *
é tratada como um
caractere curinga e é uma abreviação para especificar cada campo em uma mensagem. Isso significa
que um campo pode ser revertido para o estado padrão se você não especificar um valor para ele na
solicitação.
Para mais informações sobre máscaras de campo, consulte Usar máscaras
de campo.
O exemplo a seguir usa o UpdateSpreadsheetPropertiesRequest
para atualizar apenas o título de uma planilha:
Solicitação:
POST .../v4/spreadsheets/spreadsheetId:batchUpdate
Corpo da solicitação:
{
"requests": [{
"updateSpreadsheetProperties": {
"properties": {"title": "TITLE"},
"fields": "title"
}
}]
}
Substitua TITLE pelo novo título da planilha.
Respostas
Ao atualizar uma planilha, alguns tipos de solicitações podem retornar respostas. Eles são retornados em uma matriz, com cada resposta ocupando o mesmo índice que a solicitação correspondente. Algumas solicitações não têm respostas e, para elas, a resposta está vazia.
Normalmente, as solicitações "adicionar" têm respostas que retornam informações como o ID do objeto adicionado. Para ver a lista de respostas compatíveis, consulte Respostas.
Exemplo
O exemplo de código a seguir executa essas ações:
- Atualiza o título da planilha usando a variável
title
. - Encontra e substitui valores de células na planilha usando as variáveis
find
ereplacement
.