Получение списка файлов sitemap

Описание

Позволяет получить список файлов sitemap, обнаруженных роботами Яндекса.

Формат запроса

Отправьте GET-запрос на адрес операции sitemaps ресурса сайта:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/sitemaps/[?parent_id={parent_id}&limit={limit}&from={from}]

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
parent_id Нет sitemap id ID родительского sitemap.
limit Нет int32 10 Размер страницы (1-100).
from Нет sitemap id Получить sitemap-ы, отсчитывая от указанного (исключительно).

Формат ответа

В случае успеха сервер возвращает 200 OK и список файлов sitemap сайта.

Примеры

{
  "sitemaps": [
    {
      "sitemap_id": "c7-fe:80-c0",
      "sitemap_url": "explicit error message",
      "last_access_date": "2016-01-01T00:00:00,000+0300",
      "errors_count": 1,
      "urls_count": 1,
      "children_count": 1,
      "sources": [
        "ROBOTS_TXT"
      ], ...
      "sitemap_type": "SITEMAP"
    }, ...
  ]
}
Имя Обязательный Тип Описание
sitemap_id Да string ID файла sitemap.
sitemap_url Да string URL файла sitemap.
last_access_date Нет yyyy-MM-ddTHH:mm:ss,sssZ Дата последней загрузки файла.
errors_count Да int32 Количество ошибок в файле.
urls_count Да int64 Количество ссылок в файле.
children_count Да int32 Количество дочерних файлов sitemap.
source Да ApiSitemapSource Источники, из которых робот узнал об этом файле.
sitemap_type Да ApiExplicitVerificationType Тип файла sitemap.

Источник файла Sitemap (ApiSitemapSource)

Источник Описание
ROBOTS_TXT Sitemap указан в файле robots.txt сайта.
WEBMASTER Sitemap добавлен пользователем в Яндекс.Вебмастере.
INDEX_SITEMAP Sitemap найден в другом (индексном) файле sitemap.

Тип файла Sitemap (ApiSitemapType)

Тип Описание
SITEMAP Обычный файл sitemap, содержащий URL страниц сайта.
INDEX_SITEMAP Индексный файл sitemap, содержащий URL других файлов sitemap.

Ошибки

403 Forbidden

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена. Проверьте OAuth-токен.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

Сайт отсутствует в списке сайтов пользователя или на него не подтверждены права.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
host_id ID запрошенного сайта.
error_message Сообщение об ошибке.