Há muitos cenários em que você pode encontrar erros ao trabalhar com a API Display & Video 360. Eles podem estar relacionados a um bug no código, entrada de usuário inválida ou até mesmo um problema com a própria API. Seja qual for o motivo, saber como resolver problemas é uma parte importante do processo de desenvolvimento. Este guia vai fornecer algumas dicas de práticas recomendadas para você começar.
Revisão dos conceitos básicos
- Consulte o guia de pré-requisitos. Confira se você tem acesso ao Display & Video 360 e a um projeto de API configurado corretamente.
- Se a resposta contiver erros HTTP, revise-os com cuidado e verifique se a solicitação está sendo feita para a API e o serviço corretos.
- Leia o guia de autorização. Verifique se a solicitação contém as credenciais OAuth 2.0 necessárias.
Verifique se você está usando as credenciais corretas. Consulte o guia de configuração do seu app para saber como gerar credenciais de autenticação. Você também pode transmitir seu token de acesso ao endpoint tokeninfo da API OAuth2 do Google para verificar se ele foi emitido para o projeto de API correto e autorizado para os escopos corretos:
POST https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={YOUR_ACCESS_TOKEN} 200 OK { "issued_to": "{API_PROJECT_CLIENT_ID}", "audience": "...", "scope": "{API_SCOPES}", "expires_in": ... }
Noções básicas sobre erros
Quando a API encontra um erro, ela normalmente retorna uma resposta JSON contendo
um objeto error
. Esse objeto fornece mais contexto sobre o erro
específico encontrado.
{
"error": {
"code": 404,
"message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
"status": "NOT_FOUND"
}
}
Normalmente, o conteúdo do objeto error
contém informações suficientes para
ajudar a identificar o que deu errado. Caso contrário, talvez seja necessário fazer mais
pesquisas para descobrir o que o erro significa.
Pesquisar erros
Consulte a seção sobre erros comuns, que fornece detalhes sobre alguns dos erros mais frequentes.
Se o erro não estiver na seção de erros comuns, consulte a documentação de referência e tente pesquisar o código, o status e a mensagem de erro.
Se você encontrar erros que não estão documentados, informe nossa equipe.
Como identificar a causa raiz
Nesse ponto, você já identificou o erro e entendeu o que ele significa. Caso contrário, volte para entender os erros ou avance para receber ajuda se você acredita que encontrou um erro na API que não consegue corrigir.
Antes de corrigir o erro, você precisa identificar a causa dele. Muitas vezes, isso é um bug no código ou um valor de entrada inválido.
Para determinar se o problema está relacionado a um bug no código, primeiro verifique se ele está funcionando como esperado. Como primeira etapa, revise a seção de código responsável por fazer a solicitação falha para verificar problemas óbvios. Em alguns casos, pode ser necessário usar uma ferramenta de depuração para analisar o código linha por linha e garantir que ele esteja funcionando corretamente.
Examinar solicitações HTTP é outra maneira útil de identificar possíveis bugs, bem como casos de entrada inválida. Muitas das bibliotecas de cliente oficiais podem ser configuradas para registrar solicitações e respostas HTTP. Consulte a documentação da biblioteca escolhida para mais detalhes. Um proxy HTTP, como Charles, Squid ou Fiddler, também pode ser usado para capturar registros de solicitação e resposta. Depois de receber esses registros, revise-os para garantir que os valores do parâmetro de solicitação fornecidos pelo aplicativo estejam corretos e correspondam ao esperado.
Depois de identificar o bug ou a entrada inválida responsável pelo erro, a correção será óbvia. No entanto, se você não conseguir resolver o problema ou não souber como corrigi-lo, use as informações coletadas até o momento para receber ajuda.
Receber ajuda
Se você não conseguir resolver um erro, entre em contato com nossa equipe de suporte usando este formulário na Central de Ajuda do Display & Video 360.
Ao preencher este formulário, inclua o máximo de informações possível sobre o problema que você está enfrentando e as etapas de solução de problemas que você já seguiu. Informações úteis para incluir:
- Registros de solicitação e resposta HTTP. Redija informações sensíveis, como tokens de acesso do OAuth 2.0, endereços de e-mail etc.
- Snippet de código. Se você conseguir isolar o problema em uma seção específica do código ou suspeitar que o problema é específico do idioma, inclua um pequeno snippet para ilustrar o que você está fazendo.
- Outras informações, como a versão do ambiente de execução/intérprete e a plataforma, que podem ser úteis para outras pessoas que tentam reproduzir o problema.
Como corrigir o problema
Depois de identificar a causa do problema e encontrar uma solução, é hora de implementar uma correção. Sempre que possível, teste a correção em um ambiente controlado (como um parceiro ou anunciante configurado especificamente para testes) com uma variedade de entradas boas e ruins antes de implantar na produção.