Получение списка файлов Sitemap, добавленных пользователем

Возвращает список файлов Sitemap, добавленных пользователем.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

Формат запроса

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps
 ? [offset=<sitemap id>]
 & [limit=<int 32>]
Path-параметры
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
Query-параметры
offsetПолучить файлы, отсчитывая от указанного (исключительно). Значение по умолчанию: 0.
limitРазмер страницы (1-100). Значение по умолчанию: 100.

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

Примеры

{
  "sitemaps": [
    {
      "sitemap_id": "c7-fe:80-c0",
      "sitemap_url": "some url",
      "added_date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ],
  "count": 1
}
Имя Обязательный Тип Описание
sitemap_id Да string Идентификатор файла Sitemap.
sitemap_url Да string URL файла Sitemap.
added_date Да datetime Дата добавления файла.
count Да int32 Общее количество файлов 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."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}