ads

ads.getStatistics

Возвращает статистику показателей эффективности по рекламным объявлениям, кампаниям, клиентам или всему кабинету.

Для вызова метода можно использовать:
• ключ доступа пользователя (требуется право доступа: ads — выдаётся в исключительных случаях через запрос в поддержку по электронной почте devsupport@corp.vk.com)

Параметры

account_id

integer

Идентификатор рекламного кабинета.

Обязательный параметр

ids_type

string

Тип запрашиваемых объектов, которые перечислены в параметре ids:

  • •
    ad — объявления;
  • •
    campaign — кампании;
  • •
    client — клиенты;
  • •
    office — кабинет.

Обязательный параметр

ids

text

Перечисленные через запятую ID запрашиваемых объявлений, кампаний, клиентов или кабинета, в зависимости от того, что указано в параметре ids_type. Максимум 2000 объектов.

Обязательный параметр

period

string

Способ группировки данных по датам:

  • •
    day — статистика по дням;
  • •
    week — статистика по неделям;
  • •
    month — статистика по месяцам;
  • •
    year — статистика по годам;
  • •
    overall — статистика за всё время;

Временные ограничения задаются параметрами date_from и date_to.

Обязательный параметр

date_from

string

Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

  • •
    day: YYYY-MM-DD, пример: 2011-09-27 - 27 сентября 2011.
    • •
      0 — день создания;
  • •
    week: YYYY-MM-DD, пример: 2011-09-27 - считаем статистику, начиная с понедельника той недели, в которой находится заданный день.
    • •
      0 — неделя создания;
  • •
    month: YYYY-MM, пример: 2011-09 - сентябрь 2011.
    • •
      0 — месяц создания;
  • •
    year: YYYY, пример: 2011 - 2011 год.
    • •
      0 — год создания;
  • •
    overall: 0

Обязательный параметр

date_to

string

Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

  • •
    day: YYYY-MM-DD, пример: 2011-09-27 - 27 сентября 2011.
  • •
    week: YYYY-MM-DD, пример: 2011-09-27 - считаем статистику до воскресения той недели, в которой находится данный день.
    • •
      0 — текущая неделя;
  • •
    month: YYYY-MM, пример: 2011-09 - сентябрь 2011.
    • •
      0 — текущий месяц;
  • •
    year: YYYY, пример: 2011 - 2011 год.
    • •
      0 — текущий год;
  • •
    overall: 0

Обязательный параметр

stats_fields

string

Дополнительные статистики:

  • •
    views_times — распределение количества показов на пользователя. Доступно для типов ad и campaign, содержащих только рекламные записи.

Результат

Каждый запрашиваемый объект имеет следующие поля:

  • •
    id — ID объекта из параметра ids,
  • •
    type — тип объекта из параметра ids_type,
  • •
    stats — список структур описывающих статистику объекта за один временной период (конкретный временной период присутствует в списке, если по нему есть какая-то статистика).

Структура в списке stats имеет следующие поля:

  • •

    day (если period равен day) — день в формате YYYY-MM-DD,

  • •

    month (если period равен month) — месяц в формате YYYY-MM,

  • •

    overall (если period равен overall) — 1,

  • •

    spent — потраченные средства,

  • •

    impressions — просмотры,

  • •

    clicks — клики,

  • •

    reach (если ids_type равен ad или campaign и period равен day или month) — охват,

  • •

    join_rate — вступления в группу, событие, подписки на публичную страницу или установки мини-приложения (только если в объявлении указана прямая ссылка на соответствующую страницу ВКонтакте),

  • •

    uniq_views_count — количество уникальных просмотров,

  • •

    link_external_clicks — количество уникальных переходов по ссылкам в тексте записи, сниппетам, карточкам и кнопкам, которые ведут пользователей на ресурсы за пределами ВКонтакте

  • •

    ctr — CTR,

  • •

    effective_cost_per_click — eCPC,

  • •

    effective_cost_per_mille — eCPM,

  • •

    effective_cpf — eCPF.

  • •

    Сообщения:

    • •
      effective_cost_per_message — стоимость сообщения,
    • •
      message_sends — количество сообщений.
  • •

    Видео:

    • •
      video_plays_unique_started — сколько пользователей включили видео,
    • •
      video_plays_unique_3_seconds — сколько пользователей посмотрели 3 секунды видео.
    • •
      video_plays_unique_25_percents — сколько пользователей посмотрели 25% видео,
    • •
      video_plays_unique_50_percents — сколько пользователей посмотрели 60% видео,
    • •
      video_plays_unique_75_percents — сколько пользователей посмотрели 75% видео,
    • •
      video_plays_unique_100_percents — сколько пользователей посмотрели 100% видео.
  • •

    Конверсии:

    • •
      conversion_count — конверсии,
    • •
      conversion_sum — ценность конверсий (c версии 5.122 выдается в рублях),
    • •
      conversion_roas — окупаемость затрат на рекламу,
    • •
      conversion_cr — коэффициент конверсии.
  • •

    Реклама мобильных приложений:

В зависимости от настроек мобильного приложения, приходит набор полей с префиксом mobile_app_. Структура названий полей следующая: mobile_app_{$event}_{$metric}_{$attribution_time}_{$attribution_type}, где:

  • •
    $event — название ассоциированного или неассоциированного (custom_X, X от 1 до 10) события:
    • •
      install — установка,
    • •
      conversion — конверсия,
    • •
      purchase — покупка,
    • •
      add_to_cart — добавление в корзину,
    • •
      initiate_checkout — начало оформления заказа,
    • •
      add_payment_info — добавление платежной информации,
    • •
      subscribe — оформление подписки,
    • •
      complete_registration — регистрация,
    • •
      contact — контакт,
    • •
      lead — получение потенциального клиента,
    • •
      view_content — просмотр контента,
    • •
      search — использование поиска,
    • •
      add_to_wishlist — добавление в список желаний,
    • •
      customize_product — уточнение сведений,
    • •
      donate — пожертвование средств,
    • •
      find_location — поиск местонахождения,
    • •
      page_view — посещение страницы,
    • •
      schedule — запись на приём,
    • •
      start_trial — использование пробной версии,
    • •
      submit_application — подача заявки,
    • •
      achieved_level — достижение уровня,
    • •
      completed_tutorial — прохождение туториала,
    • •
      rated — оценка,
    • •
      unlocked_achievement — получение награды,
    • •
      spent_credits — трата внутренней валюты.
  • •
    $metric — название метрики:
    • •
      amount - количество событий,
    • •
      value - ценность событий,
    • •
      cr - conversion rate,
    • •
      ecpa - эффективная стоимость события,
    • •
      er - ДРР,
    • •
      romi - ROMI.
  • •
    $attribution_time - время атрибуции:
    • •
      by_interaction_time - по времени взаимодействия (клика или показа),
    • •
      by_postback_time - по времени события.
  • •
    $attribution_type - тип атрибуции:
    • •
      postclick - постклик,
    • •
      postview - поствью,
    • •
      total - сумма постклик и поствью.

Коды ошибок

601
Permission denied. You have requested too many actions this day. Try later.

В ходе выполнения могут произойти общие ошибки