Fehlerbehebung

Fehler können durch eine falsche Umgebungseinrichtung, einen Fehler in Ihrer Software oder eine ungültige Eingabe eines Nutzers verursacht werden. Unabhängig von der Quelle müssen Sie das Problem beheben und entweder Ihren Code korrigieren oder Logik hinzufügen, um den Nutzerfehler zu beheben. In diesem Leitfaden werden einige Best Practices für die Fehlerbehebung bei Google Ads API-Fehlern beschrieben.

Verbindung sicherstellen

  1. Prüfen Sie, ob Sie Zugriff auf die Google Ads API haben und ob sie richtig eingerichtet ist. Wenn Ihre Antwort HTTP-Fehler zurückgibt, sollten Sie diese sorgfältig beheben und prüfen, ob Sie die Dienste erreichen, die Sie über Ihren Code verwenden möchten.

  2. Ihre Anmeldedaten sind in Ihre Anfrage eingebettet, damit die Dienste Sie authentifizieren können. Machen Sie sich mit der Struktur von Google Ads API-Anfragen und -Antworten vertraut, insbesondere wenn Sie Aufrufe ohne die Clientbibliotheken verarbeiten möchten. Jede Clientbibliothek wird mit einer spezifischen Anleitung geliefert, wie Sie Ihre Anmeldedaten in die Konfigurationsdatei einfügen (siehe README-Datei der Clientbibliothek).

  3. Prüfen Sie, ob Sie die richtigen Anmeldedaten verwenden. In unserer Kurzanleitung wird beschrieben, wie Sie die richtigen Daten erhalten. Der folgende Antwortfehler zeigt beispielsweise, dass der Nutzer ungültige Authentifizierungsdaten gesendet hat:

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

Wenn Sie diese Schritte ausgeführt haben und weiterhin Probleme auftreten, sollten Sie sich die Google Ads API-Fehler genauer ansehen.

Problem ermitteln

Die Google Ads API meldet Fehler in der Regel als JSON-Fehlerobjekt, das eine Liste von Fehlern in der Antwort enthält. Diese Objekte enthalten einen Fehlercode sowie eine Meldung, in der erläutert wird, warum der Fehler aufgetreten ist. Sie sind die ersten Hinweise darauf, was das Problem sein könnte.

{
  "errors": [
    {
      "errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
      "message": "The field mask contained an invalid field: 'keyword.match_type'.",
      "location": {
        "fieldPathElements": [
          { "fieldName": "operations", "index": 1 }
        ]
      }
    }
  ]
}

Alle unsere Clientbibliotheken lösen Ausnahmen aus, die Fehler in der Antwort kapseln. Diese Ausnahmen zu erfassen und die Meldungen in einem Protokoll oder auf einem Bildschirm zur Fehlerbehebung auszugeben, ist ein guter Anfang. Wenn Sie diese Informationen mit den anderen protokollierten Ereignissen in Ihrer Anwendung kombinieren, erhalten Sie einen guten Überblick darüber, was das Problem verursachen könnte. Nachdem Sie den Fehler in den Logs identifiziert haben, müssen Sie herausfinden, was er bedeutet.

Fehler recherchieren

  1. Weitere Informationen finden Sie in der Dokumentation zu häufigen Fehlern. Darin werden die Fehlermeldung, relevante API-Referenzen und die Vermeidung oder Behandlung des Fehlers beschrieben.

  2. Wenn der Fehler in unserer Dokumentation zu häufigen Fehlern nicht ausdrücklich erwähnt wird, suchen Sie in unserer Referenzdokumentation nach dem Fehlerstring.

  3. In unseren Supportkanälen finden Sie andere Entwickler, die ihre Erfahrungen mit der API teilen. Möglicherweise ist jemand anderes bereits auf das Problem gestoßen, das Sie haben, und hat es gelöst.

  4. In der Google Ads-Hilfe finden Sie Informationen zur Behebung von Problemen mit der Validierung oder mit Kontolimits. Die Google Ads API übernimmt die Regeln und Einschränkungen des Google Ads-Kernprodukts.

  5. Blogposts sind gelegentlich eine gute Referenz, wenn Sie Fehler in Ihrer Anwendung beheben möchten.

  6. Wenn Sie auf Fehler stoßen, die nicht dokumentiert sind, wenden Sie sich an den Support.

Nachdem Sie den Fehler untersucht haben, ist es an der Zeit, die Ursache zu ermitteln.

Ursache ermitteln

Prüfen Sie die Ausnahmemeldung, um die Ursache des Fehlers zu ermitteln. Prüfen Sie nach dem Ansehen der Antwort die Anfrage auf eine mögliche Ursache. Einige Google Ads API-Fehlermeldungen enthalten fieldPathElements im Feld location des GoogleAdsError. Das gibt an, wo in der Anfrage der Fehler aufgetreten ist. Beispiel:

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

Bei der Fehlerbehebung stellen Sie möglicherweise fest, dass Ihre Anwendung der API die falschen Informationen bereitstellt. Wir empfehlen dringend, einen Debugger für integrierte Entwicklungsumgebungen (IDE) zu verwenden, um Haltepunkte festzulegen, den Code Zeile für Zeile durchzugehen und die erstellten Anfragenutzlasten vor dem Senden zu prüfen.

Prüfen Sie, ob die Anfrage mit den Eingaben Ihrer Anwendung übereinstimmt. Beispielsweise kann es sein, dass der Name der Kampagne nicht in der Anfrage enthalten ist. Senden Sie eine Feldmaske, die den gewünschten Aktualisierungen entspricht. Die Google Ads API unterstützt dünnbesetzte Aktualisierungen. Wenn Sie ein Feld in der Feldmaske einer Mutationsanfrage weglassen, wird es von der API nicht berücksichtigt. Wenn Ihre Anwendung ein Objekt abruft, eine Änderung vornimmt und es zurücksendet, schreiben Sie möglicherweise in ein Feld, das keine Aktualisierung unterstützt. In der Referenzdokumentation finden Sie in der Beschreibung des Felds Informationen dazu, ob es Einschränkungen gibt, wann oder ob Sie das Feld aktualisieren können.

Hilfe

Es ist nicht immer möglich, das Problem selbst zu erkennen und zu beheben. Sie können sich an den Support wenden, um Unterstützung zu erhalten.

Versuchen Sie, so viele Informationen wie möglich in Ihre Abfragen aufzunehmen. Empfohlene Artikel:

  • Bereinigte JSON-Anfrage und -Antwort. Entfernen Sie vertrauliche Informationen wie Ihr OAuth-Zugriffstoken, Ihr Aktualisierungstoken und Ihre Kundennummern.
  • Code-Snippets: Wenn Sie ein sprachspezifisches Problem haben oder Hilfe bei der Arbeit mit der API benötigen, fügen Sie ein Code-Snippet ein, um zu erklären, was Sie tun.
  • request-id. So können Mitglieder des Google Developer Relations-Teams Ihre Anfrage finden, wenn sie für die Produktionsumgebung gestellt wurde. Wir empfehlen, die request-id in Antwortheadern oder Ausnahmen zu protokollieren, die Antwortfehler enthalten, sowie mehr Kontext als nur die request-id.
  • Zusätzliche Informationen wie die Laufzeit- oder Interpreterversion und die Plattform können bei der Fehlerbehebung ebenfalls nützlich sein.

Problem beheben

Nachdem Sie das Problem identifiziert und eine Lösung gefunden haben, können Sie die entsprechenden Änderungen vornehmen und das Bugfix mit einem Testkonto (bevorzugt) oder in der Produktionsumgebung testen (wenn sich der Programmfehler nur auf Daten in einem bestimmten Produktionskonto bezieht).

Nächste Schritte

Bei der Lösung Ihres Problems sind Ihnen bestimmt Möglichkeiten aufgefallen, wie Sie Ihren Code verbessern und derartige Fehler von vornherein vermeiden können.

Durch das Erstellen einer guten Reihe von Unittests können Sie die Codequalität und ‑zuverlässigkeit erheblich verbessern. Außerdem wird das Testen neuer Änderungen beschleunigt, um sicherzustellen, dass die vorherige Funktionalität nicht beeinträchtigt wurde. Eine gute Strategie zur Fehlerbehandlung ist auch wichtig, um alle erforderlichen Daten für die Fehlerbehebung zu erhalten.