De nombreux scénarios peuvent entraîner des erreurs lorsque vous utilisez l'API Display & Video 360. Il peut s'agir d'un bug dans votre code, d'une entrée utilisateur non valide ou même d'un problème avec l'API elle-même. Quelle que soit la raison, savoir résoudre les erreurs est une partie importante du processus de développement. Ce guide vous fournira quelques bonnes pratiques pour vous lancer.
Récapituler les principes de base
- Consultez le guide des conditions préalables. Assurez-vous d'avoir accès à Display & Video 360 et à un projet d'API correctement configuré.
- Si votre réponse contient des erreurs HTTP, veillez à les examiner attentivement et à vous assurer que la requête est envoyée à la bonne API et au bon service.
- Consultez le guide d'autorisation. Assurez-vous que votre requête contient les identifiants OAuth 2.0 nécessaires.
Vérifiez que vous utilisez les bons identifiants. Pour en savoir plus sur la génération d'identifiants d'authentification, consultez le guide de configuration de votre application. Vous pouvez également transmettre votre jeton d'accès au point de terminaison tokeninfo de l'API Google OAuth2 pour vérifier qu'il est émis pour le bon projet d'API et autorisé pour le ou les bons champs d'application :
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": ... }
Comprendre les erreurs
Lorsqu'une erreur se produit, l'API renvoie normalement une réponse JSON contenant un objet error. Cet objet fournit des informations supplémentaires sur l'erreur spécifique rencontrée.
{
"error": {
"code": 404,
"message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
"status": "NOT_FOUND"
}
}
En général, le contenu de l'objet error contient suffisamment d'informations pour vous aider à identifier le problème. Si ce n'est pas le cas, vous devrez peut-être effectuer des recherches supplémentaires pour comprendre la signification de l'erreur.
Rechercher des erreurs
Consultez la section sur les erreurs courantes, qui fournit des informations sur certaines des erreurs les plus fréquemment rencontrées.
Si l'erreur n'est pas abordée dans la section des erreurs courantes, consultez la documentation de référence et essayez de rechercher le code, l'état et le message d'erreur.
Si vous rencontrez des erreurs non documentées, veuillez nous en informer.
Identifier la cause racine
À ce stade, vous avez identifié l'erreur et compris ce qu'elle signifie. Si ce n'est pas le cas, revenez à la section Comprendre les erreurs ou passez directement à la section Obtenir de l'aide si vous pensez avoir rencontré une erreur dans l'API que vous ne pouvez pas résoudre vous-même.
Avant de pouvoir corriger l'erreur, vous devez identifier sa cause. Il s'agit souvent d'un bug dans votre code ou d'une valeur d'entrée non valide.
Pour déterminer si le problème est lié à un bug dans votre code, vous devez d'abord vérifier que votre code fonctionne comme prévu. Dans un premier temps, envisagez d'examiner la section de code responsable de l'envoi de la requête défaillante pour rechercher des problèmes évidents. Dans certains cas, il peut être nécessaire d'utiliser un outil de débogage pour passer en revue le code ligne par ligne afin de s'assurer qu'il fonctionne correctement.
L'examen des requêtes HTTP est un autre moyen utile d'identifier les bugs potentiels, ainsi que les cas d'entrées non valides. De nombreuses bibliothèques clientes officielles peuvent être configurées pour consigner les requêtes et les réponses HTTP. Pour en savoir plus, consultez la documentation de la bibliothèque de votre choix. Un proxy HTTP tel que Charles, Squid ou Fiddler peut également être utilisé pour capturer les journaux de requêtes et de réponses. Une fois que vous avez obtenu ces journaux, examinez-les pour vous assurer que les valeurs des paramètres de requête fournies par votre application sont correctes et correspondent à ce que vous attendez.
Une fois que vous avez identifié le bug ou l'entrée incorrecte à l'origine de l'erreur, la solution devrait être évidente. Toutefois, si vous êtes bloqué ou que vous ne savez pas comment résoudre le problème, vous pouvez utiliser les informations que vous avez recueillies jusqu'à présent pour obtenir de l'aide.
Obtenir de l'aide
Si vous ne parvenez pas à résoudre une erreur vous-même, vous pouvez contacter notre équipe d'assistance via ce formulaire disponible dans le centre d'aide Display & Video 360.
Lorsque vous remplissez ce formulaire, vous devez inclure autant d'informations que possible sur le problème que vous rencontrez et sur les étapes de dépannage que vous avez déjà effectuées. Informations utiles à inclure:
- Journaux de requêtes et de réponses HTTP Veillez à masquer les informations sensibles telles que les jetons d'accès OAuth 2.0, les adresses e-mail, etc.
- Extrait de code. Si vous parvenez à isoler le problème à une section de code spécifique ou si vous pensez qu'il est spécifique à la langue, incluez un petit extrait pour illustrer ce que vous faites.
- Informations supplémentaires, telles que la version de l'environnement d'exécution/de l'interprète et la plate-forme, qui peuvent être utiles à d'autres personnes qui tentent de reproduire le problème.
Résoudre le problème
Une fois que vous avez identifié la cause du problème et trouvé une solution, il est temps de mettre en œuvre une correction. Dans la mesure du possible, testez votre correctif dans un environnement contrôlé (par exemple, un partenaire ou un annonceur configuré spécifiquement pour les tests) avec une gamme d'entrées correctes et incorrectes avant de le déployer en production.