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