Voraussetzungen

In diesem Dokument wird beschrieben, was Sie tun sollten, bevor Sie Ihre erste Clientanwendung schreiben.

Erstellen Sie sich ein Google-Konto

Sie benötigen ein Google-Konto, um diese API nutzen zu können. Ihr Konto muss die entsprechende Search Console-Berechtigung für eine bestimmte Property haben, um diese Methode für diese Property aufzurufen. Zum Ausführen von searchAnalytics.query benötigen Sie beispielsweise Leseberechtigungen für diese Property.

Google Search Console ausprobieren

In dieser API-Dokumentation wird davon ausgegangen, dass Sie bereits die Google Search Console verwendet haben und mit Webprogrammierung 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. Bevor Sie eine API verwenden, sollten Sie die Dokumentation zum entsprechenden Bericht lesen, damit Sie die erhaltenen Daten nachvollziehen können.

Projekt und Anmeldedaten für den Client erstellen

Bevor du Anfragen an die Google Search Console senden kannst, musst du Google über deinen Client informieren und den Zugriff auf die API aktivieren. Dazu verwenden Sie die Google API Console, um ein Projekt, eine benannte Sammlung von Einstellungen und API-Zugriffsinformationen, zu erstellen und Ihre Anwendung zu registrieren.

Für alle Search Console APIs mit Ausnahme der Testing Tools API sind OAuth2-Anmeldedaten erforderlich. In den Kurzanleitungen für Python und Java wird beschrieben, wie Sie ein Projekt erstellen und Anmeldedaten für Ihren Client abrufen.

REST-Grundlagen

Es gibt zwei Möglichkeiten, die API aufzurufen:

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 mit einem HTTP-Verb wie POST, GET, PUT oder DELETE an. Eine Ressource wird durch einen global eindeutigen URI im folgenden Format angegeben:

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 Google Search Console API-Vorgänge sind REST-HTTP-Verben direkt zugeordnet.

Die meisten Google Search Console API-URIs haben folgendes Format:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

Die vollständige Liste der URIs und Verben, die für jede Methode verwendet werden, finden Sie in der Übersicht über die Google Search Console API-Referenz.

JSON-Grundlagen verstehen

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.