Получение информации о файле Sitemap

Возвращает подробную информацию о файле Sitemap, включая тип файла, дату и способ загрузки файла в Яндекс Вебмастер, дату обработки файла сервисом, количество содержащихся в файле URL, а также количество и тип обнаруженных ошибок.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/sitemaps/{sitemap-id}

`user-id`	Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
`host-id`	Тип: `host id (string)`. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
`sitemap-id`	Тип: `sitemap id (string)`. ID файла Sitemap.

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

Примеры

JSON

XML

{
  "sitemap_id": "c7-fe:80-c0",
  "sitemap_url": "some url",
  "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"
}

<Data>
    <sitemap_id>c7-fe:80-c0</sitemap_id>
    <sitemap_url>some url</sitemap_url>
    <last_access_date>2016-01-01T00:00:00,000+0300</last_access_date>
    <errors_count>1</errors_count>
    <urls_count>1</urls_count>
    <children_count>1</children_count>
    <source>ROBOTS_TXT</source>
    ...
    <sitemap_type>SITEMAP</sitemap_type>
</Data>

Имя	Обязательный	Тип	Описание
`sitemap_id`	Да	`string`	Идентификатор файла Sitemap.
`sitemap_url`	Да	`string`	URL файла Sitemap.
`last_access_date`	Да	`datetime`	Дата последней загрузки файла.
`errors_count`	Да	`int32`	Количество ошибок в файле.
`urls_count`	Да	`int64`	Количество ссылок в файле.
`children_count`	Да	`int32`	Количество дочерних файлов Sitemap.
`source`	Да	`string` (ApiSitemapSource)	Источники, из которых робот узнал об этом файле.
`sitemap_type`	Да	`string` (ApiSitemapType)	Тип файла Sitemap.

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

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

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код	Причина	Описание
200	OK
403	INVALID_USER_ID	ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже `{user_id}` указан правильный `uid` владельца OAuth-токена. JSON XML `{ "error_code": "INVALID_USER_ID", "available_user_id": 1, "error_message": "Invalid user id. {user_id} should be used." }` `<Data> <error_code>INVALID_USER_ID</error_code> <available_user_id>1</available_user_id> <error_message>Invalid user id. {user_id} should be used.</error_message> </Data>`
404	HOST_NOT_VERIFIED	Не подтверждены права на управление сайтом. JSON XML `{ "error_code": "HOST_NOT_VERIFIED", "host_id": "http:ya.ru:80", "error_message": "some string" }` `<Data> <error_code>HOST_NOT_VERIFIED</error_code> <host_id>http:ya.ru:80</host_id> <error_message>some string</error_message> </Data>`
404	HOST_NOT_LOADED	Данные о сайте еще не загружены в Яндекс Вебмастер. JSON XML `{ "error_code": "HOST_NOT_LOADED", "host_id": "http:ya.ru:80", "error_message": "some string" }` `<Data> <error_code>HOST_NOT_LOADED</error_code> <host_id>http:ya.ru:80</host_id> <error_message>some string</error_message> </Data>`
404	SITEMAP_NOT_FOUND	Файл Sitemap не найден для сайта. JSON XML `{ "error_code": "SITEMAP_NOT_FOUND", "host_id": "http:ya.ru:80", "sitemap_id": "c7-fe:80-c0", "error_message": "some string" }` `<Data> <error_code>SITEMAP_NOT_FOUND</error_code> <host_id>http:ya.ru:80</host_id> <sitemap_id>c7-fe:80-c0</sitemap_id> <error_message>some string</error_message> </Data>`

Узнайте больше

Коды ошибок и статусы

Была ли статья полезна?

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

Получение списка файлов Sitemap, добавленных пользователем