API-Fehler verarbeiten

Wenn Sie eine Anfrage an die Google Ads API senden, kann sie aus verschiedenen Gründen fehlschlagen. Möglicherweise haben Sie ein ungültiges Argument angegeben oder Ihr Konto hat das Limit für das Erstellen neuer Kampagnen erreicht. In solchen Fällen gibt die API einen Fehler zurück, um Sie darüber zu informieren, was schiefgelaufen ist.

In diesem Leitfaden wird erläutert, wie Sie API-Fehler lesen und behandeln können, um robustere Anwendungen zu entwickeln.

Fehlerstruktur

Wenn Sie eine unserer Clientbibliotheken verwenden, werden API-Fehler als Ausnahmen angezeigt. Diese Ausnahmen enthalten Details, die Ihnen helfen, die Ursache des Fehlers zu verstehen.

Die Google Ads API gibt Fehlerinformationen in einem Standardformat zurück. Wenn ein Fehler auftritt, enthält die Antwort ein GoogleAdsFailure-Objekt. Dieses Objekt enthält eine Liste einzelner GoogleAdsError-Objekte, die jeweils einen bestimmten Fehler beschreiben.

Jedes GoogleAdsError-Objekt bietet Folgendes:

• error_code: Ein bestimmter Fehlercode, der den Fehlertyp angibt, z. B. AuthenticationError.NOT_ADS_USER.
• message: Eine für Menschen lesbare Beschreibung des Grunds für den Fehler.
• trigger: Der Wert, der den Fehler verursacht hat, z. B. „1234“.
• location: Details dazu, welcher Teil der Anfrage den Fehler verursacht hat, z. B. ein bestimmter Feldname.

Zusätzlich zur Liste der Fehler enthält GoogleAdsFailure eine requestId, eine eindeutige Kennung für die API-Anfrage, die zu einem Fehler geführt hat.

Beispiel für Fehlermeldung

Hier sehen Sie ein Beispiel für einen Fehler im JSON-Format. Dieser Fehler weist darauf hin, dass das Feld name des ad_group am Index 0 in der Anfrage fehlt.

{
  "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"
    }
  ]
}

Fehlerbehandlung

Wenn ein Fehler auftritt, gehen Sie so vor:

1. errors-Liste prüfen: Sehen Sie sich jedes GoogleAdsError im GoogleAdsFailure-Objekt an. Die error_code und message geben Aufschluss darüber, was schiefgelaufen ist.
2. location prüfen: Das Feld location kann Ihnen helfen, die Stelle in Ihrer Anfrage zu finden, an der das Problem aufgetreten ist.
3. Dokumentation aufrufen: Weitere Informationen zu bestimmten Fehlercodes finden Sie auf der Seite Häufige Fehler oder in der vollständigen Fehlercode-Referenz.
4. Anfrage anpassen: Korrigieren Sie Ihre API-Anfrage anhand der Fehlermeldung. Wenn Sie beispielsweise REQUIRED_FIELD_MISSING sehen, müssen Sie dieses Feld in Ihrer Anfrage angeben.
5. request_id protokollieren: Wenn Sie nicht herausfinden können, wie Sie einen Fehler beheben, und den Support über das Forum kontaktieren müssen, geben Sie die request_id an. Anhand dieser ID können Google-Techniker Ihr Problem untersuchen.

Nächste Schritte

• Unter Häufige Fehler finden Sie eine Liste häufig auftretender Probleme und deren Lösungen.
• Weitere Informationen zu erweiterten Techniken zur Fehlerbehandlung, einschließlich Wiederholungslogik und Teilausfall, finden Sie unter API-Fehler verstehen.