Les erreurs peuvent être dues à une configuration incorrecte de l'environnement, à un bug dans votre logiciel ou à une saisie non valide de la part d'un utilisateur. Quelle que soit la source, vous devrez résoudre le problème en corrigeant votre code ou en ajoutant 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 de l'avoir correctement configurée. Si votre réponse renvoie des erreurs HTTP, assurez-vous de les résoudre avec soin et de pouvoir 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 prévoyez de 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 de données dont vous avez besoin. Par exemple, l'échec de réponse suivant indique 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.match_type'.",
"location": {
"fieldPathElements": [
{ "fieldName": "operations", "index": 1 }
]
}
}
]
}
Toutes nos bibliothèques clientes génèrent des exceptions qui encapsulent les erreurs dans la réponse. Pour commencer, vous pouvez capturer ces exceptions et imprimer les messages dans un journal ou sur un écran de dépannage. L'intégration de ces informations aux autres événements enregistrés dans votre application offre un bon aperçu de ce qui peut déclencher le problème. Une fois que vous avez identifié l'erreur dans les journaux, vous devez comprendre ce qu'elle signifie.
Faites des recherches sur l'erreur.
Consultez notre documentation sur les erreurs courantes, qui couvre les erreurs les plus fréquentes. Il décrit le message d'erreur, les références d'API pertinentes et comment éviter ou gérer l'erreur.
Si la 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.
Consultez nos canaux d'assistance pour accéder à d'autres développeurs qui partagent leurs expériences avec l'API. Il est possible qu'une autre personne ait rencontré le problème que vous rencontrez et l'ait résolu.
Consultez le Centre d'aide Google Ads pour résoudre les 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 principal.
Les articles de blog peuvent parfois être une bonne référence pour résoudre les problèmes liés à 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
Consultez 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 fieldPathElements dans le champ location de GoogleAdsError, ce qui indique 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": {
"fieldPathElements": [
{ "fieldName": "operations", "index": 0 },
{ "fieldName": "create" },
{ "fieldName": "keyword" }
]
}
}
]
}
Lorsque vous résolvez un problème, vous pouvez constater que votre application fournit des informations incorrectes à l'API. Nous vous recommandons vivement d'utiliser un débogueur d'environnement de développement intégré (IDE) pour définir des points d'arrêt, parcourir votre code ligne par ligne et inspecter les charges utiles de requête construites avant leur envoi.
Vérifiez que la demande correspond aux entrées de votre application (par exemple, il est possible que le nom de la campagne ne soit pas inclus dans la demande). Assurez-vous d'envoyer un masque de champ correspondant aux modifications que vous souhaitez apporter. L'API Google Ads accepte les mises à jour éparses. Si vous omettez un champ du masque de champ dans une requête de modification, cela indique à l'API de le laisser tel quel. Si votre application récupère un objet, le modifie et le renvoie, il est possible que vous écriviez dans un champ qui ne permet pas les mises à jour. Consultez la description du champ dans la documentation de référence pour savoir s'il existe des restrictions concernant le moment où vous pouvez le modifier ou si vous pouvez le modifier.
Obtenir de l'aide
Il n'est pas toujours possible d'identifier et de résoudre le problème 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 exemples d'éléments recommandés :
- Requête et réponse JSON nettoyées. Veillez à supprimer les informations sensibles telles que votre jeton d'accès OAuth, votre jeton d'actualisation, votre jeton de développeur (s'il est toujours inclus dans les anciens en-têtes de requête) et vos numéros client.
- 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.
request-id. Cela permet aux membres de l'équipe Google Developer Relations de localiser votre demande si elle est effectuée dans l'environnement de production. Nous vous recommandons de consigner lerequest-idinclus dans les en-têtes de réponse ou les exceptions qui encapsulent les erreurs de réponse, ainsi que plus de contexte que lerequest-idseul.- Des informations supplémentaires, telles que la version du runtime ou de l'interpréteur et la plate-forme, peuvent également être utiles pour le dépannage.
Résoudre le problème
Maintenant que vous avez identifié le problème et trouvé une solution, il est temps de modifier le code et de tester la correction 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 l'éviter en premier lieu ?
La création d'un bon ensemble de tests unitaires contribue considérablement à améliorer la qualité et la fiabilité du code. Il accélère également le processus de test des nouvelles modifications pour s'assurer qu'elles n'ont pas affecté les fonctionnalités précédentes. Une bonne stratégie de gestion des exceptions est également essentielle pour faire apparaître toutes les données nécessaires au dépannage.