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 mudanças são agrupadas em um lote para que, se uma solicitação não for bem-sucedida, nenhuma das outras mudanças (potencialmente dependentes) seja gravada.
Esta página descreve os conceitos básicos do uso do
spreadsheets.batchUpdate
método. Se você precisar ler e gravar dados de valor de célula, também poderá usar o
spreadsheets.values
recurso descrito em
Ler e gravar valores de células.
Categorias de operação
As operações específicas com suporte de spreadsheets.batchUpdate podem ser agrupadas nas seguintes categorias gerais:
| Categoria | Descrição |
|---|---|
| Adicionar (e Duplicar) | Adicionar novos objetos (às vezes com base em objetos antigos, como nas solicitações de duplicação). |
| Atualizar (e Definir) | Atualizar determinadas propriedades de um objeto, geralmente deixando as propriedades antigas sozinhas (enquanto uma solicitação de definição 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 funciona usando um ou mais
objetos de solicitação, cada um especificando um único tipo de solicitação a ser realizada. Há muitos tipos diferentes de solicitações. Confira um detalhamento dos tipos de solicitações, agrupadas em diferentes categorias.
Há também algumas solicitações adicionais 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 Google Planilhas, 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. Elas são uma lista de campos separados por vírgulas para atualizar apenas determinados campos em um objeto, deixando os outros campos inalterados. Uma máscara de campo de * é tratada como um caractere curinga e é uma abreviação para especificar todos os campos em uma mensagem (o que significa que um campo pode reverter ao 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. 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 elas, a resposta está vazia.
Normalmente, as solicitações de "adição" têm respostas que retornam informações como o ID do objeto adicionado. Para conferir a lista de respostas com suporte, consulte Respostas.
Exemplo
O exemplo de código a seguir realiza estas 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
findereplacement.