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.
Nesta página, você verá 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 nas seguintes categorias gerais:
Categoria | Descrição |
---|---|
Adicionar (e Duplicar) | Adicionar novos objetos (às vezes com base em objetos antigos, como em solicitações duplicadas). |
Atualizar (e Definir) | Atualiza determinadas propriedades de um objeto, geralmente deixando as propriedades antigas intactas (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
funciona usando 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 uma análise dos tipos de solicitações,
agrupadas em diferentes categorias.
Há também algumas solicitações adicionais que imitam 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. É uma lista de campos delimitada por vírgulas para atualizar apenas determinados campos em um objeto e deixar os outros inalterados. Uma máscara de campo de *
é tratada como um
curinga e é uma abreviação para especificar todos os campos em uma mensagem. Isso significa
que um campo pode voltar 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 essas, 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 aceitas, consulte Respostas.
Exemplo
O exemplo de código a seguir executa 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
.