Асинхронная загрузка фида

Асинхронно добавляет YML-фиды для загрузки в Вебмастер. Используйте этот метод, если фиды долго генерируются.

Загружая фид, вы соглашаетесь с условиями использования сервиса.

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

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

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/feeds/add/start
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.

Пример

{
  "feed": {
    "url": "https://example.com/some/path?a=b",
    "type": "REALTY",
    "regionIds": [
      225 
    ]
  }
}
Имя Обязательный Тип Описание
url Да url

URL фида.

Если на вашем сайте настроена авторизация для доступа к YML-файлу, вы можете передавать логин и пароль вместе с URL, по которому он доступен. Например: https://yandex:WE9h4FfBml@example.com/feed.yml.
type Да string
Категория бизнеса, для которого загружен фид. Возможные значения:
  • REALTY — продажа или аренда квартир, офисов, домов и других построек;
  • VACANCY — предложения работы;
  • GOODS — продажа электроники, бытовой техники, строительных материалов, книг, запчастей и пр.;
  • DOCTORS — информация об услугах врачей (например, прием педиатра);
  • CARS — продажа автомобилей, мотоциклов и других средств передвижения;
  • SERVICES — объявления исполнителей бытовых и других услуг (например, перевозка мебели);
  • EDUCATION — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).
  • ACTIVITY — продажа билетов на развлекательные услуги.
regionIds Нет int32

Идентификаторы регионов, для которых сформирован фид. Можно указать несколько идентификатор через запятую (например, 1, 2). Если значение не передано, задается значение 225 (Россия).
Имя Обязательный Тип Описание
url Да url

URL фида.

Если на вашем сайте настроена авторизация для доступа к YML-файлу, вы можете передавать логин и пароль вместе с URL, по которому он доступен. Например: https://yandex:WE9h4FfBml@example.com/feed.yml.
type Да string
Категория бизнеса, для которого загружен фид. Возможные значения:
  • REALTY — продажа или аренда квартир, офисов, домов и других построек;
  • VACANCY — предложения работы;
  • GOODS — продажа электроники, бытовой техники, строительных материалов, книг, запчастей и пр.;
  • DOCTORS — информация об услугах врачей (например, прием педиатра);
  • CARS — продажа автомобилей, мотоциклов и других средств передвижения;
  • SERVICES — объявления исполнителей бытовых и других услуг (например, перевозка мебели);
  • EDUCATION — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).
  • ACTIVITY — продажа билетов на развлекательные услуги.
regionIds Нет int32

Идентификаторы регионов, для которых сформирован фид. Можно указать несколько идентификатор через запятую (например, 1, 2). Если значение не передано, задается значение 225 (Россия).

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

Примеры

{
  "requestId": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a"
}
Имя Обязательный Тип Описание
requestId Да UUID Идентификатор загрузки. Используйте его для отслеживания статуса с помощью метода GET /v4/user/{user_id}/hosts/{host_id}/feeds/add/info.
Имя Обязательный Тип Описание
requestId Да UUID Идентификатор загрузки. Используйте его для отслеживания статуса с помощью метода GET /v4/user/{user_id}/hosts/{host_id}/feeds/add/info.

Коды ответа

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

Код Причина Описание
200 OK
403 FEEDS_LIMIT_EXCEEDED 
{
 "error_code": "FEEDS_LIMIT_EXCEEDED",
 "limit": 1,
 "error_message": "explicit error message"
}
403 INVALID_USER_ID 
{
  "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"
}
404 FEED_ALREADY_ADDED 
{
  "error_code": "FEED_ALREADY_ADDED",
  "error_message": "some string"
}
404 ONLY_HTTPS 
{
  "error_code": "ONLY_HTTPS",
  "error_message": "some string"
}
404 INCORRECT_URL 
{
  "error_code": "INCORRECT_URL",
  "error_message": "some string"
}
404 WRONG_REGION 
{
  "error_code": "WRONG_REGION",
  "error_message": "some string"
}
Код Причина Описание
200 OK
403 FEEDS_LIMIT_EXCEEDED 
{
 "error_code": "FEEDS_LIMIT_EXCEEDED",
 "limit": 1,
 "error_message": "explicit error message"
}
403 INVALID_USER_ID 
{
  "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"
}
404 FEED_ALREADY_ADDED 
{
  "error_code": "FEED_ALREADY_ADDED",
  "error_message": "some string"
}
404 ONLY_HTTPS 
{
  "error_code": "ONLY_HTTPS",
  "error_message": "some string"
}
404 INCORRECT_URL 
{
  "error_code": "INCORRECT_URL",
  "error_message": "some string"
}
404 WRONG_REGION 
{
  "error_code": "WRONG_REGION",
  "error_message": "some string"
}