API Reference

Interfejs Search Console API oferuje te usługi:

  • Analityka wyszukiwania – zapytania o dane dotyczące ruchu w witrynie.
  • Mapy witryn – możesz wyświetlić listę wszystkich swoich map witryn, poprosić o informacje o konkretnej mapie witryny i przesłać ją do Google.
  • Witryny – wyświetlanie, dodawanie i usuwanie usług na koncie Search Console.
  • Sprawdzenie adresu URL – pozwala sprawdzić stan strony w indeksie Google (odpowiednik narzędzia do sprawdzania adresów URL w Search Console).

Analityka wyszukiwania

Szczegóły zasobu Analityka wyszukiwania znajdziesz na stronie Reprezentacja zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/webmasters/v3, o ile nie wskazano inaczej.
zapytanie POST  /sites/siteUrl/searchAnalytics/query

Wyszukiwanie danych dotyczących ruchu w sieci wyszukiwania za pomocą zdefiniowanych przez Ciebie filtrów i parametrów. Zwraca ona 0 lub więcej wierszy zgrupowanych według zdefiniowanych przez Ciebie kluczy wierszy (wymiarów). Musisz zdefiniować zakres dat obejmujący co najmniej jeden dzień.

Jeśli jednym z wymiarów jest data, wszystkie dni bez danych są pomijane na liście wyników. Aby dowiedzieć się, dla których dni są dostępne dane, wyślij zapytanie bez filtrów pogrupowanych według daty i dla wybranego zakresu dat.

Wyniki są sortowane malejąco według liczby kliknięć. Jeśli 2 wiersze mają taką samą liczbę kliknięć, są one sortowane w dowolny sposób.

Zapoznaj się z przykładem języka Python na temat wywoływania tej metody.

Przykład żądania POST JSON: 
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"]
}

Mapy witryn

Szczegółowe informacje o zasobach map witryn znajdziesz na stronie reprezentowania zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/webmasters/v3, o ile nie wskazano inaczej.
usuń DELETE  /sites/siteUrl/sitemaps/feedpath Usuwa mapę witryny.
pobierz GET  /sites/siteUrl/sitemaps/feedpath Pobiera informacje o konkretnej mapie witryny.
list GET  /sites/siteUrl/sitemaps Zawiera listę wpisów o mapach witryn przesłanych w przypadku tej witryny lub zawartych w pliku indeksu map witryny (jeśli w żądaniu określono sitemapIndex).
prześlij PUT  /sites/siteUrl/sitemaps/feedpath Przesyła mapę witryny.

Witryny

Szczegółowe informacje o zasobach w Witrynach znajdziesz na stronie Reprezentacja zasobu.

Metoda Żądanie HTTP Opis
Identyfikatory URI są ustawiane względem adresu https://www.googleapis.com/webmasters/v3, o ile nie wskazano inaczej.
dodaj PUT  /sites/siteUrl Dodaje witrynę do zestawu witryn użytkownika w Search Console.
usuń DELETE  /sites/siteUrl Usuwa witrynę z zestawu witryn użytkownika w Search Console.
pobierz GET  /sites/siteUrl Pobiera informacje o określonej witrynie.
list GET  /sites Wyświetla listę witryn Search Console użytkownika.

Sprawdzenie adresu URL

Szczegółowe informacje o zasobach do narzędzia do sprawdzania adresów URL znajdziesz na stronie reprezentowania zasobu.

Metoda Żądanie HTTP Opis
Identyfikator URI względem https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

Informacje o podanym adresie URL w indeksie Google.

Przykład żądania POST JSON: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}