Получение списка файлов 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)>]

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

parent_id

ID родительского Sitemap.

limit

Количество записей (1-100). Значение по умолчанию: 10.

from

Получить файлы Sitemap, отсчитывая от указанного (исключительно).

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

В случае успеха сервер возвращает 200 OK и список файлов Sitemap сайта.

Примеры

{
  "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.

Источник

Описание

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-токена.

{
  "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

Не подтверждены права на управление сайтом.

{
  "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>

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