API Reference

API консоли поиска предлагает следующие услуги:

  • Поисковая аналитика — запрос данных о трафике вашего сайта.
  • Карты сайта . Перечислите все свои карты сайта, запросите информацию о конкретной карте сайта и отправьте карту сайта в Google.
  • Сайты : список/добавление/удаление свойств из вашей учетной записи Search Console.
  • Проверка URL-адресов . Проверьте статус страницы в индексе Google (эквивалент проверки URL-адресов в Search Console).

Поисковая аналитика

Подробную информацию о ресурсе Search Analytics см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/webmasters/v3, если не указано иное.
запрос POST /sites/ siteUrl /searchAnalytics/query

Запрашивайте данные о поисковом трафике с помощью определяемых вами фильтров и параметров. Метод возвращает ноль или более строк, сгруппированных по определяемым вами ключам строк (измерениям). Необходимо определить диапазон дат в один или несколько дней.

Если дата является одним из измерений, дни без данных исключаются из списка результатов. Чтобы узнать, по каким дням имеются данные, выполните запрос без фильтров, сгруппированных по дате, для интересующего диапазона дат.

Результаты отсортированы по убыванию количества кликов. Если две строки имеют одинаковое количество кликов, они сортируются произвольным образом.

См. пример Python для вызова этого метода.

Пример 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 см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/webmasters/v3, если не указано иное.
удалить DELETE /sites/ siteUrl /sitemaps/ feedpath Удаляет карту сайта с этого сайта.
получать GET /sites/ siteUrl /sitemaps/ feedpath Получает информацию о конкретной карте сайта.
список GET /sites/ siteUrl /sitemaps Перечисляет записи карты сайта, отправленные для этого сайта или включенные в индексный файл карты сайта (если в запросе указан sitemapIndex ).
представлять на рассмотрение PUT /sites/ siteUrl /sitemaps/ feedpath Отправляет карту сайта.

Сайты

Подробную информацию о ресурсе Сайтов см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/webmasters/v3, если не указано иное.
добавлять PUT /sites/ siteUrl Добавляет сайт в набор сайтов пользователя в Search Console.
удалить DELETE /sites/ siteUrl Удаляет сайт из набора сайтов Search Console пользователя.
получать GET /sites/ siteUrl Получает информацию о конкретном сайте.
список GET /sites Перечисляет сайты Search Console пользователя.

Проверка URL-адресов

Подробную информацию о ресурсе проверки URL-адресов см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

Информация о предоставленном URL в индексе Google.

Пример 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"}