Bevor Sie mit der Codierung Ihrer ersten Client-Anwendung beginnen, müssen Sie einige Vorbereitungen treffen (falls noch nicht geschehen).
Erstellen Sie sich ein Google-Konto
Sie benötigen ein Google-Konto, um in der Google API Console ein Projekt erstellen zu können. Wenn Sie bereits ein solches Konto haben, sind Sie schon startklar.
Für Testzwecke könnte ein separates Google-Konto sinnvoll sein.
Projekt für den Client erstellen
Bevor Sie Anfragen an die Google Knowledge Graph Search API senden können, müssen Sie Google über Ihren Client informieren und den Zugriff auf die API aktivieren. Erstellen Sie dazu mit der Google API-Konsole ein Projekt, d. h. eine benannte Sammlung von Einstellungen und API-Zugriffsinformationen, und registrieren Sie Ihre Anwendung.
Um die Google Knowledge Graph Search API verwenden zu können, müssen Sie zuerst das Einrichtungstool verwenden. Damit können Sie ein Projekt in der Google API Console erstellen, die API aktivieren und Anmeldedaten erstellen.
Erstellen Sie, falls noch nicht geschehen, den API-Schlüssel für die Anwendung. Dazu klicken Sie auf Anmeldedaten erstellen > API-Schlüssel. Suchen Sie als Nächstes im Abschnitt API-Schlüssel nach Ihrem API-Schlüssel.
Informieren Sie sich über die REST-Grundlagen
Es gibt zwei Möglichkeiten, die API aufzurufen:
- HTTP-Anfragen senden und die Antworten parsen
- Clientbibliotheken verwenden
Wenn Sie sich gegen die Verwendung von Clientbibliotheken entscheiden, müssen Sie die Grundlagen von REST verstehen.
REST ist eine Art Softwarearchitektur, die einen bequemen und einheitlichen Ansatz zur Abfrage und Bearbeitung von Daten bietet.
REST steht für "Representational State Transfer". Im Kontext der Google APIs ist damit die Verwendung von HTTP-Verben gemeint, um Darstellungen von Daten, die bei Google gespeichert sind, abzufragen und zu bearbeiten.
In einem als "RESTful" bezeichneten System werden Ressourcen in einem Datenspeicher abgelegt; ein Client sendet eine Aufforderung, der Server möge eine bestimmte Aktion ausführen (z. B. eine Ressource erstellen, abfragen, aktualisieren oder löschen), und der Server führt die Aktion aus und sendet eine Antwort, oft in Form einer Darstellung der angegebenen Ressource.
In den RESTful APIs von Google gibt der Client eine Aktion über ein HTTP-Verb wie POST, GET, PUT oder DELETE an. Sie gibt eine Ressource durch einen global eindeutigen URI im folgenden Format an:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Weil alle API-Ressourcen eindeutige, über HTTP zugängliche URIs haben, ermöglicht REST das Caching von Daten und ist optimal geeignet, mit der verteilten Infrastruktur des Webs zu arbeiten.
Dafür können die Methodendefinitionen in der Dokumentation der HTTP 1.1-Standards hilfreich sein. Hier finden Sie auch die Spezifikationen für GET, POST, PUT und DELETE.
REST in der Google Knowledge Graph Search API
Die Google Knowledge Graph Search API-Vorgänge sind REST-HTTP-Verben direkt zugeordnet.
Für Google Knowledge Graph Search API-URIs gelten folgende spezielle Formate:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
Die vollständige Gruppe von URIs, die für die einzelnen unterstützten Vorgänge in der API verwendet wird, ist im Dokument Google Knowledge Graph Search API-Referenz zusammengefasst.
Informationen zu JSON-Grundlagen
Die Google Knowledge Graph Search API gibt Daten im JSON-Format zurück.
JSON (JavaScript Object Notation) ist ein gängiges sprachunabhängiges Datenformat, das eine einfache Textdarstellung beliebiger Datenstrukturen bietet. Weitere Informationen finden Sie unter json.org.