Получение информации о файле Sitemap
Возвращает подробную информацию о файле Sitemap, включая тип файла, дату и способ загрузки файла в Яндекс Вебмастер, дату обработки файла сервисом, количество содержащихся в файле URL, а также количество и тип обнаруженных ошибок.
Формат запроса
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/sitemaps/{sitemap-id}
|
|
Тип: |
|
|
Тип: |
|
|
Тип: |
Формат ответа
Примеры
JSONXML{ "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. |
|
|
Да |
|
URL файла Sitemap. |
|
|
Да |
|
Дата последней загрузки файла. |
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
Источник файла Sitemap (ApiSitemapSource)
|
Источник |
Описание |
|
|
Sitemap указан в файле |
|
|
Sitemap добавлен пользователем в Яндекс Вебмастере. |
|
|
Sitemap найден в другом (индексном) файле |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
|
Код |
Причина |
Описание |
|
200 |
OK |
|
|
403 |
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже |
|
|
404 |
Не подтверждены права на управление сайтом. |
|
|
404 |
Данные о сайте еще не загружены в Яндекс Вебмастер. |
|
|
404 |
Файл Sitemap не найден. JSON
XML
|
Узнайте больше
Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
Тип: string. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
Описание
Код ошибки.
Описание
Сообщение об ошибке.
Описание
ID запрошенного сайта.
Описание
ID файла Sitemap.
Тип: string. ID файла Sitemap.
Источник файла Sitemap (ApiSitemapSource)
|
Источник |
Описание |
|
|
Sitemap указан в файле |
|
|
Sitemap добавлен пользователем в Яндекс Вебмастере. |
|
|
Sitemap найден в другом (индексном) файле |
Обязательный
Да
Тип
string
Описание
Идентификатор файла Sitemap.
Обязательный
Да
Тип
string
Описание
URL файла Sitemap.
Обязательный
Да
Тип
datetime
Описание
Дата последней загрузки файла.
Обязательный
Тип
Описание
Обязательный
Тип
Описание
Обязательный
Тип
Описание
Обязательный
Тип
Описание
Обязательный
Тип
Описание