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