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

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

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

В теле запроса передайте 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

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

Пример

{
  "url": "http://example.com"
}
<Data>
    <url>http://example.com</url>
</Data>

Параметр

Описание

url

URL добавляемого файла Sitemap.

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

Примеры

{
  "sitemap_id": "c7-fe:80-c0"
}
<Data>
    <sitemap_id>c7-fe:80-c0</sitemap_id>
</Data>

Имя

Обязательный

Тип

Описание

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

409

SITEMAP_ALREADY_ADDED

Файл Sitemap уже добавлен.

{
  "error_code": "SITEMAP_ALREADY_ADDED",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}
<Data>
  <error_code>SITEMAP_ALREADY_ADDED</error_code> 
  <sitemap_id>c7-fe:80-c0</sitemap_id>  
  <error_message>some string</error_message>
</Data>

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

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

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

Описание

Код ошибки.

Описание

Сообщение об ошибке.

Описание

ID запрошенного сайта.

Описание

ID файла Sitemap.

Описание

ID пользователя, от имени которого разрешен доступ.

Описание

URL добавляемого файла Sitemap.

Обязательный

Да

Тип

string

Описание

ID добавленного файла Sitemap.