GetSummaryStat (Live)
Возвращает статистику по указанным кампаниям за каждый день выбранного периода.
Ограничения
Для одной кампании возможно до 100 вызовов метода в сутки.
Количество запрошенных кампаний, помноженное на количество дней в выбранном периоде, не должно превышать 1000.
Статистика доступна за последние три года от текущего месяца: например, 15 сентября 2016 года можно получить данные начиная с 1 сентября 2013 года.
Все кампании, указанные в одном вызове метода, должны быть в одной валюте.
Новое в версии Live 4
Входной параметр Currency стал обязательным для кампаний в реальной валюте.
Добавлены входные параметры Currency, IncludeVAT, IncludeDiscount.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetSummaryStat",
"param": {
/* GetSummaryStatRequest */
"CampaignIDS": [
(int)
...
],
"StartDate": (date),
"EndDate": (date),
"Currency": (string),
"IncludeVAT": (string),
"IncludeDiscount": (string)
}
}
Ниже приведено описание параметров.
Параметр |
Описание |
Требуется |
Объект GetSummaryStatRequest |
||
|
Массив, содержащий идентификаторы кампаний. Внимание Количество кампаний помноженное на количество дней в отчетном периоде не должно превышать 1000. |
Да |
|
Начальная дата отчетного периода, за который возвращается статистика ( |
Да |
|
Конечная дата отчетного периода, за который возвращается статистика ( |
Да |
|
Валюта, в которой должны быть выражены суммы в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании, в противном случае возвращается ошибка с кодом 245. Для кампаний в у. е. не указывайте параметр или передайте NULL. |
Для кампаний в реальной валюте |
|
Учитывать НДС для стоимости кликов в валюте — Yes/No. При значении Yes суммы в отчете будут включать НДС. Если не задано, подразумевается Yes. Если параметр |
Нет |
|
Учитывать скидку для стоимости кликов в валюте — Yes/No. При значении Yes в отчете будут приведены суммы за вычетом скидки (то есть суммы, фактически списанные с баланса кампании). При значении No в отчете будут приведены суммы до применения скидки. Если не задано, подразумевается Yes. Примечание Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если параметр |
Нет |
Результирующие данные
Метод возвращает массив объектов StatItem
. Каждый объект содержит статистику по одной кампании за одну дату выбранного периода.
Внимание
Если по запрошенной кампании не было показов за весь период, сведения о кампании не выводятся в ответ.
Часть возвращаемых параметров рассчитывается на основе данных Яндекс Метрики (см. раздел Метрика. Оценка эффективности рекламной кампанииYandex.Metrica: advertising campaign efficiency evaluation помощи Директа).
{
"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 |
|
|
Идентификатор кампании. |
|
Дата, за которую приведена статистика. |
|
Стоимость кликов на поиске (в валюте, указанной во входном параметре См. Примечания ниже. |
|
Стоимость кликов в Рекламной сети Яндекса (в валюте, указанной во входном параметре См. Примечания ниже. |
|
Количество показов на поиске. |
|
Количество показов в Рекламной сети Яндекса. |
|
Количество кликов на поиске. |
|
Количество кликов в Рекламной сети Яндекса. |
|
Глубина просмотра сайта при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
|
Глубина просмотра сайта при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
|
Доля целевых визитов в общем числе визитов при переходе с поиска, в процентах. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
|
Доля целевых визитов в общем числе визитов при переходе из Рекламной сети Яндекса, в процентах. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer. |
|
Цена достижения целицели Яндекс Метрики при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer. |
|
Цена достижения целицели Яндекс Метрики при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия 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'
}