Types d'erreurs

Nous avons classé les erreurs dans les catégories générales suivantes :

  • Authentification
  • Tentatives
  • Validation
  • Synchronisation

Bien que ces catégories ne couvrent pas toutes les erreurs possibles et que certaines puissent appartenir à plusieurs catégories, elles peuvent néanmoins servir de point de départ pour structurer la gestion des erreurs de votre application. Pour en savoir plus sur des erreurs spécifiques, consultez les ressources suivantes :

  • Erreurs courantes fournit plus d'informations sur une erreur particulière.
  • google.rpc.Status pour en savoir plus sur le modèle d'erreur logique utilisé par l'API.
  • Codes d'erreur canoniques pour obtenir la liste et l'explication des codes d'erreur canoniques définis par gRPC et HTTP dans le contexte de l'API Google Ads.

Erreurs d'authentification

L'authentification consiste à déterminer si un utilisateur a autorisé votre application à accéder à Google Ads en son nom. L'authentification est gérée par des identifiants générés par le flux OAuth2.

La raison la plus courante pour laquelle une erreur d'authentification survient en dehors de votre contrôle est que l'utilisateur authentifié a révoqué l'autorisation qu'il a accordée à votre application d'agir en son nom. Par exemple, si votre application gère des comptes Google Ads distincts pour des clients indépendants et s'authentifie séparément en tant que chaque client lors de la gestion du compte de ce client, un client peut révoquer l'accès de votre application à tout moment. Selon le moment où votre accès a été révoqué, l'API peut renvoyer directement une erreur AuthenticationError.OAUTH_TOKEN_REVOKED, ou les objets d'identifiants intégrés dans les bibliothèques clientes peuvent générer une exception de jeton révoqué. Dans les deux cas, si votre application dispose d'une interface utilisateur pour vos clients, elle peut leur demander de relancer le flux OAuth2 pour rétablir l'autorisation de votre application à agir en leur nom.

Erreurs récupérables

Certaines erreurs, telles que TRANSIENT_ERROR ou INTERNAL_ERROR, peuvent indiquer un problème temporaire qui peut être résolu en relançant la requête après une courte pause.

Pour les requêtes initiées par l'utilisateur, une stratégie consiste à indiquer immédiatement une erreur dans votre interface utilisateur et à donner à l'utilisateur la possibilité de déclencher une nouvelle tentative. Vous pouvez également faire en sorte que votre application relance automatiquement la requête, et n'affiche l'erreur dans l'interface utilisateur qu'après avoir atteint un nombre maximal de tentatives ou un temps d'attente total de l'utilisateur.

Pour les requêtes initiées sur le backend, votre application doit relancer automatiquement la requête jusqu'à un nombre maximal de tentatives.

Lorsque vous relancez des requêtes, utilisez une stratégie d'intervalle exponentiel entre les tentatives. Par exemple, si vous mettez en pause 5 secondes avant la première tentative, vous pouvez mettre en pause 10 secondes après la deuxième et 20 secondes après la troisième. L'intervalle exponentiel entre les tentatives permet de s'assurer que vous n'appelez pas l'API de manière trop agressive.

Erreurs de validation

Les erreurs de validation indiquent qu'une entrée d'une opération n'était pas acceptable. Par exemple, PolicyViolationError, DateError, DateRangeError, StringLengthError et UrlFieldError.

Les erreurs de validation se produisent le plus souvent dans les requêtes initiées par l'utilisateur, lorsqu'un utilisateur a saisi une entrée non valide. Dans ce cas, vous devez fournir un message d'erreur approprié à l'utilisateur en fonction de l'erreur d'API spécifique que vous avez reçue. Vous pouvez également valider les entrées utilisateur pour les erreurs courantes avant d'effectuer un appel d'API, ce qui rend votre application plus réactive et votre utilisation de l'API plus efficace. Pour les requêtes provenant du backend, votre application peut ajouter l'opération ayant échoué à une file d'attente pour qu'un opérateur humain l'examine.

De nombreuses applications Google Ads gèrent une base de données locale pour stocker leurs objets Google Ads. L'un des défis de cette approche est que la base de données locale peut ne plus être synchronisée avec les objets réels dans Google Ads. Par exemple, un utilisateur peut supprimer un groupe d'annonces directement dans Google Ads, mais l'application et la base de données locale ne sont pas au courant de la modification et continuent d'émettre des appels d'API comme si le groupe d'annonces existait. Ces problèmes de synchronisation peuvent se manifester sous différentes erreurs, telles que DUPLICATE_CAMPAIGN_NAME, DUPLICATE_ADGROUP_NAME, AD_NOT_UNDER_ADGROUP, CANNOT_OPERATE_ON_REMOVED_ADGROUPAD, et bien d'autres.

Pour les requêtes initiées par l'utilisateur, une stratégie consiste à alerter l'utilisateur sur un éventuel problème de synchronisation, à lancer immédiatement une tâche qui récupère la classe d'objets Google Ads pertinente et met à jour la base de données locale, puis à inviter l'utilisateur à actualiser l'interface utilisateur.

Pour les requêtes backend, certaines erreurs fournissent suffisamment d'informations pour que votre application corrige automatiquement et progressivement votre base de données locale. Par exemple, CANNOT_OPERATE_ON_REMOVED_ADGROUPAD doit amener votre application à marquer cette annonce comme supprimée dans votre base de données locale. Les erreurs que vous ne pouvez pas gérer de cette manière peuvent entraîner le lancement d'une tâche de synchronisation plus complète par votre application ou être ajoutées à une file d'attente pour qu'un opérateur humain les examine.

Suivant
Comprendre les erreurs d'API