API Reference

Die Search Console API bietet folgende Dienste:

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

Suchanalyse

Ausführliche Informationen zu Ressourcen für Suchanalysen erhalten 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

Sie können Ihre Daten zu Suchzugriffen mit von Ihnen definierten 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 Datumsbereich von einem oder mehreren Tagen festlegen.

Wenn „Datum“ eine der Dimensionen ist, werden alle Tage ohne Daten aus der Ergebnisliste ausgeschlossen. Um zu erfahren, für welche Tage Daten verfügbar sind, geben Sie für den gewünschten Zeitraum eine Abfrage ohne nach Datum gruppierte Filter aus.

Die Ergebnisse werden absteigend nach der Anzahl der Klicks sortiert. Wenn zwei Zeilen die gleiche Anzahl an Klicks aufweisen, werden sie beliebig sortiert.

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

Beispiel für 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

Ausführliche Informationen zu Ressourcen in Sitemaps erhalten 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.
get GET  /sites/siteUrl/sitemaps/feedpath Ruft Informationen zu einer bestimmten Sitemap ab.
list GET  /sites/siteUrl/sitemaps Listet die Sitemap-Einträge auf, die für diese Website eingereicht oder in der Sitemap-Indexdatei enthalten sind (falls in der Anfrage sitemapIndex angegeben ist).
Senden PUT  /sites/siteUrl/sitemaps/feedpath Reicht eine Sitemap für eine Website ein.

Websites

Ausführliche Informationen zu Ressourcen vom Typ "Sites" erhalten 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 zur Gruppe der Websites des Nutzers in der Search Console hinzu.
delete DELETE  /sites/siteUrl Entfernt eine Website aus der Gruppe der Search Console-Websites des Nutzers.
get GET  /sites/siteUrl Ruft Informationen über eine bestimmte Website ab.
list GET  /sites Listet die Search Console-Websites des Nutzers auf.

URL-Prüfung

Ausführliche Informationen zu Ressourcen zur URL-Prüfung finden Sie auf der Seite Ressourcendarstellung.

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

Informationen zur angegebenen URL im Google-Index.

Beispiel für 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"}