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

Добавляет файл Sitemap в Яндекс Вебмастер.

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

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

В теле запроса передайте URL файла Sitemap, а также укажите требуемый тип данных в заголовке Content-type (application/json или application/xml).

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.

Пример

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

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

Примеры

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

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
201 CREATED
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"
}
409 SITEMAP_ALREADY_ADDED
Файл Sitemap уже добавлен.
{
  "error_code": "SITEMAP_ALREADY_ADDED",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}
Код Причина Описание
201 CREATED
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"
}
409 SITEMAP_ALREADY_ADDED
Файл Sitemap уже добавлен.
{
  "error_code": "SITEMAP_ALREADY_ADDED",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}