In diesem Dokument werden die Schritte beschrieben, die Sie vor dem Schreiben Ihrer ersten Clientanwendung ausführen sollten.
Erstellen Sie sich ein Google-Konto
Sie benötigen ein Google-Konto, um diese API verwenden zu können. Dein Konto muss die entsprechende Search Console-Berechtigung für eine bestimmte Property haben, um diese Methode für diese Property aufrufen zu können. Um beispielsweise searchAnalytics.query auszuführen, benötigen Sie Leseberechtigungen für diese Property.
Google Search Console testen
In dieser API-Dokumentation wird davon ausgegangen, dass Sie die Google Search Console verwendet haben und mit Webprogrammierkonzepten und Webdatenformaten vertraut sind.
Wenn Sie die Google Search Console noch nicht verwendet haben, probieren Sie die Benutzeroberfläche aus, bevor Sie mit dem Programmieren beginnen. Jede API stellt die Funktionen eines Berichts in der Search Console dar. Lesen Sie die Dokumentation für den entsprechenden Bericht, bevor Sie eine API verwenden, um die erhaltenen Daten zu verstehen.
Projekt und Anmeldedaten für Ihren Client erstellen
Bevor Sie Anfragen an die Google Search Console 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 die Anwendung.
Für alle Search Console APIs mit Ausnahme der Testing Tools API sind OAuth2-Anmeldedaten erforderlich. Die Kurzanleitungen für Python und Java enthalten ausführliche Informationen zum Erstellen eines Projekts und zum Abrufen von Anmeldedaten für Ihren Client.
Informationen zu 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.
Grundlagen von REST
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 Search Console API
Die API-Vorgänge der Google Search Console sind direkt REST-HTTP-Verben zugeordnet.
Das Format für die meisten Google Search Console API-URIs sieht etwa so aus:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
Die vollständige Liste der URIs und Verben der einzelnen Methoden finden Sie in der Referenz zur Google Search Console API.
JSON-Grundlagen
Die Google Search Console 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.