API Reference

API Search Console предлагает следующие услуги:

  • Search Analytics — запрос данных о трафике для вашего сайта.
  • Файлы Sitemap — список всех ваших файлов Sitemap, запрос информации о конкретном файле Sitemap и отправка файла Sitemap в 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"}
,

API Search Console предлагает следующие услуги:

  • Search Analytics — запрос данных о трафике для вашего сайта.
  • Файлы Sitemap — список всех ваших файлов Sitemap, запрос информации о конкретном файле Sitemap и отправка файла Sitemap в 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"}
,

API Search Console предлагает следующие услуги:

  • Search Analytics — запрос данных о трафике для вашего сайта.
  • Файлы Sitemap — список всех ваших файлов Sitemap, запрос информации о конкретном файле Sitemap и отправка файла Sitemap в 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"}