API Reference

Die Search Console API bietet die folgenden Dienste:

  • Suchanalyse – Hiermit können Sie Zugriffsdaten für Ihre Website abfragen.
  • Sitemaps: Hier kannst du alle deine Sitemaps angeben, Informationen zu einer bestimmten Sitemap anfordern und eine Sitemap an Google senden.
  • Websites – Hier können Sie Properties in Ihrem Search Console-Konto auflisten, hinzufügen oder entfernen.
  • URL-Prüfung – Hier kannst du den Status einer Seite im Google-Index prüfen (entsprechend der URL-Prüfung in der Search Console).

Suchanalyse

Ausführliche Informationen zu Ressourcen vom Typ „Search Analytics“ finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/webmasters/v3, sofern nicht anders angegeben.
query POST  /sites/siteUrl/searchAnalytics/query

Daten zu Suchzugriffen mithilfe von Filtern und Parametern abfragen Die Methode gibt null oder mehr Zeilen zurück, die nach den von Ihnen definierten Zeilenschlüsseln (Dimensionen) gruppiert sind. Sie müssen einen Zeitraum von einem oder mehreren Tagen festlegen.

Wenn das Datum eine der Dimensionen ist, werden alle Tage ohne Daten aus der Ergebnisliste ausgelassen. Um herauszufinden, an welchen Tagen Daten vorhanden sind, stellen Sie eine Abfrage ohne Filter, die nach Datum für den gewünschten Zeitraum gruppiert sind.

Die Ergebnisse werden absteigend nach der Klickanzahl sortiert. Wenn zwei Zeilen dieselbe Klickanzahl haben, werden sie auf beliebige Weise sortiert.

Informationen zum Aufrufen dieser Methode finden Sie im Python-Beispiel.

Beispiel für einen JSON-POST:
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Sitemaps

Weitere Informationen zu Sitemaps-Ressourcen finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/webmasters/v3, sofern nicht anders angegeben.
Delete DELETE  /sites/siteUrl/sitemaps/feedpath Löscht eine Sitemap von dieser Website.
erhalten GET  /sites/siteUrl/sitemaps/feedpath Ruft Informationen zu einer bestimmten Sitemap ab.
list GET  /sites/siteUrl/sitemaps Listet die für diese Website eingereichten Sitemap-Einträge auf oder enthält sie in der Sitemap-Indexdatei (sofern in der Anfrage sitemapIndex angegeben ist).
Senden PUT  /sites/siteUrl/sitemaps/feedpath Übermittelt eine Sitemap für eine Website.

Websites

Ausführliche Informationen zu Ressourcen vom Typ "Sites" finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/webmasters/v3, sofern nicht anders angegeben.
Hinzufügen PUT  /sites/siteUrl Fügt eine Website zu den Websites des Nutzers in der Search Console hinzu.
Delete DELETE  /sites/siteUrl Entfernt eine Website aus den Search Console-Websites des Nutzers.
erhalten GET  /sites/siteUrl Ruft Informationen zu bestimmten Websites ab.
list GET  /sites Listet die Search Console-Websites des Nutzers auf.

URL-Prüfung

Ausführliche Informationen zu Ressourcen vom Typ „URL-Prüfung“ finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URI relativ zu https://searchconsole.googleapis.com/v1
index.inspektion POST /urlInspection/index:inspect

Informationen zur angegebenen URL im Google-Index

Beispiel für einen JSON-POST:
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}