Developer Knowledge API

Die Developer Knowledge API bietet programmatischen Zugriff auf die öffentliche Entwicklerdokumentation von Google. So können Sie diese Wissensdatenbank in Ihre eigenen Anwendungen und Workflows einbinden.

Übersicht

Die Developer Knowledge API ist als kanonische Quelle für den maschinenlesbaren Zugriff auf die Entwicklerdokumentation von Google konzipiert. Sie bietet zwei Hauptfunktionen:

  • SearchDocumentChunks, um anhand einer Anfrage relevante Seiten-URIs und Content-Snippets zu finden.
  • GetDocument oder BatchGetDocuments, um den vollständigen Inhalt der Suchergebnisse abzurufen.

Eine Kurzanleitung finden Sie hier.

Das Korpus durchsuchbarer Inhalte ist unter Korpusreferenz aufgeführt.

Hinweis zur Vorschau: Diese Vorabversion unterstützt das Suchen und Abrufen von Dokumentationsseiten als unstrukturierte Markdown-Inhalte.

API aktivieren

Bevor Sie die Developer Knowledge API verwenden können, müssen Sie sie für Ihr Google Cloud-Projekt aktivieren.

  1. Öffnen Sie in der Google APIs-Bibliothek die Seite zur Developer Knowledge API.
  2. Prüfen Sie, ob Sie das richtige Projekt ausgewählt haben, in dem Sie die API verwenden möchten.
  3. Klicken Sie auf Aktivieren. Zum Aktivieren oder Verwenden der API sind keine speziellen IAM-Rollen erforderlich.

Authentifizierung

Für die Verwendung der Developer Knowledge API ist ein Developer Knowledge API-Schlüssel erforderlich. So erstellen Sie ein Konto:

  1. Rufen Sie in der Google Cloud Console für das Projekt, in dem Sie die API aktiviert haben, die Seite „Anmeldedaten“ auf.
  2. Klicken Sie auf Anmeldedaten erstellen und wählen Sie im Menü die Option API-Schlüssel aus. Das Dialogfeld „API-Schlüssel erstellt“ enthält den String für den neu erstellten Schlüssel.
  3. Klicken Sie auf API-Schlüssel bearbeiten.
  4. Geben Sie im Feld Name einen Namen für den Schlüssel ein.
  5. Wählen Sie unter API-Einschränkungen die Option Schlüssel einschränken aus.
  6. Aktivieren Sie in der Liste APIs auswählen die Developer Knowledge API und klicken Sie auf OK.
    • Hinweis: Wenn Sie die Developer Knowledge API gerade erst aktiviert haben, kann es eine Weile dauern, bis sie in der Liste APIs auswählen angezeigt wird.
  7. Klicken Sie auf Speichern.

Fügen Sie diesen Developer Knowledge API-Schlüssel in Ihre Anfragen ein. Bei REST-Aufrufen sollte er beispielsweise mit dem Abfrageparameter key angegeben werden. Ein Beispiel finden Sie in der Kurzanleitung.

Enthaltene Dokumentation

Informationen dazu, in welchen Dokumenten die API sucht, finden Sie unter Corpus reference.

Bekannte Einschränkungen

  • Markdown-Qualität:Das Markdown wird aus dem Quell-HTML generiert. Möglicherweise gibt es Abweichungen oder Formatierungsprobleme.
  • Inhaltsbereich:Es werden nur öffentliche Seiten in der Corpus-Referenz berücksichtigt. Inhalte aus anderen Quellen wie GitHub, OSS-Websites, Blogs oder YouTube sind nicht enthalten.