Изменение регионов фида

Определяет новый набор регионов для фида. Подробнее про регионы см. в разделе Регионы для загрузки фидов.

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

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

user-id

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

host-id

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

Пример

{
  "url": "https://example.com/some/path?a=b",
  "newRegionIds": [
  225 
  ]
}

<Data>
   <url>https://example.com/some/path?a=b</url>
   <newRegionIds>225</newRegionIds>
</Data>

Имя

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

Тип

Описание

url

Да

url

URL фида.

Если на вашем сайте настроена авторизация для доступа к YML-файлу, вы можете передавать логин и пароль вместе с URL, по которому он доступен. Например: https://yandex:WE9h4FfBml@example.com/feed.yml.

newRegionIds

Да

int32

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

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

Тело ответа не передается.

Коды ответа

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

Код

Причина

Описание

200

OK

400

NO_CHANGES

Изменение не выполнено: передан существующий набор регионов.

{
  "error_code": "NO_CHANGES",
  "error_message": "some string"
}

<Data>
  <[error_code](*error_code)>NO_CHANGES</error_code>  
  <[error_message](*error_message)>some string</error_message>
</Data>

400

WRONG_REGION

Регион не поддерживается (см. список регионов).

{
  "error_code": "WRONG_REGION",
  "error_message": "some string"
}

<Data>
  <[error_code](*error_code)>WRONG_REGION</error_code>  
  <[error_message](*error_message)>some string</error_message>
</Data>

403

INVALID_USER_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](*error_code)>INVALID_USER_ID</error_code>
    <[available_user_id](*available_user_id)>1</available_user_id>
    <[error_message](*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](*error_code)>HOST_NOT_VERIFIED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>
  <[error_message](*error_message)>some string</error_message>
</Data>

404

NOT_EXIST

На сайте отсутствует указанный фид.

{
  "error_code": "NOT_EXIST",
  "error_message": "some string"
}

<Data>
  <[error_code](*error_code)>NOT_EXIST</error_code>  
  <[error_message](*error_message)>some string</error_message>
</Data>

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

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

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

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

Да

Тип

url

Описание

URL фида.

Если на вашем сайте настроена авторизация для доступа к YML-файлу, вы можете передавать логин и пароль вместе с URL, по которому он доступен. Например: https://yandex:WE9h4FfBml@example.com/feed.yml.

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

Да

Тип

int32

Описание

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

Предыдущая
Регионы для загрузки фидов
Следующая
Передача данных о расписании