Existem muitos cenários em que você pode encontrar erros ao trabalhar com a API Display & Video 360. Isso pode estar relacionado a um bug no código, uma entrada inválida do usuário ou até mesmo um problema com a própria API. Seja qual for o motivo, saber como resolver erros é uma parte importante do processo de desenvolvimento. Este guia fornece algumas dicas de práticas recomendadas para você começar.
Análise do básico
- Consulte o guia de pré-requisitos. Verifique se você tem acesso ao Display & Video 360 e a um projeto de API configurado corretamente.
- Se a resposta contiver erros de HTTP, analise-os cuidadosamente 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 necessárias do OAuth 2.0.
Verifique se você está usando as credenciais corretas. Consulte o guia Configurar seu aplicativo para ver detalhes sobre como gerar credenciais de autenticação. Também é possível transmitir seu token de acesso ao endpoint tokeninfo da API Google OAuth2 para verificar se ele é 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": ... }
Como entender os 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
que foi 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 você a identificar o que deu errado. Caso contrário, talvez seja necessário fazer algumas pesquisas adicionais para descobrir o que o erro significa.
Erros de pesquisa
Consulte a seção sobre erros comuns, que fornece detalhes sobre alguns dos erros mais encontrados.
Se o erro não for abordado na seção de erros comuns, consulte a documentação de referência e tente pesquisar o código, o status e a mensagem do erro.
Se você encontrar erros que não estão documentados, informe-nos.
Como identificar a causa raiz
A esta altura, você já identificou o erro e entende o que ele significa. Caso contrário, volte para a seção Como entender os erros ou como receber ajuda caso você tenha encontrado um erro na API que não consegue corrigir por conta própria.
Antes de corrigir, é preciso identificar a causa. Muitas vezes, isso será um bug no seu código ou um valor de entrada inválido.
Para determinar se o problema está relacionado a um bug no seu código, primeiro verifique se o código está funcionando conforme o esperado. Como primeiro passo, analise a seção do código responsável por fazer a solicitação com falha para verificar se há problemas óbvios. Em alguns casos, pode ser necessário usar uma ferramenta de depuração para percorrer 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 de sua preferência para mais detalhes. Um proxy HTTP, como Charles, Squid ou restrinja, 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 de parâmetro da solicitação fornecidos pelo seu aplicativo estejam corretos e correspondam ao esperado.
Depois de identificar o bug ou a entrada inválida responsável por causar o erro, a correção será óbvia. No entanto, se você não souber qual é a melhor forma de corrigir o problema, use as informações coletadas até o momento para conseguir ajuda.
Receber ajuda
Caso você não consiga 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. Inclua informações úteis:
- registros de solicitação e resposta HTTP Edite informações confidenciais, 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 ele seja específico da linguagem, 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 estejam tentando 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 sua correção em um ambiente controlado (como um parceiro ou anunciante configurado especificamente para testes) com uma série de entradas boas e ruins antes de implantar na produção.