GetSummaryStat (Live)

Возвращает статистику по указанным кампаниям за каждый день выбранного периода.

Внимание.

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Ограничения

Для одной кампании возможно до 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}
^{Параметр}	^{Описание}	^{Требуется}
`CampaignIDS`	Массив, содержащий идентификаторы кампаний. Внимание. Количество кампаний помноженное на количество дней в отчетном периоде не должно превышать 1000.	Да
`StartDate`	Начальная дата отчетного периода, за который возвращается статистика (`YYYY-MM-DD`).	Да
`EndDate`	Конечная дата отчетного периода, за который возвращается статистика (`YYYY-MM-DD`).	Да
`Currency`	Валюта, в которой должны быть выражены суммы в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании, в противном случае возвращается ошибка с кодом 245. Для кампаний в у. е. не указывайте параметр или передайте NULL.	Для кампаний в реальной валюте
`IncludeVAT`	Учитывать НДС для стоимости кликов в валюте — Yes/No. При значении Yes суммы в отчете будут включать НДС. Если не задано, подразумевается Yes. Если параметр Currency не задан, то параметр IncludeVAT игнорируется.	Нет
`IncludeDiscount`	Учитывать скидку для стоимости кликов в валюте — Yes/No. При значении Yes в отчете будут приведены суммы за вычетом скидки (то есть суммы, фактически списанные с баланса кампании). При значении No в отчете будут приведены суммы до применения скидки. Если не задано, подразумевается Yes. Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если параметр Currency не задан, то используется значение No.	Нет


_{Объект GetSummaryStatRequest}
^{Параметр}	^{Описание}	^{Требуется}
`CampaignIDS`	Массив, содержащий идентификаторы кампаний. Внимание. Количество кампаний помноженное на количество дней в отчетном периоде не должно превышать 1000.	Да
`StartDate`	Начальная дата отчетного периода, за который возвращается статистика (`YYYY-MM-DD`).	Да
`EndDate`	Конечная дата отчетного периода, за который возвращается статистика (`YYYY-MM-DD`).	Да
`Currency`	Валюта, в которой должны быть выражены суммы в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании, в противном случае возвращается ошибка с кодом 245. Для кампаний в у. е. не указывайте параметр или передайте NULL.	Для кампаний в реальной валюте
`IncludeVAT`	Учитывать НДС для стоимости кликов в валюте — Yes/No. При значении Yes суммы в отчете будут включать НДС. Если не задано, подразумевается Yes. Если параметр Currency не задан, то параметр IncludeVAT игнорируется.	Нет
`IncludeDiscount`	Учитывать скидку для стоимости кликов в валюте — Yes/No. При значении Yes в отчете будут приведены суммы за вычетом скидки (то есть суммы, фактически списанные с баланса кампании). При значении No в отчете будут приведены суммы до применения скидки. Если не задано, подразумевается Yes. Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если параметр Currency не задан, то используется значение No.	Нет

Результирующие данные

Метод возвращает массив объектов 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`	Стоимость кликов на поиске (в валюте, указанной во входном параметре Currency). См. Примечания ниже.
`SumContext`	Стоимость кликов в Рекламной сети Яндекса (в валюте, указанной во входном параметре Currency). См. Примечания ниже.
`ShowsSearch`	Количество показов на поиске.
`ShowsContext`	Количество показов в Рекламной сети Яндекса.
`ClicksSearch`	Количество кликов на поиске.
`ClicksContext`	Количество кликов в Рекламной сети Яндекса.
`SessionDepthSearch`	Глубина просмотра сайта при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer.
`SessionDepthContext`	Глубина просмотра сайта при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer.
`GoalConversionSearch`	Доля целевых визитов в общем числе визитов при переходе с поиска, в процентах. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer.
`GoalConversionContext`	Доля целевых визитов в общем числе визитов при переходе из Рекламной сети Яндекса, в процентах. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer.
`GoalCostSearch`	Цена достижения цели Яндекс Метрики при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer.
`GoalCostContext`	Цена достижения цели Яндекс Метрики при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer.
Примечания
Стоимость кликов, выраженная в валюте, может включать или не включать НДС в зависимости от значения входного параметра IncludeVAT. Стоимость кликов с учетом НДС = Стоимость кликов без учета НДС × (1 + Ставка НДС) Стоимость кликов, выраженная в валюте, может учитывать или не учитывать скидку в зависимости от значения входного параметра IncludeDiscount. Стоимость кликов до применения скидки = Стоимость кликов, фактически списанная с баланса / (1 – Cкидка) Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если кампания велась в у. е., суммы возвращаются «как есть», без каких-либо преобразований.


_{Объект StatItem}
^{Параметр}	^{Описание}
`CampaignID`	Идентификатор кампании.
`StatDate`	Дата, за которую приведена статистика.
`SumSearch`	Стоимость кликов на поиске (в валюте, указанной во входном параметре Currency). См. Примечания ниже.
`SumContext`	Стоимость кликов в Рекламной сети Яндекса (в валюте, указанной во входном параметре Currency). См. Примечания ниже.
`ShowsSearch`	Количество показов на поиске.
`ShowsContext`	Количество показов в Рекламной сети Яндекса.
`ClicksSearch`	Количество кликов на поиске.
`ClicksContext`	Количество кликов в Рекламной сети Яндекса.
`SessionDepthSearch`	Глубина просмотра сайта при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer.
`SessionDepthContext`	Глубина просмотра сайта при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer.
`GoalConversionSearch`	Доля целевых визитов в общем числе визитов при переходе с поиска, в процентах. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer.
`GoalConversionContext`	Доля целевых визитов в общем числе визитов при переходе из Рекламной сети Яндекса, в процентах. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer.
`GoalCostSearch`	Цена достижения цели Яндекс Метрики при переходе с поиска. Берется по данным Яндекс Метрики и если на поиске применяется автоматическая стратегия CPAOptimizer.
`GoalCostContext`	Цена достижения цели Яндекс Метрики при переходе из Рекламной сети Яндекса. Берется по данным Яндекс Метрики и если в Рекламной сети применяется автоматическая стратегия CPAOptimizer.
Примечания
Стоимость кликов, выраженная в валюте, может включать или не включать НДС в зависимости от значения входного параметра IncludeVAT. Стоимость кликов с учетом НДС = Стоимость кликов без учета НДС × (1 + Ставка НДС) Стоимость кликов, выраженная в валюте, может учитывать или не учитывать скидку в зависимости от значения входного параметра IncludeDiscount. Стоимость кликов до применения скидки = Стоимость кликов, фактически списанная с баланса / (1 – Cкидка) Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если кампания велась в у. е., суммы возвращаются «как есть», без каких-либо преобразований.

Примеры входных данных

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'
}

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

GetSummaryStat (disabled)

CreateNewReport (disabled)

GetSummaryStat (disabled)

CreateNewReport (disabled)