Uso da API Troubleshooting

Esta página fornece aos desenvolvedores de aplicativos uma visão geral de como solucionar problemas de uso das APIs do Google e do Google Cloud.

Segundo plano

As APIs do Google são APIs conectadas fornecidas por serviços do Google. Os aplicativos podem acessar as APIs do Google via JSON HTTP e gRPC de diferentes ambientes. Recomendamos que os desenvolvedores usem as bibliotecas de cliente fornecidas pelo Google nos aplicativos. Essas bibliotecas implementam lógicas boilerplate comuns, como autenticação e paginação de listas, o que reduz consideravelmente a sobrecarga de desenvolvimento e os erros comuns.

Para mais informações, veja as Explicações sobre bibliotecas de clientes

Primeiros passos

Se você é novo nas APIs do Google, acesse a página Primeiros passos para concluir as etapas de preparação do seu aplicativo. Use o comando curl -v para enviar solicitações de teste para as APIs do Google que você quer usar. Assim você pode testar as APIs do Google sem escrever códigos. Muitas vezes, é possível resolver muitos problemas antes de iniciar o desenvolvimento real de aplicativos.

Para mais informações, consulte Primeiros passos.

Solução de problemas usando métricas

As APIs do Google fornecem métricas gratuitas que abrangem aspectos comuns do uso da API, incluindo contagem de solicitações, erros, latências e tamanhos de solicitação e resposta. Elas oferecem dimensões refinadas em termos de aplicativos e locais. Os desenvolvedores podem descobrir o uso anormal da API e identificar possíveis causas raiz. Por exemplo, erros superiores a 400 podem significar que um aplicativo atualizado recentemente tem alguns bugs lógicos ou que tamanhos maiores de solicitações e respostas podem causar um desempenho mais lento do aplicativo.

Para mais informações, consulte Como monitorar o uso da API.

Solução de problemas usando registros

Por motivos de segurança e privacidade, as APIs do Google geralmente não fornecem registros de API para desenvolvedores de aplicativos. É altamente recomendável que os desenvolvedores de aplicativos registrem erros de API no lado do cliente. É possível registrar os erros em um armazenamento local ou em uma API de registro remota, como a API Cloud Logging.

Normalmente, os registros contêm mais informações sobre erros do que métricas, como mensagens e detalhes do erro. Eles são extremamente úteis e geralmente necessários para solucionar erros de API. Ao perceber problemas com o uso da API, os desenvolvedores podem consultar os registros para encontrar mensagens e detalhes do erro e usar as informações para resolver os erros ou entrar em contato com o suporte.

Registros de auditoria do Cloud

Para atividades que apresentam riscos à segurança, os produtos do Google Cloud podem gerar registros de auditoria com informações detalhadas das atividades. Elas são uma ótima fonte de informações para solucionar problemas de uso das APIs do Google Cloud. Por exemplo, o recurso de simulação do VPC Service Controls gera registros de auditoria para que os administradores avaliem as futuras mudanças na política.

Saiba mais em Registros de auditoria do Cloud.

Como resolver erros

Se você tiver problemas ao usar a API do Google e encontrar as métricas e os registros correspondentes, acesse a página Erros do guia de design de API para resolver os erros.

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

  • O código de erro permite que os aplicativos processem o erro no nível superior, como tentar novamente após 503 erros ou autenticar novamente os usuários após 401 erros.

  • A mensagem de erro ajuda os desenvolvedores de aplicativos a entender o erro e corrigir a lógica do aplicativo.

  • Os detalhes do erro contêm outras informações que os aplicativos podem usar para lidar com o erro de maneira programática.

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