get
Возвращает параметры условий нацеливания для динамических объявлений.
Ставки или приоритеты можно получить независимо от того, какая стратегия выбрана в кампании — ручная или автоматическая.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
},
"SelectionCriteria": { /* DynamicFeedAdTargetsSelectionCriteria */
"Ids": [(long), ... ],
"AdGroupIds": [(long), ... ],
"CampaignIds": [(long), ... ],
"States": [( "ON" | "OFF" | "SUSPENDED" | "DELETED" ), ... ]
}, /* required */
"FieldNames": [( "AdGroupId" | "Bid" | "CampaignId" | "Conditions" | "ConditionType" | "ContextBid" | "Id" | "Name" | "State" ), ... ] /* required */
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | DynamicFeedAdTargetSelectionCriteria | Критерий отбора условий нацеливания для динамических объявлений. | Да |
FieldNames | array of DynamicFeedAdTargetFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура DynamicFeedAdTargetSelectionCriteria | |||
Ids | array of long | Отбирать условия нацеливания для динамических объявлений с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Хотя бы один из параметров Ids, AdGroupIds, CampaignIds (могут присутствовать все) |
AdGroupIds | array of long | Отбирать условия нацеливания для динамических объявлений указанных групп. От 1 до 1000 элементов в массиве. | |
CampaignIds | array of long | Отбирать условия нацеливания для динамических объявлений указанных кампаний. От 1 до 2 элементов в массиве. | |
States | array of DynamicFeedAdTargetStateSelectionEnum | Отбирать условия нацеливания для динамических объявлений с указанными состояниями. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. Примечание. Метод get возвращает условие нацеливания для динамических объявлений в состоянии DELETED, только если в параметре States указано значение DELETED или в параметре Ids указан идентификатор этого условия. Если параметры Ids и States оба не заданы, метод не возвращает условий нацеливания в состоянии DELETED. | Нет |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | DynamicFeedAdTargetSelectionCriteria | Критерий отбора условий нацеливания для динамических объявлений. | Да |
FieldNames | array of DynamicFeedAdTargetFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура DynamicFeedAdTargetSelectionCriteria | |||
Ids | array of long | Отбирать условия нацеливания для динамических объявлений с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Хотя бы один из параметров Ids, AdGroupIds, CampaignIds (могут присутствовать все) |
AdGroupIds | array of long | Отбирать условия нацеливания для динамических объявлений указанных групп. От 1 до 1000 элементов в массиве. | |
CampaignIds | array of long | Отбирать условия нацеливания для динамических объявлений указанных кампаний. От 1 до 2 элементов в массиве. | |
States | array of DynamicFeedAdTargetStateSelectionEnum | Отбирать условия нацеливания для динамических объявлений с указанными состояниями. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. Примечание. Метод get возвращает условие нацеливания для динамических объявлений в состоянии DELETED, только если в параметре States указано значение DELETED или в параметре Ids указан идентификатор этого условия. Если параметры Ids и States оба не заданы, метод не возвращает условий нацеливания в состоянии DELETED. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"DynamicFeedAdTargets": [{ /* DynamicFeedAdTargetsGetItem */
"Id": (long),
"AdGroupId": (long),
"CampaignId": (long),
"Name": (string),
"Bid": (long),
"ContextBid": (long),
"State": ( "ON" | "OFF" | "SUSPENDED" | "DELETED" | "UNKNOWN" ),
"Conditions" : { /* nillable */
"Items" : [{ /* required */
"Operand" : (string) /* required */,
"Operator" : ( "CONTAINS_ANY" | "EQUALS_ANY" | "EXISTS" | "GREATER_THAN" | "IN_RANGE" | "LESS_THAN" | "NOT_CONTAINS_ALL" ) /* required */,
"Arguments" : [ (string) ] /* required */
}, ... ],
},
"ConditionType": ( "ITEMS_ALL" | "ITEMS_SUBSET" ),
"AvailableItemsOnly" : ("YES"|"NO")
}, ... ]
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
DynamicFeedAdTargets | array of DynamicFeedAdTargetsGetItem | Условия нацеливания для динамических объявлений. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура DynamicFeedAdTargetsGetItem | ||
Id | long | Идентификатор условия нацеливания для динамических объявлений. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится условие нацеливания для динамических объявлений. |
CampaignId | long | Идентификатор кампании, к которой относится условие нацеливания для динамических объявлений. |
Name | string | Название условия нацеливания для динамических объявлений. |
Bid | long | Ставка на поиске. |
ContextBid | long | Параметр зарезервирован для будущего использования. |
State | StateEnum | Состояние условия нацеливания для динамических объявлений. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. |
Conditions | array of DynamicFeedAdTargetsCondition | Правила отбора товарных предложений. Товарное предложение отбирается для показа, если оно удовлетворяет одновременно всем правилам отбора. Если параметр не задан, фильтр отбирает все товарные предложения из фида (тип отбора ITEMS_ALL). Ограничение. Если тип фида в группе объявлений — FLIGHTS или RETAIL, правила отбора не предусмотрены. |
ConditionType | DynamicFeedAdTargetsTypeEnum | Тип условия нацеливания для динамических объявлений. Описание типов см. в разделе Тип отбора товарных предложений. |
AvailableItemsOnly | YesNoEnum | Отбирать только товары в наличии. Значение по умолчанию NO. Может быть использован только в фидах с типом Яндекс Маркет, в остальных фидах будет проигнорирован. |
Структура DynamicFeedAdTargetsCondition | ||
Operand | DynamicFeedAdTargetsCondition OperandEnum | Параметр фида. Описание полей для каждого типа фида см. в разделе Настройка фильтров помощи Директа. |
Operator | StringCondition OperatorEnum | Оператор сравнения. Совместимость полей фида и операторов, а также ограничения на значения см. разделе Правило отбора. |
Arguments | string | Массив строк, с которыми сравнивается операнд. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
DynamicFeedAdTargets | array of DynamicFeedAdTargetsGetItem | Условия нацеливания для динамических объявлений. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура DynamicFeedAdTargetsGetItem | ||
Id | long | Идентификатор условия нацеливания для динамических объявлений. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится условие нацеливания для динамических объявлений. |
CampaignId | long | Идентификатор кампании, к которой относится условие нацеливания для динамических объявлений. |
Name | string | Название условия нацеливания для динамических объявлений. |
Bid | long | Ставка на поиске. |
ContextBid | long | Параметр зарезервирован для будущего использования. |
State | StateEnum | Состояние условия нацеливания для динамических объявлений. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. |
Conditions | array of DynamicFeedAdTargetsCondition | Правила отбора товарных предложений. Товарное предложение отбирается для показа, если оно удовлетворяет одновременно всем правилам отбора. Если параметр не задан, фильтр отбирает все товарные предложения из фида (тип отбора ITEMS_ALL). Ограничение. Если тип фида в группе объявлений — FLIGHTS или RETAIL, правила отбора не предусмотрены. |
ConditionType | DynamicFeedAdTargetsTypeEnum | Тип условия нацеливания для динамических объявлений. Описание типов см. в разделе Тип отбора товарных предложений. |
AvailableItemsOnly | YesNoEnum | Отбирать только товары в наличии. Значение по умолчанию NO. Может быть использован только в фидах с типом Яндекс Маркет, в остальных фидах будет проигнорирован. |
Структура DynamicFeedAdTargetsCondition | ||
Operand | DynamicFeedAdTargetsCondition OperandEnum | Параметр фида. Описание полей для каждого типа фида см. в разделе Настройка фильтров помощи Директа. |
Operator | StringCondition OperatorEnum | Оператор сравнения. Совместимость полей фида и операторов, а также ограничения на значения см. разделе Правило отбора. |
Arguments | string | Массив строк, с которыми сравнивается операнд. |