get

Возвращает параметры фильтров — условий нацеливания для смарт-баннеров.

  1. Ограничения
  2. Запрос
  3. Ответ
Внимание. Все возвращаемые денежные значения представляют собой целые числа — результат умножения ставки на 1 000 000.

Ограничения

Метод возвращает не более 10 000 объектов.

Запрос

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

{
  "method": "get",
  "params": {  /* params */
    "SelectionCriteria" : { /* SmartAdTargetsSelectionCriteria */
      "Ids": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "CampaignIds": [(long), ... ],
      "States" : [( "ON" | "OFF" | "SUSPENDED" | "DELETED" ), ... ]
    }, /* required */
    "FieldNames" : [( "Id" | "AdGroupId" | "CampaignId" | "Name" | "AverageCpc" | "AverageCpa" | "StrategyPriority" | "Conditions" | "ConditionType" | "State" | "Audience" | "AvailableItemsOnly" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
Параметр Тип Описание Обязательный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteria SmartAdTargetsSelectionCriteria

Критерий отбора фильтров.

Да
FieldNames array of SmartAdTargetFieldEnum

Имена параметров, которые требуется получить.

Да
Page LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет
Структура SmartAdTargetsSelectionCriteria
Ids array of long Отбирать фильтры с указанными идентификаторами. Не более 10 000 элементов в массиве. Хотя бы один из параметров Ids, AdGroupIds, CampaignIds (могут присутствовать все)
AdGroupIds array of long Отбирать фильтры указанных групп. Не более 1000 элементов в массиве.
CampaignIds array of long Отбирать фильтры указанных кампаний. Не более 2 элементов в массиве.
States array of SmartAdTargetStateSelectionEnum

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

Ограничение.
  • Если задан параметр Ids, фильтры будут отобраны без учета указанного состояния.
  • Если задан параметр AdGroupIds или CampaignIds, фильтры будут отобраны с учетом указанного состояния (при перечислении нескольких состояний необходимо хотя бы одно совпадение).
Нет
Параметр Тип Описание Обязательный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteria SmartAdTargetsSelectionCriteria

Критерий отбора фильтров.

Да
FieldNames array of SmartAdTargetFieldEnum

Имена параметров, которые требуется получить.

Да
Page LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет
Структура SmartAdTargetsSelectionCriteria
Ids array of long Отбирать фильтры с указанными идентификаторами. Не более 10 000 элементов в массиве. Хотя бы один из параметров Ids, AdGroupIds, CampaignIds (могут присутствовать все)
AdGroupIds array of long Отбирать фильтры указанных групп. Не более 1000 элементов в массиве.
CampaignIds array of long Отбирать фильтры указанных кампаний. Не более 2 элементов в массиве.
States array of SmartAdTargetStateSelectionEnum

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

Ограничение.
  • Если задан параметр Ids, фильтры будут отобраны без учета указанного состояния.
  • Если задан параметр AdGroupIds или CampaignIds, фильтры будут отобраны с учетом указанного состояния (при перечислении нескольких состояний необходимо хотя бы одно совпадение).
Нет

Ответ

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

{
  "result": {  /* result */
    "SmartAdTargets": [{  /* SmartAdTargetGetItem */
      "Id": (long),
      "AdGroupId": (long),
      "CampaignId": (long),
      "Name": (string),
      "AverageCpc": (long), /* nillable */
      "AverageCpa": (long), /* nillable */
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH"), /* nillable */
      "State": ( "OFF" | "ON" | "SUSPENDED" | "DELETED" | "UNKNOWN" ),
      "Audience": ( "INTERESTED_IN_SIMILAR_PRODUCTS" | "VISITED_PRODUCT_PAGE" | "ALL_SEGMENTS"), 
      "Conditions": { /* ConditionsArray */ 
        "Items": [{ /* ConditionsItem */
          "Operand": (string), /* required */
          "Operator": ( "GREATER_THAN" | "LESS_THAN" | "IN_RANGE" | "EXISTS" | "EQUALS_ANY" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */
          "Arguments" : [ (string) ] /* required */
        }, ... ]
      }, /* nillable */
      "ConditionType": ( "ITEMS_ALL" | "ITEMS_SUBSET" ),
      "AvailableItemsOnly": ( "YES" | "NO" ) /* nillable */
    }, ... ],
    "LimitedBy": (long)
  }
}
Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
SmartAdTargets array of SmartAdTargetGetItem Фильтры.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура SmartAdTargetGetItem
Id long Идентификатор фильтра.
AdGroupId long Идентификатор группы объявлений, к которой относится фильтр.
CampaignId long Идентификатор кампании, к которой относится фильтр.
Name string Название фильтра.
AverageCpc long, nillable Средняя цена клика, умноженная на 1 000 000. Целое число.
AverageCpa long, nillable Средняя цена конверсии, умноженная на 1 000 000. Целое число.
StrategyPriority PriorityEnum, nillable

Приоритет: LOW, NORMAL или HIGH.

State StateEnum Состояние фильтра. Описание состояний см. в разделе Состояние фильтра.
Audience AudienceEnum Целевая аудитория:
  • INTERESTED_IN_SIMILAR_PRODUCTS — пользователи, которые интересовались похожими товарами в сети.
  • VISITED_PRODUCT_PAGE — пользователи, которые смотрели товары на сайте рекламодателя.
  • ALL_SEGMENTS — обе группы.
Conditions ConditionsArray, nillable

Правила отбора товарных предложений. Товарное предложение отбирается для показа, если оно удовлетворяет одновременно всем правилам отбора.

Если параметр не задан, фильтр отбирает все товарные предложения из фида (тип отбора ITEMS_ALL).

ConditionType ConditionTypeEnum Тип отбора товарных предложений. Описание см. в разделе Тип отбора товарных предложений.
AvailableItemsOnly YesNoEnum Отбирать только товары в наличии. Значение по умолчанию NO.

Может быть использован только в фидах с типом Яндекс Маркет, в остальных фидах будет проигнорирован.

Структура ConditionsArray
Items array of ConditionsItem Правила отбора. Не более 10 элементов в массиве.
Структура ConditionsItem
Operand string

Параметр фида.

Описание полей для каждого типа фида см. в разделе Настройка фильтров помощи Директа.

Operator StringConditionOperatorEnum

Оператор сравнения. Совместимость полей фида и операторов, а также ограничения на значения см. разделе Правило отбора.

Arguments string

Массив строк, с которыми сравнивается операнд.

Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
SmartAdTargets array of SmartAdTargetGetItem Фильтры.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура SmartAdTargetGetItem
Id long Идентификатор фильтра.
AdGroupId long Идентификатор группы объявлений, к которой относится фильтр.
CampaignId long Идентификатор кампании, к которой относится фильтр.
Name string Название фильтра.
AverageCpc long, nillable Средняя цена клика, умноженная на 1 000 000. Целое число.
AverageCpa long, nillable Средняя цена конверсии, умноженная на 1 000 000. Целое число.
StrategyPriority PriorityEnum, nillable

Приоритет: LOW, NORMAL или HIGH.

State StateEnum Состояние фильтра. Описание состояний см. в разделе Состояние фильтра.
Audience AudienceEnum Целевая аудитория:
  • INTERESTED_IN_SIMILAR_PRODUCTS — пользователи, которые интересовались похожими товарами в сети.
  • VISITED_PRODUCT_PAGE — пользователи, которые смотрели товары на сайте рекламодателя.
  • ALL_SEGMENTS — обе группы.
Conditions ConditionsArray, nillable

Правила отбора товарных предложений. Товарное предложение отбирается для показа, если оно удовлетворяет одновременно всем правилам отбора.

Если параметр не задан, фильтр отбирает все товарные предложения из фида (тип отбора ITEMS_ALL).

ConditionType ConditionTypeEnum Тип отбора товарных предложений. Описание см. в разделе Тип отбора товарных предложений.
AvailableItemsOnly YesNoEnum Отбирать только товары в наличии. Значение по умолчанию NO.

Может быть использован только в фидах с типом Яндекс Маркет, в остальных фидах будет проигнорирован.

Структура ConditionsArray
Items array of ConditionsItem Правила отбора. Не более 10 элементов в массиве.
Структура ConditionsItem
Operand string

Параметр фида.

Описание полей для каждого типа фида см. в разделе Настройка фильтров помощи Директа.

Operator StringConditionOperatorEnum

Оператор сравнения. Совместимость полей фида и операторов, а также ограничения на значения см. разделе Правило отбора.

Arguments string

Массив строк, с которыми сравнивается операнд.