Consulta de CEP no Google Sheets/Google Apps Script 🗺

Se você não conhece ou tem pouca experiência com Google Apps Script, leia o nosso artigo do blog.

Atualmente existem poucas soluções prontas para consultar CEP diretamente no Google Sheets, por isso, criamos esse script gratuito para lidar com essa demanda.

A função foi desenvolvida no Google Apps Script com a API do ViaCEP.com.br - um excelente projeto, diga-se de passagem. Inclusive, se o projeto for útil para você, considere fazer uma doação para o ViaCEP.

Octadata - consulta de CEP no Google Planilhas (viacep.com.br)

Implementação do script

Acesse sua planilha, clique em Extensões > Apps Script. Renomeie o seu projeto, cole todo o código do script consultar_cep.gs dentro do seu projeto no Google Apps Script, salve e execute para conceder as permissões necessárias.

Parâmetros da função

Função: =CONSULTAR_CEP(cep_ou_referencia_célula; parâmetros)

Os parâmetros são opcionais, mas podem ser:

• logradouro (que é o nome da Rua, Avenida, etc)
• complemento (por exemplo: lado par)
• bairro
• localidade
• uf (estado abreviado: SP, RJ, ES)
• estado (nome do estado por extenso)
• regiao
• ibge
• gia
• ddd
• siafi

Os parâmetros selecionados serão retornados separados por vírgula.

Para retornar mais de um parâmetro na sua função, você precisa passá-los dentro de chaves, entre aspas e separados por vírgula. Exemplo: =CONSULTAR_CEP(A2; {"logradouro"; "bairro"})

Onde A2 representa o valor 29100010 (válido para formato numérico ou de texto).

1. O CEP pode conter hífen que será tratado como sem.
2. O resultado na íntegra (independente dos parâmetros passados na função) será armazenado em cache por 6 horas.
3. CEPs com menos de 8 dígitos, terão zeros automaticamente adicionados à esquerda.
4. Se nenhum parâmetro for definido, o retorno padrão será: ["logradouro", "bairro", "localidade", "uf"]
5. Caso um parâmetro não seja encontrado na resposta, o mesmo constará como "N/A" no retorno final
6. Não sabemos se é uma falha do Apps Script ou recusas de conexão do ViaCEP, mas comumente algumas requisições não são realizadas com sucesso. Por isso, esse script realiza 10 tentativas de consultar um CEP, até uma resposta HTTP/200 seja emitida [exceto em caso de erro declarado na resposta da API]

Sobre a Octadata

A Octadata é um projeto que se propõe a ensinar dicas sobre manipulação e análise de dados, e automação nas ferramentas do Google, como Sheets, Apps Script, Looker Studio e Google Colab.

Estamos no Blog | YouTube | TikTok | Instagram

Considerações finais

Esse é um script livre para realização de alterações/melhorias. MIT License.