Получение информации о загруженных фидах

Возвращает информацию о загруженных в Вебмастер YML-фидах для формирования дополненного представления в результатах поиска.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/feeds/list

user-id

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

host-id

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

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

Примеры

{
  "feeds": [
    {
      "url": "https://example.com/some/path?a=b",
      "type": "REALTY",
      "regionIds": [
        225
      ]
    }
  ]
}
<Data>
  <feed>
    <url>https://example.com/some/path?a=b</url>
    <type>REALTY</type>
    <regionId>225</regionId>
  </feed>
</Data>

Имя

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

Тип

Описание

url

Да

url

URL фида.

type

Да

string

Категория бизнеса, для которого загружен фид. Возможные значения:

  • REALTY — продажа или аренда квартир, офисов, домов и других построек;

  • VACANCY — предложения работы;

  • GOODS — продажа электроники, бытовой техники, строительных материалов, книг, запчастей и пр.;

  • DOCTORS — информация об услугах врачей (например, прием педиатра);

  • CARS — продажа автомобилей, мотоциклов и других средств передвижения;

  • SERVICES — объявления исполнителей бытовых и других услуг (например, перевозка мебели);

  • EDUCATION — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).

  • ACTIVITY — продажа билетов на развлекательные услуги.

regionIds

Да

int32

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

Коды ответа

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

Код

Причина

Описание

200

OK

403

INVALID_USER_ID

{
  "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>

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