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 atualizar qualquer um desses detalhes da planilha. As alterações são agrupadas em um lote para que, se uma solicitação não for bem-sucedida, nenhuma das outras alterações (possivelmente dependentes) serão gravadas.
Esta página descreve os conceitos básicos do 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
nestas amplas categorias:
Categoria | Descrição |
---|---|
Adicionar (e Duplicar) | Adicionar novos objetos (às vezes baseados em objetos antigos, como em Solicitações duplicadas). |
Atualizar (e Definir) | Atualizar certas propriedades de um objeto, normalmente deixando as propriedades antigas inalteradas (enquanto uma solicitação Set substitui os dados anteriores). |
Excluir | Remover 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
aceita um ou mais objetos
Request, cada um especificando um único tipo de solicitação a ser executada. Há muitos tipos diferentes de solicitações. Aqui está um detalhamento dos tipos de solicitações,
agrupados em diferentes categorias.
Há também algumas outras solicitações que imitam ações do usuário para manipular dados:
- AutoFillRequest
- CutPasteRequest
- CopyPasteRequest
- FindReplaceRequest
- PasteDataRequest
- TextToColumnsRequest
- SortRangeRequest
Limites
Para saber mais sobre 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. Essa é uma lista de campos delimitados 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 todos os campos 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 saber mais 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ção podem retornar respostas. Elas são retornadas em uma matriz, com cada resposta ocupando o mesmo índice da solicitação correspondente. Algumas solicitações não têm respostas e, para outras, a resposta está vazia.
Normalmente, as solicitações "add" têm respostas que retornam informações como o ID do objeto adicionado. Para a lista de respostas compatíveis, consulte Respostas.
Exemplo
O exemplo de código abaixo 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
.