Resolução de problemas de utilização da API

Esta página oferece aos programadores de aplicações uma vista geral de como resolver problemas da respetiva utilização das APIs Google e das APIs Google Cloud.

Contexto

As APIs Google são APIs em rede fornecidas pelos serviços Google. As aplicações podem aceder às APIs Google através de JSON HTTP e gRPC a partir de diferentes ambientes. Recomendamos que os programadores usem bibliotecas de cliente fornecidas pela Google nas respetivas aplicações. Estas bibliotecas implementam uma lógica de boilerplate comum, como a autenticação e a paginação de listas, o que reduz significativamente a sobrecarga de desenvolvimento e os erros comuns.

Para mais informações, consulte o artigo Explicação das bibliotecas de cliente

Começar

Se for a primeira vez que usa as APIs Google, deve seguir a página Introdução para concluir os passos de preparação da sua aplicação. Deve usar primeiro o comando curl -v para enviar pedidos de teste às APIs Google que quer usar. Permite-lhe experimentar as APIs Google sem escrever código. Muitas vezes, pode resolver muitos problemas antes de iniciar o desenvolvimento real da aplicação.

Para mais informações, consulte o artigo Introdução.

Resolução de problemas através de métricas

As APIs Google fornecem métricas de API gratuitas que abrangem aspetos comuns da utilização de APIs, incluindo contagens de pedidos, erros, latências e tamanhos de pedidos e respostas. Fornecem dimensões detalhadas em termos de aplicações e localizações. Os programadores podem descobrir a utilização anormal da API e identificar potenciais causas principais. Por exemplo, um número mais elevado de erros 400 pode significar que uma aplicação atualizada recentemente tem alguns erros lógicos, ou tamanhos de pedidos e respostas mais elevados podem causar um desempenho mais lento da aplicação.

Para mais informações, consulte o artigo Monitorizar a utilização da API.

Resolução de problemas através de registos

Por motivos de segurança e privacidade, as APIs Google geralmente não fornecem registos de APIs aos programadores de aplicações. Recomendamos vivamente que os programadores de aplicações registem erros da API do lado do cliente. Pode registar os erros num armazenamento local ou numa API de registo remoto, como a API Cloud Logging.

Normalmente, os registos contêm mais informações sobre erros do que as métricas, como mensagens de erro e detalhes dos erros. São extremamente úteis e, muitas vezes, necessárias para resolver problemas de erros da API. Quando os programadores detetam algum problema com a utilização da API, podem consultar os registos para encontrar mensagens de erro e detalhes dos erros, e usar as informações para resolver os erros ou contactar o apoio técnico.

Cloud Audit Logs

Para atividades sensíveis à segurança, os produtos Google Cloud podem gerar registos de auditoria que contêm informações detalhadas das atividades. São uma excelente fonte de informações para resolver problemas relacionados com a sua utilização das APIs Google Cloud. Por exemplo, a funcionalidade de teste do VPC Service Controls gera registos de auditoria para os administradores avaliarem as futuras alterações às políticas.

Para mais informações, consulte o artigo Registos de auditoria do Cloud.

Resolver erros

Se tiver problemas com a utilização da API Google e tiver encontrado as métricas e os registos correspondentes, pode seguir a página Erros do guia de design de APIs para resolver os erros.

Em geral, cada erro da API tem 3 informações: código de erro, mensagem de erro e detalhes do erro:

  • O código de erro permite que as aplicações processem o erro ao nível superior, como tentar novamente após erros 503 ou reautenticar os utilizadores após erros 401.

  • A mensagem de erro permite que os programadores de aplicações compreendam o erro e corrijam a lógica da respetiva aplicação.

  • Os detalhes do erro contêm informações adicionais que as aplicações podem usar para processar o erro programaticamente.

Para mais informações, consulte a página Erros.