Получение информации о Sitemap, добавленном пользователем
Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.
Возвращает подробную информацию о файле Sitemap, добавленном пользователем, включая тип файла, дату и способ загрузки файла в Яндекс Вебмастер, дату обработки файла сервисом, количество содержащихся в файле URL, а также количество и тип обнаруженных ошибок.
Формат запроса
GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/user-added-sitemaps/{sitemap-id}/
Path-параметры
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
user-id | Да | int64 | ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user. | |
host-id | Да | host id | ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts. | |
sitemap-id | Да | sitemap id | ID файла Sitemap. |
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
user-id | Да | int64 | ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user. | |
host-id | Да | host id | ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts. | |
sitemap-id | Да | sitemap id | ID файла Sitemap. |
Формат ответа
В случае успеха сервер возвращает 200 OK и информацию о запрошенном файле Sitemap.
Примеры
{
"sitemap_id": "c7-fe:80-c0",
"sitemap_url": "explicit error message",
"added_date": "2016-01-01T00:00:00,000+0300"
}
<Data>
<sitemap_id>c7-fe:80-c0</sitemap_id>
<sitemap_url>explicit error message</sitemap_url>
<added_date>2016-01-01T00:00:00,000+0300</added_date>
</Data>
Имя | Обязательный | Тип | Описание |
---|---|---|---|
sitemap_id | Да | string | ID файла sitemap. |
sitemap_url | Да | string | URL файла sitemap. |
added_date | Да | datetime | Дата последней загрузки файла. |
Имя | Обязательный | Тип | Описание |
---|---|---|---|
sitemap_id | Да | string | ID файла sitemap. |
sitemap_url | Да | string | URL файла sitemap. |
added_date | Да | datetime | Дата последней загрузки файла. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже | |
404 | HOST_NOT_VERIFIED | Не подтверждены права на управление сайтом. |
SITEMAP_NOT_ADDED | Файл Sitemap отсутствует. |
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже | |
404 | HOST_NOT_VERIFIED | Не подтверждены права на управление сайтом. |
SITEMAP_NOT_ADDED | Файл Sitemap отсутствует. |