API Reference

Interfejs Search Console API oferuje te usługi:

  • Analityka wyszukiwania – tworzenie zapytań dotyczących danych o ruchu w witrynie.
  • Mapy witryn – zawierają listę wszystkich Twoich map witryn, proszą o informacje na temat konkretnej mapy witryny i przesyłają 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ółowe informacje o zasobach Search Analytics znajdziesz na stronie Reprezentowanie zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względem https://www.googleapis.com/webmasters/v3, chyba że zaznaczono inaczej
zapytanie POST  /sites/siteUrl/searchAnalytics/query

tworzyć zapytania dotyczące danych o ruchu w sieci wyszukiwania przy użyciu zdefiniowanych filtrów i parametrów; Metoda zwraca zero lub więcej wierszy pogrupowanych według zdefiniowanych przez Ciebie kluczy (wymiarów). Musisz określić zakres dat obejmujący co najmniej 1 dzień.

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

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

Zobacz przykład Pythona dla tej metody.

Przykład żądania POST w formacie 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 Reprezentowanie zasobów.

Metoda Żądanie HTTP Opis
Identyfikatory URI względem https://www.googleapis.com/webmasters/v3, chyba że zaznaczono inaczej
usuń DELETE  /sites/siteUrl/sitemaps/feedpath Usuwa mapę witryny z tej witryny.
pobierz GET  /sites/siteUrl/sitemaps/feedpath Pobiera informacje o konkretnej mapie witryny.
list GET  /sites/siteUrl/sitemaps Wyświetla wpisy map witryn przesłane na potrzeby tej witryny lub uwzględnione w pliku indeksu map witryny (jeśli w prośbie jest określony sitemapIndex).
prześlij PUT  /sites/siteUrl/sitemaps/feedpath Przesłanie mapy witryny.

Witryny

Szczegółowe informacje o zasobach Witryn znajdziesz na stronie Reprezentowanie zasobów.

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

Sprawdzenie adresu URL

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

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

Informacje o podanym adresie URL w indeksie Google.

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