get
Возвращает параметры условий нацеливания для динамических объявлений.
Ставки или приоритеты можно получить независимо от того, какая стратегия выбрана в кампании — ручная или автоматическая.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* WebpagesSelectionCriteria */
"Ids": [(long), ... ],
"AdGroupIds": [(long), ... ],
"CampaignIds": [(long), ... ],
"States": [( "ON" | "OFF" | "SUSPENDED" | "DELETED" ), ... ]
}, /* required */
"FieldNames": [( "AdGroupId" | "Bid" | "CampaignId" | "Conditions" | "ConditionType" | "ContextBid" | "Id" | "Name" | "State" | "StatusClarification" | "StrategyPriority" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | WebpagesSelectionCriteria | Критерий отбора условий нацеливания для динамических объявлений. | Да |
FieldNames | array of WebpageFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура WebpagesSelectionCriteria | |||
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 WebpageStateSelectionEnum | Отбирать условия нацеливания для динамических объявлений с указанными состояниями. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. Примечание. Метод get возвращает условие нацеливания для динамических объявлений в состоянии DELETED, только если в параметре States указано значение DELETED или в параметре Ids указан идентификатор этого условия. Если параметры Ids и States оба не заданы, метод не возвращает условий нацеливания в состоянии DELETED. | Нет |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | WebpagesSelectionCriteria | Критерий отбора условий нацеливания для динамических объявлений. | Да |
FieldNames | array of WebpageFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура WebpagesSelectionCriteria | |||
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 WebpageStateSelectionEnum | Отбирать условия нацеливания для динамических объявлений с указанными состояниями. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. Примечание. Метод get возвращает условие нацеливания для динамических объявлений в состоянии DELETED, только если в параметре States указано значение DELETED или в параметре Ids указан идентификатор этого условия. Если параметры Ids и States оба не заданы, метод не возвращает условий нацеливания в состоянии DELETED. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"Webpages": [{ /* WebpageGetItem */
"Id": (long),
"AdGroupId": (long),
"CampaignId": (long),
"Name": (string),
"Bid": (long),
"ContextBid": (long),
"StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" ), /* nillable */
"State": ( "ON" | "OFF" | "SUSPENDED" | "DELETED" | "UNKNOWN" ),
"StatusClarification": (string),
"Conditions": [{ /* WebpageCondition */
"Operand": ( "DOMAIN" | "OFFERS_LIST_URL" | "PAGE_CONTENT" | "PAGE_TITLE" | "URL" ), /* required */
"Operator": ( "EQUALS_ANY" | "NOT_EQUALS_ALL" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */
"Arguments": [(string), ... ] /* required */
}, ... ],
"ConditionType": ( "PAGES_ALL" | "PAGES_SUBSET" )
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
Webpages | array of WebpageGetItem | Условия нацеливания для динамических объявлений. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура WebpageGetItem | ||
Id | long | Идентификатор условия нацеливания для динамических объявлений. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится условие нацеливания для динамических объявлений. |
CampaignId | long | Идентификатор кампании, к которой относится условие нацеливания для динамических объявлений. |
Name | string | Название условия нацеливания для динамических объявлений. |
Bid | long | Ставка на поиске. |
ContextBid | long | Параметр зарезервирован для будущего использования. |
StrategyPriority | PriorityEnum, nillable | Приоритет условия нацеливания для динамических объявлений: LOW, NORMAL или HIGH. |
State | StateEnum | Состояние условия нацеливания для динамических объявлений. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. |
StatusClarification | string | Текстовое пояснение к состоянию. |
Conditions | array of WebpageCondition | Правила отбора страниц. Для страницы генерируется динамическое объявление, если она удовлетворяет одновременно всем правилам отбора. |
ConditionType | WebpageTypeEnum | Тип условия нацеливания для динамических объявлений. Описание типов см. в разделе Тип условия нацеливания для динамических объявлений. |
Структура WebpageCondition | ||
Operand | WebpageCondition OperandEnum | Операнд — свойство страницы сайта, которое подлежит сравнению с аргументом. Описание операндов см. в разделе Правило отбора. |
Operator | StringCondition OperatorEnum | Каким образом сравнивается операнд с аргументом. Описание операторов см. в разделе Правило отбора. |
Arguments | string | Массив строк, с которыми сравнивается операнд. Не более 10 строк в массиве. Если в качестве операнда указан OFFERS_LIST_URL, то длина каждой строки — не более 1024 символов. В остальных случаях длина каждой строки не более 100 символов. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
Webpages | array of WebpageGetItem | Условия нацеливания для динамических объявлений. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура WebpageGetItem | ||
Id | long | Идентификатор условия нацеливания для динамических объявлений. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится условие нацеливания для динамических объявлений. |
CampaignId | long | Идентификатор кампании, к которой относится условие нацеливания для динамических объявлений. |
Name | string | Название условия нацеливания для динамических объявлений. |
Bid | long | Ставка на поиске. |
ContextBid | long | Параметр зарезервирован для будущего использования. |
StrategyPriority | PriorityEnum, nillable | Приоритет условия нацеливания для динамических объявлений: LOW, NORMAL или HIGH. |
State | StateEnum | Состояние условия нацеливания для динамических объявлений. Описание состояний см. в разделе Состояние условия нацеливания для динамических объявлений. |
StatusClarification | string | Текстовое пояснение к состоянию. |
Conditions | array of WebpageCondition | Правила отбора страниц. Для страницы генерируется динамическое объявление, если она удовлетворяет одновременно всем правилам отбора. |
ConditionType | WebpageTypeEnum | Тип условия нацеливания для динамических объявлений. Описание типов см. в разделе Тип условия нацеливания для динамических объявлений. |
Структура WebpageCondition | ||
Operand | WebpageCondition OperandEnum | Операнд — свойство страницы сайта, которое подлежит сравнению с аргументом. Описание операндов см. в разделе Правило отбора. |
Operator | StringCondition OperatorEnum | Каким образом сравнивается операнд с аргументом. Описание операторов см. в разделе Правило отбора. |
Arguments | string | Массив строк, с которыми сравнивается операнд. Не более 10 строк в массиве. Если в качестве операнда указан OFFERS_LIST_URL, то длина каждой строки — не более 1024 символов. В остальных случаях длина каждой строки не более 100 символов. |