add

Запрос

Структура запроса в формате JSON:

{
  "method": "add",
  "params": { /* params */
    "Feeds": [{ /* FeedAddItem */
      "Name": (string), /* required */
      "BusinessType": ( "RETAIL" | "HOTELS" | "REALTY" | "AUTOMOBILES" | "FLIGHTS" | "OTHER" ), /* required */
      "SourceType": ( "URL" | "FILE" ), /* required */
      "UrlFeed": { /* UrlFeedAdd */
        "Url": (string), /* required */
        "RemoveUtmTags": ( "YES" | "NO" ),
        "Login": (string),
        "Password": (string),
      },
      "FileFeed": { /* FileFeedAdd */
        "Data": (base64Binary), /* required*/ 
        "Filename": (string) /* required */
      }
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обязательный
Структура params (для JSON) / AddRequest (для SOAP)
Feeds array of FeedAddItem Фиды, которые требуется добавить (не более 50). Да
Структура FeedAddItem
Name string Название фида. Не более 255 символов. Да
BusinessType BusinessTypeEnum Тип бизнеса. Определяет доступные форматы фида. См. Тип бизнеса для фида. Да
SourceType SourceTypeEnum Тип источника данных:
  • URL — фид доступен по ссылке.
  • FILE — фид передан в запросе.
Да
UrlFeed UrlFeedAdd Параметры фида, доступного по ссылке. Либо UrlFeed, либо FileFeed
FileFeed FileFeedAdd Параметры фида, переданного в запросе.
Структура UrlFeed
Url string Ссылка на фид. Не более 1024 символов. Должна содержать протокол и доменное имя. Да
RemoveUtmTags YesNoEnum Автоматически удалять UTM-метки из ссылок в фиде. Значение по умолчанию — NO. Нет
Login string Логин для доступа к фиду (если требуется). Не более 255 символов. Нет
Password string Пароль для доступа к фиду (если требуется). Не более 255 символов. Нет
Структура FileFeedAdd
Data base64Binary

Загружаемый фид, закодированный в base64. Размер фида ограничен общим размером запроса — не более 50 Мб.

Примечание.

При использовании SOAP-библиотеки в это поле следует поместить непосредственно файл фида, а библиотека автоматически при передаче закодирует их в base64.

При использовании формата JSON следует предварительно закодировать бинарные данные в base64 и передать их как строку.

Да
Filename string Имя файла фида. Не более 255 символов. Да
Параметр Тип Описание Обязательный
Структура params (для JSON) / AddRequest (для SOAP)
Feeds array of FeedAddItem Фиды, которые требуется добавить (не более 50). Да
Структура FeedAddItem
Name string Название фида. Не более 255 символов. Да
BusinessType BusinessTypeEnum Тип бизнеса. Определяет доступные форматы фида. См. Тип бизнеса для фида. Да
SourceType SourceTypeEnum Тип источника данных:
  • URL — фид доступен по ссылке.
  • FILE — фид передан в запросе.
Да
UrlFeed UrlFeedAdd Параметры фида, доступного по ссылке. Либо UrlFeed, либо FileFeed
FileFeed FileFeedAdd Параметры фида, переданного в запросе.
Структура UrlFeed
Url string Ссылка на фид. Не более 1024 символов. Должна содержать протокол и доменное имя. Да
RemoveUtmTags YesNoEnum Автоматически удалять UTM-метки из ссылок в фиде. Значение по умолчанию — NO. Нет
Login string Логин для доступа к фиду (если требуется). Не более 255 символов. Нет
Password string Пароль для доступа к фиду (если требуется). Не более 255 символов. Нет
Структура FileFeedAdd
Data base64Binary

Загружаемый фид, закодированный в base64. Размер фида ограничен общим размером запроса — не более 50 Мб.

Примечание.

При использовании SOAP-библиотеки в это поле следует поместить непосредственно файл фида, а библиотека автоматически при передаче закодирует их в base64.

При использовании формата JSON следует предварительно закодировать бинарные данные в base64 и передать их как строку.

Да
Filename string Имя файла фида. Не более 255 символов. Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ]
    }, ... ]
  }
}
Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления фидов.
Структура ActionResult
Id long

Идентификатор фида. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.

Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.

Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления фидов.
Структура ActionResult
Id long

Идентификатор фида. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.

Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.

Пример

{
  "method": "add",
  "params": { 
    "Feeds": [{
      "Name": "MyFeed",
      "BusinessType": "RETAIL",
      "SourceType": "FILE",
      "FileFeed": {
        "Data": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAA..." 
        "Filename": "myfeed.xml"
      }
    }]
  }
}