get

Возвращает параметры фидов, отвечающих заданным критериям.

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

Как работает метод get

Ограничения

Метод возвращает не более page-size объектов.

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* FeedSelectionCriteria */
      "Ids": [(long), ... ],  /* required */
    },
    "FieldNames": [( "Id" | "Name" | "BusinessType" | "SourceType" | "FilterSchema" | "UpdatedAt" | "CampaignIds" | "NumberOfItems" | "Status" | "TitleAndTextSources" ), ... ], /* required */
    "FileFeedFieldNames": [( "Filename" )],
    "UrlFeedFieldNames": [( "Login" | "Url" | "RemoveUtmTags" ), ... ],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Параметр	Тип	Описание	Обязательный
Структура params (для JSON) / GetRequest (для SOAP)
`SelectionCriteria`	FeedsSelectionCriteria	Критерий отбора фидов. Чтобы получить все фиды рекламодателя, не указывайте `SelectionCriteria`.	Нет
`FieldNames`	array of FeedFieldEnum	Имена параметров фида, которые требуется получить.	Да
`UrlFeedFieldNames`	array of UrlFeedFieldEnum	Имена параметров фида с типом источника URL. Примечание Если согласно `SelectionCriteria` отобран фид с другим типом источника, параметры из `UrlFeedFieldNames` не возвращаются.	Нет
`FileFeedFieldNames`	FileFeedFieldEnum	Имена параметров фида с типом источника FILE. Примечание Если согласно `SelectionCriteria` отобран фид с другим типом источника, параметры из `FileFeedFieldNames` не возвращаются.	Нет
`Page`	LimitOffset	Структура, задающая страницу при постраничной выборке данных.	Нет
Структура FeedsSelectionCriteria
`Ids`	array of long	Отбирать фиды с указанными идентификаторами. Не более 10 000 элементов в массиве.	Да

Ответ

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

{
  "result": { /* result */
    "Feeds": [{ /* FeedGetItem */
      "Id": (long),
      "Name": (string),
      "BusinessType": ( "RETAIL" | "HOTELS" | "REALTY" | "AUTOMOBILES" | "FLIGHTS" | "OTHER"),
      "SourceType": ( "URL" | "FILE" ),
      "FilterSchema": (string),
      "UpdatedAt": (string),  /* nillable */
      "CampaignIds": { /* ArrayOfLong */
        "Items": [(long), ... ] /* required */
      }, /* nillable */
      "FileFeed": { /* FileFeedGet */
        "Filename": (string)
      }, /* nillable */
      "NumberOfItems": (int), /* nillable */
      "Status": ( "NEW" | "UPDATING" | "DONE" | "ERROR"),
      "UrlFeed" : { /* UrlFeedGet */
        "Url": (string),
        "RemoveUtmTags": ( "YES" | "NO" ),
        "Login": (string) /* nillable */
      }, /* nillable */
      "TitleAndTextSources" : { /* nillable */
        "Items" : [ (string) ] /* required */
      }
    }, ... ],
    "LimitedBy": (long)
  }
}

Параметр	Тип	Описание
Структура result (для JSON) / GetResponse (для SOAP)
`Feeds`	array of FeedGetItem	Фиды.
`LimitedBy`	long	Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура FeedGetItem
`Id`	long	Идентификатор фида.
`Name`	string	Название фида.
`BusinessType`	BusinessTypeEnum	Тип бизнеса.
`SourceType`	SourceTypeEnum	Тип источника данных: ссылка или загруженный файл.
`FilterSchema`	string	Название схемы для создания фильтров. Значение возвращается только для обработанных фидов ( `Status = DONE` ).
`UpdatedAt`	string, nillable	Дата последнего изменения данных в фиде.
`CampaignIds`	ArrayOfLong, nillable	Кампании, в которых используется фид.
`FileFeed`	FileFeedGet, nillable	Параметры фида, загруженного как файл.
`NumberOfItems`	int, nillable	Количество предложений в фиде.
`Status`	FeedStatusEnum	Статус обработки фида.
`UrlFeed`	UrlFeedGet, nillable	Параметры фида, доступного по ссылке.
`TitleAndTextSources`	ArrayOfString, nillable	Список полей фида, которые можно использовать при формировании заголовков и текстов для объявлений, генерируемых по фиду.
Структура FileFeedGet
`Filename`	string	Имя файла фида.
Структура UrlFeedGet
`Url`	string	Ссылка на фид.
`Login`	string, nillable	Логин для доступа к фиду (если требуется). Не более 255 символов.
`RemoveUtmTags`	YesNoEnum	Автоматически удалять UTM-метки из ссылок в фиде.

Была ли статья полезна?

delete

update