get
Возвращает параметры условий нацеливания на аудиторию.
Ставки или приоритеты можно получить независимо от того, какая стратегия выбрана в кампании — ручная или автоматическая.
Внимание. Все возвращаемые денежные значения представляют собой целые числа — результат умножения ставки на 1 000 000.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* AudienceTargetSelectionCriteria */
"Ids": [(long), ... ],
"AdGroupIds": [(long), ... ],
"CampaignIds": [(long), ... ],
"RetargetingListIds": [(long), ... ],
"InterestIds": [(long), ... ],
"States": [( "ON" | "SUSPENDED" ), ... ]
}, /* required */
"FieldNames": [( "Id" | "AdGroupId" | "CampaignId" | "RetargetingListId" | "InterestId" | "ContextBid" | "StrategyPriority" | "State" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | AudienceTargetSelectionCriteria | Критерий отбора условий нацеливания на аудиторию. | Да |
FieldNames | array of AudienceTargetFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура AudienceTargetSelectionCriteria | |||
Ids | array of long | Отбирать условия нацеливания на аудиторию с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Хотя бы один из параметров Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (могут присутствовать все) |
AdGroupIds | array of long | Отбирать условия нацеливания на аудиторию в указанных группах объявлений. От 1 до 1000 элементов в массиве. | |
CampaignIds | array of long | Отбирать условия нацеливания на аудиторию в указанных кампаниях. От 1 до 100 элементов в массиве. | |
RetargetingListIds | array of long | Отбирать условия нацеливания на аудиторию с указанными условиями ретаргетинга и подбора аудитории. От 1 до 1000 элементов в массиве. | |
InterestIds | array of long | Отбирать условия нацеливания на аудиторию с указанными интересами. От 1 до 1000 элементов в массиве. | |
States | array of AudienceTargetStateEnum | Отбирать условия нацеливания на аудиторию с указанными состояниями. См. Состояние условия нацеливания на аудиторию. | Нет |
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | AudienceTargetSelectionCriteria | Критерий отбора условий нацеливания на аудиторию. | Да |
FieldNames | array of AudienceTargetFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура AudienceTargetSelectionCriteria | |||
Ids | array of long | Отбирать условия нацеливания на аудиторию с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Хотя бы один из параметров Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (могут присутствовать все) |
AdGroupIds | array of long | Отбирать условия нацеливания на аудиторию в указанных группах объявлений. От 1 до 1000 элементов в массиве. | |
CampaignIds | array of long | Отбирать условия нацеливания на аудиторию в указанных кампаниях. От 1 до 100 элементов в массиве. | |
RetargetingListIds | array of long | Отбирать условия нацеливания на аудиторию с указанными условиями ретаргетинга и подбора аудитории. От 1 до 1000 элементов в массиве. | |
InterestIds | array of long | Отбирать условия нацеливания на аудиторию с указанными интересами. От 1 до 1000 элементов в массиве. | |
States | array of AudienceTargetStateEnum | Отбирать условия нацеливания на аудиторию с указанными состояниями. См. Состояние условия нацеливания на аудиторию. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"AudienceTargets": [{ /* AudienceTargetGetItem */
"Id": (long),
"AdGroupId": (long),
"CampaignId": (long),
"RetargetingListId": (long), /* nillable */
"InterestId": (long), /* nillable */
"State": ( "ON" | "SUSPENDED" | "UNKNOWN" ),
"ContextBid": (long),
"StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
AudienceTargets | array of AudienceTargetGetItem | Условия нацеливания на аудиторию. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура AudienceTargetGetItem | ||
Id | long | Идентификатор условия нацеливания на аудиторию. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится условие нацеливания на аудиторию. |
CampaignId | long | Идентификатор кампании, к которой относится условие нацеливания на аудиторию. |
RetargetingListId | long, nillable | Идентификатор условия ретаргетинга и подбора аудитории. |
InterestId | long, nillable | Идентификатор интереса к категории мобильных приложений. |
ContextBid | long | Ставка в сетях, умноженная на 1 000 000. |
StrategyPriority | PriorityEnum | Приоритет: LOW, NORMAL или HIGH. |
State | StateEnum | Состояние условия нацеливания на аудиторию. См. Состояние условия нацеливания на аудиторию. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
AudienceTargets | array of AudienceTargetGetItem | Условия нацеливания на аудиторию. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура AudienceTargetGetItem | ||
Id | long | Идентификатор условия нацеливания на аудиторию. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится условие нацеливания на аудиторию. |
CampaignId | long | Идентификатор кампании, к которой относится условие нацеливания на аудиторию. |
RetargetingListId | long, nillable | Идентификатор условия ретаргетинга и подбора аудитории. |
InterestId | long, nillable | Идентификатор интереса к категории мобильных приложений. |
ContextBid | long | Ставка в сетях, умноженная на 1 000 000. |
StrategyPriority | PriorityEnum | Приоритет: LOW, NORMAL или HIGH. |
State | StateEnum | Состояние условия нацеливания на аудиторию. См. Состояние условия нацеливания на аудиторию. |