update
Изменяет параметры фида.
Ограничения
Не более 50 фидов в одном вызове метода.
Изменение типа бизнеса и типа источника не допускается.
Запрос
Структура запроса в формате JSON:
{
"method": "update",
"params": { /* params */
"Feeds": [{ /* FeedUpdateItem */
"Id": (long), /* required */
"Name": (string),
"UrlFeed": { /* UrlFeedUpdate */
"Url": (string),
"Login": (string), /* nillable */
"Password": (string), /* nillable */
"RemoveUtmTags": ( "YES" | "NO" )
},
"FileFeed": { /* FileFeedUpdate */
"Data": (base64Binary), /* required */
"Filename": (string) /* required */
}
}, ... ] /* required */
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / UpdateRequest (для SOAP) | |||
---|---|---|---|
Feeds | array of FeedUpdateItem | Фиды, которые требуется изменить. | Да |
Структура FeedUpdateItem | |||
Id | long | Идентификатор фида. | Да |
Name | string | Название фида. Не более 255 символов. | Нет |
UrlFeed | UrlFeedUpdate | Параметры фида, доступного по ссылке. | Нет |
FileFeed | FileFeedUpdate | Параметры фида, переданного в запросе. | Нет |
Структура UrlFeedUpdate | |||
Url | string | Ссылка на фид. Не более 1024 символов. Должна содержать протокол и доменное имя. | Нет |
Login | string, nillable | Логин для доступа к фиду (если требуется). Не более 255 символов. | Нет |
Password | string, nillable | Пароль для доступа к фиду (если требуется). Не более 255 символов. | Нет |
RemoveUtmTags | YesNoEnum | Автоматически удалять UTM-метки из ссылок в фиде. Значение по умолчанию — NO. | Нет |
Структура FileFeedUpdate | |||
Data | base64Binary | Загружаемый фид, закодированный в base64. Размер фида ограничен общим размером запроса — не более 50 Мб. Примечание. При использовании SOAP-библиотеки в это поле следует поместить непосредственно файл фида, а библиотека автоматически при передаче закодирует их в base64. При использовании формата JSON следует предварительно закодировать бинарные данные в base64 и передать их как строку. | Да |
Filename | string | Имя файла фида. Не более 255 символов. | Да |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / UpdateRequest (для SOAP) | |||
---|---|---|---|
Feeds | array of FeedUpdateItem | Фиды, которые требуется изменить. | Да |
Структура FeedUpdateItem | |||
Id | long | Идентификатор фида. | Да |
Name | string | Название фида. Не более 255 символов. | Нет |
UrlFeed | UrlFeedUpdate | Параметры фида, доступного по ссылке. | Нет |
FileFeed | FileFeedUpdate | Параметры фида, переданного в запросе. | Нет |
Структура UrlFeedUpdate | |||
Url | string | Ссылка на фид. Не более 1024 символов. Должна содержать протокол и доменное имя. | Нет |
Login | string, nillable | Логин для доступа к фиду (если требуется). Не более 255 символов. | Нет |
Password | string, nillable | Пароль для доступа к фиду (если требуется). Не более 255 символов. | Нет |
RemoveUtmTags | YesNoEnum | Автоматически удалять UTM-метки из ссылок в фиде. Значение по умолчанию — NO. | Нет |
Структура FileFeedUpdate | |||
Data | base64Binary | Загружаемый фид, закодированный в base64. Размер фида ограничен общим размером запроса — не более 50 Мб. Примечание. При использовании SOAP-библиотеки в это поле следует поместить непосредственно файл фида, а библиотека автоматически при передаче закодирует их в base64. При использовании формата JSON следует предварительно закодировать бинарные данные в base64 и передать их как строку. | Да |
Filename | string | Имя файла фида. Не более 255 символов. | Да |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"UpdateResults": [{ /* ActionResult */
"Id": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
]
}, ... ] /* required */
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / UpdateResponse (для SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Результаты изменения параметров фида. |
Структура ActionResult | ||
Id | long | Идентификатор фида. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |
Параметр | Тип | Описание |
Структура result (для JSON) / UpdateResponse (для SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Результаты изменения параметров фида. |
Структура ActionResult | ||
Id | long | Идентификатор фида. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |