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 falhar, nenhuma das demais (que podem ser dependentes)
seja gravada.
Esta página descreve os conceitos básicos do uso do método
spreadsheets.batchUpdate
. Se você precisar ler e gravar dados de valor de célula, também poderá usar o recurso
spreadsheets.values
descrito em Ler e gravar valores de célula.
Categorias de operação
As operações específicas com suporte do spreadsheets.batchUpdate
podem ser agrupadas
nas seguintes categorias genéricas:
Categoria | Descrição |
---|---|
Adicionar (e Duplicar) | Adiciona novos objetos (às vezes baseados em antigos, como em solicitações Duplicate). |
Atualizar (e definir) | Atualiza certas propriedades de um objeto, geralmente mantendo as propriedades antigas inalteradas (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
funciona coletando um ou mais
objetos Request, cada um especificando um único tipo de solicitação a ser realizada. Há
muitos tipos diferentes de solicitações. Confira o detalhamento dos tipos de solicitações,
agrupadas em diferentes categorias.
Existem também algumas solicitações adicionais que simulam 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 nas 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. Elas são uma lista de campos separados por vírgulas
para atualizar apenas alguns campos em um objeto e deixar os
outros inalterados. Uma máscara de campo de *
é tratada como um
caractere curinga e é abreviada 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 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 "add" 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 abaixo 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
find
ereplacement
.