Vidéo : Découvrez la présentation sur la gestion des exceptions de l'atelier 2019
Les erreurs peuvent être dues à une configuration d'environnement incorrecte, à un bug dans votre logiciel ou à une entrée non valide d'un utilisateur. Quelle que soit la source, vous devrez résoudre le problème et corriger votre code ou ajouter une logique pour gérer l'erreur de l'utilisateur. Ce guide présente quelques bonnes pratiques pour résoudre les erreurs de l'API Google Ads.
Vérifier la connectivité
Assurez-vous d'avoir accès à l'API Google Ads et d'avoir effectué une configuration correcte. Si votre réponse renvoie des erreurs HTTP, assurez-vous de les traiter avec soin et d'accéder aux services que vous souhaitez utiliser à partir de votre code.
Vos identifiants sont intégrés à votre requête pour que les services puissent vous authentifier. Familiarisez-vous avec la structure des requêtes et des réponses de l'API Google Ads, en particulier si vous comptez gérer les appels sans utiliser les bibliothèques clientes. Chaque bibliothèque cliente est fournie avec des instructions spécifiques sur la façon d'inclure vos identifiants dans le fichier de configuration (consultez le fichier README de la bibliothèque cliente).
Vérifiez que vous utilisez les bons identifiants. Notre guide de démarrage rapide vous explique comment obtenir l' ensemble d'identifiants dont vous avez besoin. Par exemple, l'échec de réponse suivant montre que l'utilisateur a envoyé des identifiants d'authentification non valides :
{ "error": { "code": 401, "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. Visit https://developers.google.com/identity/sign-in/web/devconsole-project.", "status": "UNAUTHENTICATED", "details": [ { "@type": "type.googleapis.com/google.rpc.DebugInfo", "detail": "Authentication error: 2" } ] } }
Si vous avez suivi ces étapes et que vous rencontrez toujours des problèmes, il est temps de résoudre les erreurs de l'API Google Ads.
Identifier le problème
L'API Google Ads signale généralement les erreurs sous la forme d'un objet d'échec JSON, contenant une liste d'erreurs dans la réponse. Ces objets fournissent un code d'erreur ainsi qu'un message expliquant pourquoi l'erreur s'est produite. Ils constituent vos premiers signaux pour identifier le problème.
{
"errors": [
{
"errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
"message": "The field mask contained an invalid field: 'keyword/matchtype'.",
"location": { "operationIndex": "1" }
}
]
}
Toutes nos bibliothèques clientes génèrent des exceptions qui encapsulent les erreurs dans la réponse. La capture de ces exceptions et l'impression des messages dans un journal ou un écran de dépannage sont un excellent point de départ. L'intégration de ces informations aux autres événements enregistrés dans votre application offre une bonne vue d'ensemble de ce qui peut déclencher le problème. Une fois l'erreur identifiée dans les journaux, vous devrez déterminer ce qu'elle signifie.
Rechercher l'erreur
Consultez notre documentation sur les erreurs courantes, qui couvre les erreurs les plus fréquentes. Elle décrit le message d'erreur, les références d'API pertinentes et comment éviter ou gérer l'erreur.
Si notre documentation sur les erreurs courantes ne mentionne pas spécifiquement l'erreur, consultez notre documentation de référence et recherchez la chaîne d'erreur.
Recherchez dans nos canaux d'assistance pour accéder à d'autres développeurs qui partagent leurs expériences avec l'API. Quelqu'un d'autre a peut-être rencontré et résolu le problème que vous rencontrez.
Consultez le Centre d'aide Google Ads pour obtenir de l'aide sur la résolution des problèmes de validation ou de limites de compte. L' API Google Ads hérite des règles et des limites du produit Google Ads de base.
Les articles de blog peuvent parfois être une bonne référence pour résoudre les problèmes de votre application.
Si vous rencontrez des erreurs qui ne sont pas documentées, contactez l'assistance.
Après avoir recherché l'erreur, il est temps d'en déterminer la cause première.
Identifier la cause
Vérifiez le message d'exception pour déterminer la cause de l'erreur. Après avoir examiné la réponse, vérifiez la requête pour identifier une cause possible. Certains messages d'erreur de l'API Google Ads incluent un fieldPathElements
dans le champ location de GoogleAdsError, indiquant où l'erreur s'est produite dans la requête. Exemple :
{
"errors": [
{
"errorCode": {"criterionError": "CANNOT_ADD_CRITERIA_TYPE"},
"message": "Criteria type can not be targeted.",
"trigger": { "stringValue": "" },
"location": {
"operationIndex": "0",
"fieldPathElements": [ { "fieldName": "keyword" } ]
}
}
]
}
Lorsque vous résolvez un problème, vous constaterez peut-être que votre application fournit des informations incorrectes à l'API. Nous vous recommandons vivement d'utiliser un environnement de développement intégré (IDE), tel qu'Eclipse, (un IDE Open Source sans frais principalement utilisé pour développer en Java, mais qui dispose de plug-ins pour d'autres langages), pour vous aider à déboguer. Il vous permet de définir des points d'arrêt et de parcourir votre code ligne par ligne.
Vérifiez que la requête correspond aux entrées de votre application (par exemple, le nom de la campagne peut ne pas être inclus dans la requête). Assurez-vous d'envoyer un masque de champ qui correspond aux modifications que vous souhaitez apporter. L'API Google Ads est compatible avec les mises à jour éparses. L'omission d'un champ du masque de champ dans une requête de mutation indique que l'API doit le laisser tel quel. Si votre application récupère un objet, le modifie et le renvoie, vous écrivez peut-être dans un champ qui n'est pas compatible avec la mise à jour. Consultez la description du champ dans la documentation de référence pour voir s'il existe des restrictions sur le moment où vous pouvez mettre à jour le champ ou si vous pouvez le faire.
Obtenir de l'aide
Il n'est pas toujours possible d'identifier et de résoudre le problème par vous-même. Vous pouvez contacter l'assistance pour obtenir de l'aide.
Essayez d'inclure autant d'informations que possible dans vos requêtes. Voici quelques éléments recommandés :
- Requête et réponse JSON nettoyées. Veillez à supprimer les informations sensibles telles que votre jeton de développeur ou votre jeton d'authentification.
- Extraits de code : Si vous rencontrez un problème spécifique à une langue ou si vous avez besoin d'aide pour utiliser l'API, incluez un extrait de code pour expliquer ce que vous faites.
- RequestId Cela permet aux membres de l'équipe Google chargée des relations avec les développeurs de localiser votre requête si elle est effectuée dans l'environnement de production. Nous vous recommandons d'enregistrer dans vos journaux le requestId inclus en tant que propriété dans les exceptions qui encapsulent les erreurs de réponse, ainsi que plus de contexte que le requestId seul.
- Des informations supplémentaires, telles que la version de l'environnement d'exécution ou de l'interpréteur et la plate-forme, peuvent également être utiles lors du dépannage.
Résoudre le problème
Maintenant que vous avez identifié le problème et trouvé une solution, il est temps d'apporter votre modification et de tester le correctif sur un compte de test (de préférence) ou en production (si le bug ne s'applique qu'aux données d'un compte de production spécifique).
Étapes suivantes
Maintenant que vous avez résolu ce problème, avez-vous remarqué des moyens d'améliorer votre code pour éviter qu'il ne se reproduise ?
La création d'un bon ensemble de tests unitaires contribue considérablement à améliorer la qualité et la fiabilité du code. Elle accélère également le processus de test des nouvelles modifications pour s'assurer qu'elles n'ont pas endommagé les fonctionnalités précédentes. Une bonne stratégie de gestion des erreurs est également essentielle pour faire apparaître toutes les données nécessaires au dépannage.