Pour discuter de nos produits et nous faire part de vos commentaires, rejoignez le canal Discord officiel Google Ads sur le serveur de la communauté Google Advertising and Measurement.

Cette page a été traduite par l'API Cloud Translation.

Gérer les erreurs d'API

Lorsque vous envoyez une requête à l'API Google Ads, elle peut échouer pour différentes raisons. Par exemple, vous pouvez fournir un argument non valide ou votre compte peut avoir atteint sa limite de création de campagnes. Dans ce cas, l'API renvoie une erreur pour vous indiquer ce qui n'a pas fonctionné.

Ce guide explique comment lire et gérer les erreurs d'API afin de créer des applications plus robustes.

Structure des erreurs

Si vous utilisez l'une de nos bibliothèques clientes, les erreurs d'API sont signalées sous forme d'exceptions. Ces exceptions contiennent des informations qui vous aident à comprendre pourquoi l'erreur s'est produite.

L'API Google Ads renvoie les informations sur les erreurs dans un format standard. En cas d'erreur, la réponse contient un objet GoogleAdsFailure. Cet objet contient une liste d'objets GoogleAdsError individuels, chacun détaillant une erreur spécifique.

Chaque objet GoogleAdsError fournit les éléments suivants :

error_code : code d'erreur spécifique qui indique le type d'erreur, par exemple AuthenticationError.NOT_ADS_USER.
message : description lisible de la raison pour laquelle l'erreur s'est produite.
trigger : valeur à l'origine de l'erreur, par exemple "1234".
location : détails sur la partie de la requête qui a provoqué l'erreur, comme le nom d'un champ spécifique.

En plus de la liste des erreurs, GoogleAdsFailure contient requestId, qui est un identifiant unique pour la requête API ayant généré une erreur.

Exemple d'erreur

Voici un exemple d'erreur au format JSON. Cette erreur indique que le champ name de ad_group à l'index 0 est manquant dans la requête.

{
  "code": 3,
  "message": "Request contains an invalid argument.",
  "details": [
    {
      "@type": "type.googleapis.com/google.ads.googleads.v22.errors.GoogleAdsFailure",
      "errors": [
        {
          "errorCode": {
            "requestError": "REQUIRED_FIELD_MISSING"
          },
          "message": "Required field is missing",
          "location": {
            "fieldPathElements": [
              {
                "fieldName": "ad_group",
                "index": 0
              },
              {
                "fieldName": "name"
              }
            ]
          }
        }
      ],
      "requestId": "unique_request_id_12345"
    }
  ]
}