get
Возвращает ставки и приоритеты для ключевых фраз и автотаргетингов, отвечающих заданным критериям, а также данные торгов: ставки и списываемые цены для различных объемов трафика на поиске и ставки для охвата различных долей аудитории в сетях.
Ставки или приоритеты можно получить независимо от того, какая стратегия выбрана в кампании — ручная или автоматическая.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* KeywordBidsSelectionCriteria */
"CampaignIds": [(long), ... ],
"AdGroupIds": [(long), ... ],
"KeywordIds": [(long), ... ],
"ServingStatuses": [( "ELIGIBLE" | "RARELY_SERVED" ), ... ]
}, /* required */
"FieldNames": [( "KeywordId" | "AdGroupId" | "CampaignId" | "ServingStatus" | "StrategyPriority" ), ... ], /* required */
"SearchFieldNames": [( "Bid" | "AutotargetingSearchBidIsAuto" | "AuctionBids" ), ... ],
"NetworkFieldNames": [( "Bid" | "Coverage" ), ... ],
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | KeywordBidsSelectionCriteria | Критерий отбора ключевых фраз и автотаргетингов. | Да |
FieldNames | array of KeywordBidFieldEnum | Имена параметров верхнего уровня, которые требуется получить. | Да |
SearchFieldNames | array of KeywordBidSearchFieldEnum | Имена параметров торгов на поиске, которые требуется получить. Не запрашивайте параметр AuctionBids, если в кампании отключены показы на поиске (стратегия на поиске SERVING_OFF). | Нет |
NetworkFieldNames | array of KeywordBidNetworkFieldEnum | Имена параметров торгов в сетях, которые требуется получить. Не запрашивайте параметр Coverage, если в кампании отключены показы в сетях (стратегия в сетях SERVING_OFF). | Нет |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура KeywordBidsSelectionCriteria | |||
CampaignIds | array of long | Получить ставки или приоритеты для ключевых фраз и автотаргетингов в указанных кампаниях. От 1 до 10 элементов в массиве. | Один из параметров KeywordIds, AdGroupIds и CampaignIds (могут присутствовать все) |
AdGroupIds | array of long | Получить ставки или приоритеты для ключевых фраз и автотаргетингов в указанных группах объявлений. От 1 до 1000 элементов в массиве. | |
KeywordIds | array of long | Получить ставки или приоритеты для указанных ключевых фраз и автотаргетингов. Не более 10 000 элементов в массиве. | |
ServingStatuses | array of ServingStatusEnum | Получить ставки или приоритеты для ключевых фраз и автотаргетингов с указанными статусами возможности показов группы. Описание статусов см. в разделе Статус возможности показов группы. | Нет |
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | KeywordBidsSelectionCriteria | Критерий отбора ключевых фраз и автотаргетингов. | Да |
FieldNames | array of KeywordBidFieldEnum | Имена параметров верхнего уровня, которые требуется получить. | Да |
SearchFieldNames | array of KeywordBidSearchFieldEnum | Имена параметров торгов на поиске, которые требуется получить. Не запрашивайте параметр AuctionBids, если в кампании отключены показы на поиске (стратегия на поиске SERVING_OFF). | Нет |
NetworkFieldNames | array of KeywordBidNetworkFieldEnum | Имена параметров торгов в сетях, которые требуется получить. Не запрашивайте параметр Coverage, если в кампании отключены показы в сетях (стратегия в сетях SERVING_OFF). | Нет |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура KeywordBidsSelectionCriteria | |||
CampaignIds | array of long | Получить ставки или приоритеты для ключевых фраз и автотаргетингов в указанных кампаниях. От 1 до 10 элементов в массиве. | Один из параметров KeywordIds, AdGroupIds и CampaignIds (могут присутствовать все) |
AdGroupIds | array of long | Получить ставки или приоритеты для ключевых фраз и автотаргетингов в указанных группах объявлений. От 1 до 1000 элементов в массиве. | |
KeywordIds | array of long | Получить ставки или приоритеты для указанных ключевых фраз и автотаргетингов. Не более 10 000 элементов в массиве. | |
ServingStatuses | array of ServingStatusEnum | Получить ставки или приоритеты для ключевых фраз и автотаргетингов с указанными статусами возможности показов группы. Описание статусов см. в разделе Статус возможности показов группы. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"KeywordBids": [{ /* KeywordBidGetItem */
"CampaignId": (long),
"AdGroupId": (long),
"KeywordId": (long),
"ServingStatus": ( "ELIGIBLE" | "RARELY_SERVED" ),
"StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" ), /* nillable */
"Search": { /* Search */
"Bid": (long),
"AutotargetingSearchBidIsAuto",: ( "YES" | "NO" ),
"AuctionBids": { /* AuctionBids */
"AuctionBidItems": [{ /* AuctionBidItem */
"TrafficVolume": (int), /* required */
"Bid": (long), /* required */
"Price": (long) /* required */
}, ... ]
} /* nillable */
},
"Network": { /* Network */
"Bid": (long),
"Coverage": { /* Coverage */
"CoverageItems": [{ /* NetworkCoverageItem */
"Probability": (decimal), /* required */
"Bid": (long) /* required */
}, ... ]
} /* nillable */
}
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
KeywordBids | array of KeywordBidGetItem | Ставки и/или приоритеты. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура KeywordBidGetItem | ||
CampaignId | long | Идентификатор кампании, к которой относится ключевая фраза или автотаргетинг. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится ключевая фраза или автотаргетинг. |
KeywordId | long | Идентификатор ключевой фразы или автотаргетинга. |
ServingStatus | ServingStatusEnum | Статус возможности показов группы объявлений. Описание статусов см. в разделе Статус возможности показов группы. |
StrategyPriority | PriorityEnum, nillable | Приоритет ключевой фразы или автотаргетинга: LOW, NORMAL или HIGH. |
Search | Search | Ставка и данные торгов на поиске. |
Network | Network | Ставка и данные торгов в сетях. |
Структура Search | ||
Bid | long | Ставка на поиске, назначенная рекламодателем. |
AutotargetingSearchBidIsAuto | YesNoEnum | Признак включения опции автоматической ставки. |
AuctionBids | AuctionBids, nillable | Ставки и списываемые цены на поиске, соответствующие различным объемам трафика для данной фразы. Если в группе только графические объявления, возвращается null (nil). Если в группе объявлений мало показов (значение RARELY_SERVED параметра ServingStatus), возвращается null (nil). Для автотаргетинга возвращается null (nil). |
Структура AuctionBids | ||
AuctionBidItems | array of AuctionBidItem | Массив ставок и списываемых цен на поиске, соответствующих различным объемам трафика. |
Структура AuctionBidItem | ||
TrafficVolume | int | Объем трафика. |
Bid | long | Ставка на поиске, соответствующая указанному объему трафика. |
Price | long | Списываемая цена, соответствующая указанному объему трафика. |
Структура Network | ||
Bid | long | Ставка в сетях, назначенная рекламодателем. |
Coverage | Coverage, nillable | Ставки в сетях, соответствующие охвату различных долей аудитории для данной фразы. Если в группе объявлений мало показов (значение RARELY_SERVED параметра ServingStatus), возвращается null (nil). Если в кампании выбрана стратегия показа в сетях SERVING_OFF или NETWORK_DEFAULT, возвращается null (nil). Ограничение. Параметр NETWORK_DEFAULT не поддерживается для ручной стратегии HIGHEST_POSITION. Для автотаргетинга возвращается null (nil). |
Структура Coverage | ||
CoverageItems | NetworkCoverageItem | Массив ставок, соответствующих охвату различных долей аудитории. |
Структура NetworkCoverageItem | ||
Probability | decimal | Частота показа (доля аудитории) в сетях. Указывается в процентах от 0 до 100. |
Bid | long | Ставка в сетях, соответствующая указанной частоте показа. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
KeywordBids | array of KeywordBidGetItem | Ставки и/или приоритеты. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура KeywordBidGetItem | ||
CampaignId | long | Идентификатор кампании, к которой относится ключевая фраза или автотаргетинг. |
AdGroupId | long | Идентификатор группы объявлений, к которой относится ключевая фраза или автотаргетинг. |
KeywordId | long | Идентификатор ключевой фразы или автотаргетинга. |
ServingStatus | ServingStatusEnum | Статус возможности показов группы объявлений. Описание статусов см. в разделе Статус возможности показов группы. |
StrategyPriority | PriorityEnum, nillable | Приоритет ключевой фразы или автотаргетинга: LOW, NORMAL или HIGH. |
Search | Search | Ставка и данные торгов на поиске. |
Network | Network | Ставка и данные торгов в сетях. |
Структура Search | ||
Bid | long | Ставка на поиске, назначенная рекламодателем. |
AutotargetingSearchBidIsAuto | YesNoEnum | Признак включения опции автоматической ставки. |
AuctionBids | AuctionBids, nillable | Ставки и списываемые цены на поиске, соответствующие различным объемам трафика для данной фразы. Если в группе только графические объявления, возвращается null (nil). Если в группе объявлений мало показов (значение RARELY_SERVED параметра ServingStatus), возвращается null (nil). Для автотаргетинга возвращается null (nil). |
Структура AuctionBids | ||
AuctionBidItems | array of AuctionBidItem | Массив ставок и списываемых цен на поиске, соответствующих различным объемам трафика. |
Структура AuctionBidItem | ||
TrafficVolume | int | Объем трафика. |
Bid | long | Ставка на поиске, соответствующая указанному объему трафика. |
Price | long | Списываемая цена, соответствующая указанному объему трафика. |
Структура Network | ||
Bid | long | Ставка в сетях, назначенная рекламодателем. |
Coverage | Coverage, nillable | Ставки в сетях, соответствующие охвату различных долей аудитории для данной фразы. Если в группе объявлений мало показов (значение RARELY_SERVED параметра ServingStatus), возвращается null (nil). Если в кампании выбрана стратегия показа в сетях SERVING_OFF или NETWORK_DEFAULT, возвращается null (nil). Ограничение. Параметр NETWORK_DEFAULT не поддерживается для ручной стратегии HIGHEST_POSITION. Для автотаргетинга возвращается null (nil). |
Структура Coverage | ||
CoverageItems | NetworkCoverageItem | Массив ставок, соответствующих охвату различных долей аудитории. |
Структура NetworkCoverageItem | ||
Probability | decimal | Частота показа (доля аудитории) в сетях. Указывается в процентах от 0 до 100. |
Bid | long | Ставка в сетях, соответствующая указанной частоте показа. |