GetSummaryStat
Возвращает статистику по указанным кампаниям за каждый день выбранного периода.
Метод отключен. Используйте API версии 5.
Информацию о соответствии методов в версиях 4 и 5 см. в Руководстве по переходу.
Для метода существует версия GetSummaryStat (Live).
Ограничения
Для одной кампании возможно до 100 вызовов метода в сутки.
Количество запрошенных кампаний, помноженное на количество дней в выбранном периоде, не должно превышать 1000.
Статистика доступна за последние три года от текущего месяца: например, 15 сентября 2016 года можно получить данные начиная с 1 сентября 2013 года.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetSummaryStat",
"param": {
/* GetSummaryStatRequest */
"CampaignIDS": [
(int)
...
],
"StartDate": (date),
"EndDate": (date)
}
}
Ниже приведено описание параметров.
Параметр | Описание | Требуется |
Объект GetSummaryStatRequest | ||
---|---|---|
CampaignIDS | Массив, содержащий идентификаторы кампаний. Внимание. Количество кампаний помноженное на количество дней в отчетном периоде не должно превышать 1000. | Да |
StartDate | Начальная дата отчетного периода, за который возвращается статистика (YYYY-MM-DD ). | Да |
EndDate | Конечная дата отчетного периода, за который возвращается статистика (YYYY-MM-DD ). | Да |
Параметр | Описание | Требуется |
Объект GetSummaryStatRequest | ||
---|---|---|
CampaignIDS | Массив, содержащий идентификаторы кампаний. Внимание. Количество кампаний помноженное на количество дней в отчетном периоде не должно превышать 1000. | Да |
StartDate | Начальная дата отчетного периода, за который возвращается статистика (YYYY-MM-DD ). | Да |
EndDate | Конечная дата отчетного периода, за который возвращается статистика (YYYY-MM-DD ). | Да |
Результирующие данные
Метод возвращает массив объектов StatItem. Каждый объект содержит статистику по одной кампании за одну дату выбранного периода.
Часть возвращаемых параметров рассчитывается на основе данных Яндекс Метрики (см. раздел справки Метрика. Оценка эффективности рекламной кампании).
{
"data": [
{ /* StatItem */
"CampaignID": (int),
"StatDate": (date),
"SumSearch": (float),
"SumContext": (float),
"ShowsSearch": (int),
"ShowsContext": (int),
"ClicksSearch": (int),
"ClicksContext": (int),
"SessionDepthSearch": (float),
"SessionDepthContext": (float),
"GoalConversionSearch": (float),
"GoalConversionContext": (float),
"GoalCostSearch": (float),
"GoalCostContext": (float)
}
...
]
}
Ниже приведено описание параметров.
Параметр | Описание |
Объект StatItem | |
---|---|
CampaignID | Идентификатор кампании. |
StatDate | Дата, за которую приведена статистика. |
SumSearch | Стоимость кликов на поиске. |
SumContext | Стоимость кликов в Рекламной сети Яндекса. |
ShowsSearch | Количество показов на поиске. |
ShowsContext | Количество показов в Рекламной сети Яндекса. |
ClicksSearch | Количество кликов на поиске. |
ClicksContext | Количество кликов в Рекламной сети Яндекса. |
SessionDepthSearch | Глубина просмотра сайта при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
SessionDepthContext | Глубина просмотра сайта при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
GoalConversionSearch | Доля целевых визитов в общем числе визитов при переходе с поиска, в процентах. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
GoalConversionContext | Доля целевых визитов в общем числе визитов при переходе из Рекламной сети Яндекса, в процентах. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
GoalCostSearch | Цена достижения цели Яндекс Метрики при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
GoalCostContext | Цена достижения цели Яндекс Метрики при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
Параметр | Описание |
Объект StatItem | |
---|---|
CampaignID | Идентификатор кампании. |
StatDate | Дата, за которую приведена статистика. |
SumSearch | Стоимость кликов на поиске. |
SumContext | Стоимость кликов в Рекламной сети Яндекса. |
ShowsSearch | Количество показов на поиске. |
ShowsContext | Количество показов в Рекламной сети Яндекса. |
ClicksSearch | Количество кликов на поиске. |
ClicksContext | Количество кликов в Рекламной сети Яндекса. |
SessionDepthSearch | Глубина просмотра сайта при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
SessionDepthContext | Глубина просмотра сайта при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
GoalConversionSearch | Доля целевых визитов в общем числе визитов при переходе с поиска, в процентах. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
GoalConversionContext | Доля целевых визитов в общем числе визитов при переходе из Рекламной сети Яндекса, в процентах. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
GoalCostSearch | Цена достижения цели Яндекс Метрики при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
GoalCostContext | Цена достижения цели Яндекс Метрики при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
Примеры входных данных
Python
{
'CampaignIDS': [238456],
'StartDate': '2011-05-14',
'EndDate': '2011-05-19'
}
PHP
array(
'CampaignIDS' => array(238456),
'StartDate' => '2011-05-14',
'EndDate' => '2011-05-19'
)
Perl
{
'CampaignIDS' => [238456],
'StartDate' => '2011-05-14',
'EndDate' => '2011-05-19'
}