Добавление файла sitemap

Описание

Позволяет добавить файл sitemap в Яндекс.Вебмастер.

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

Отправьте POST-запрос на адрес операции user-added-sitemaps ресурса сайта пользователя, в теле запроса передайте URL файла sitemap, а также укажите требуемый тип данных в заголовке Content-type (application/json или application/xml):

POST https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/user-added-sitemaps/
Content-type: application/xml

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Пример

{
  "url": "http://example.com"
}
Параметр Описание
url URL добавляемого файла sitemap.

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

В случае успешного добавления сайта сервер возвращает 201 Created.

Примеры

{
  "sitemap_id": "c7-fe:80-c0"
}
Имя Обязательный Тип Описание
sitemap_id Да string ID добавленного файла sitemap.

Ошибки

403 Forbidden

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена. Проверьте OAuth-токен.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

Сайт отсутствует в списке сайтов пользователя или на него не подтверждены права.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
host_id ID запрошенного сайта.
error_message Сообщение об ошибке.

409 Conflict

Переданный файл sitemap уже был добавлен ранее.

{
  "error_code": "SITEMAP_ALREADY_ADDED",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
error_message Сообщение об ошибке.