Developer Knowledge API

Vorschau

Dieses Produkt unterliegt den "Bedingungen für Pre-GA-Angebote" im Abschnitt "Allgemeine Dienstbedingungen" der dienstspezifischen Nutzungsbedingungen. Pre-GA-Produkte stehen in der vorliegenden Form zur Verfügung und bieten möglicherweise nur eingeschränkten Support. Weitere Informationen finden Sie unter den Beschreibungen der Startphase.

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 zum Suchen relevanter Seiten-URIs und Content-Snippets basierend auf einer Abfrage.
• GetDocument oder BatchGetDocuments zum Abrufen des vollständigen Inhalts der Suchergebnisse.

Folgen Sie der Kurzanleitung, um schnell loszulegen.

Das Korpus der durchsuchbaren Inhalte ist in der Korpusreferenz aufgeführt.

Hinweis zur Vorschau: Diese Vorschauversion unterstützt das Suchen und Abrufen von Dokumentationsseiten als unstrukturierter Markdown-Inhalt.

API aktivieren

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

Tipp: Wenn Sie kein Google Cloud-Projekt haben, erstellen Sie eines gemäß der Anleitung für Google Cloud oder Firebase.

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

Authentifizierung

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

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ü 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 Option Developer Knowledge API und klicken Sie auf OK.
   • Hinweis: Wenn Sie die Developer Knowledge API gerade erst aktiviert haben, kann es einige Zeit 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

In der Korpusreferenz finden Sie Informationen dazu, in welchen Dokumenten die API sucht.

Bekannte Einschränkungen

• Markdown-Qualität:Das Markdown wird aus dem Quell-HTML generiert. Es kann zu Abweichungen oder Formatierungsproblemen kommen.
• Umfang der Inhalte: Es werden nur öffentliche Seiten in der Korpusreferenz berücksichtigt. Inhalte aus anderen Quellen wie GitHub, OSS-Websites, Blogs oder YouTube sind nicht enthalten.