Документация для разработчиков
Темная тема

GetEventList

Описание и параметры

CDBResult
CAdv::GetEventList(
	int adv_id,
	string &by = "s_counter",
	string &order = "desc",
	array filter = array(),
	bool &is_filtered
)

Возвращает список типов событий, инициализированных посетителями, зашедшими по определённой рекламной кампании (РК).

Параметры метода

ПараметрОписание
adv_idID рекламной кампании.
byПоле для сортировки. Возможные значения:
  • s_id - ID типа события
  • s_event1 - идентификатор event1 типа события
  • s_event2 - идентификатор event2 типа события
  • s_sort - индекс сортировки типа события
  • s_name - наименование типа события
  • s_counter - количество событий инициализированных посетителями на прямом заходе по рекламной кампании adv_id
  • s_counter_back - количество событий инициализированных посетителями на возврате по рекламной кампании adv_id
  • s_def - сортировка по умолчанию (для вывода в соответствующей таблице)
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию
  • desc - по убыванию
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - ID типа события
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение
  • EVENT1* - идентификатор event1 типа события
  • EVENT1_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT1 будет искаться точное совпадение
  • EVENT2* - идентификатор event2 типа события
  • EVENT2_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT2 будет искаться точное совпадение
  • KEYWORDS* - имя и описание типа события
  • KEYWORDS_EXACT_MATCH - если значение равно "Y", то при фильтрации по KEYWORDS будет искаться точное совпадение
  • DATE1_PERIOD - начальная дата периода
  • DATE2_PERIOD - конечная дата периода
  • COUNTER_PERIOD_1 - если установлены DATE1_PERIOD или DATE2_PERIOD, то в данном поле можно указать начальное значение интервала количества событий инициализированных посетителями на прямом заходе по рекламной кампании adv_id
  • COUNTER_PERIOD_2 - если установлены DATE1_PERIOD или DATE2_PERIOD, то в данном поле можно указать конечное значение интервала количества событий инициализированных посетителями на прямом заходе по рекламной кампании adv_id
  • COUNTER_BACK_PERIOD_1 - если установлены DATE1_PERIOD или DATE2_PERIOD, то в данном поле можно указать начальное значение интервала количества событий инициализированных посетителями на возврате по рекламной кампании adv_id
  • COUNTER_BACK_PERIOD_2 - если установлены DATE1_PERIOD или DATE2_PERIOD, то в данном поле можно указать конечное значение интервала количества событий инициализированных посетителями на возврате по рекламной кампании adv_id
  • MONEY_PERIOD_1 - если установлены DATE1_PERIOD или DATE2_PERIOD, то в данном поле можно указать начальное значение интервала количество денег инициализированных посетителями на прямом заходе по рекламной кампании adv_id
  • MONEY_PERIOD_2 - если установлены DATE1_PERIOD или DATE2_PERIOD, то в данном поле можно указать конечное значение интервала количества денег инициализированных посетителями на прямом заходе по рекламной кампании adv_id
* - допускается сложная логика
is_filteredФлаг отфильтрованности списка типов событий. Если значение равно "true", то список был отфильтрован.

Структура возвращаемой записи

Array
(
	[ID] => ID типа события
	[EVENT1] => идентификатор event1
	[EVENT2] => идентификатор event2
	[C_SORT] => сортировка
	[NAME] => название
	[EVENT] => название либо [ID] event1 / event2
	[DESCRIPTION] => описание
	[COUNTER] => суммарное кол-во событий данного типа на прямом заходе по РК
	[COUNTER_BACK] => суммарное кол-во событий данного типа на возврате по РК
	[COUNTER_TODAY] => кол-во событий данного типа на прямом заходе по РК за сегодня
	[COUNTER_YESTERDAY] => кол-во событий данного типа на прямом заходе по РК за вчера
	[COUNTER_BEF_YESTERDAY] => кол-во событий данного типа на прямом заходе по РК за позавчера
	[COUNTER_PERIOD] => кол-во событий данного типа на прямом заходе по РК за период
	[COUNTER_BACK_TODAY] => кол-во событий данного типа на возврате по РК за сегодня
	[COUNTER_BACK_YESTERDAY] => кол-во событий данного типа на возврате по РК за вчера
	[COUNTER_BACK_BEF_YESTERDAY] => кол-во событий данного типа на возврате по РК за позавчера
	[COUNTER_BACK_PERIOD] => кол-во событий данного типа на возврате по РК за период
	[MONEY] => итоговая денежная сумма событий данного типа на прямом заходе по РК
	[MONEY_TODAY] => денежная сумма событий данного типа на прямом заходе по РК за сегодня
	[MONEY_YESTERDAY] => денежная сумма событий данного типа на прямом заходе по РК за вчера
	[MONEY_BEF_YESTERDAY] => денежная сумма событий данного типа на прямом заходе по РК за позавчера
	[MONEY_PERIOD] => денежная сумма событий данного типа на прямом заходе по РК за период
	[MONEY_BACK] => итоговая денежная сумма событий данного на возврате по РК
	[MONEY_BACK_TODAY] => денежная сумма событий данного типа на возврате по РК за сегодня
	[MONEY_BACK_YESTERDAY] => денежная сумма событий данного типа на возврате по РК за вчера
	[MONEY_BACK_BEF_YESTERDAY] => денежная сумма событий данного типа на возврате по РК за позавчера
	[MONEY_BACK_PERIOD] => денежная сумма событий данного типа на возврате по РК за период
)

Примеры использования

<?
$adv_id = 1;

// отфильтруем по типам события "download / file1" и "download / file2"
// а также получим дополнительные данные за декабрь 2005 года
$arFilter = array(
	"EVENT1"       => "download",
	"EVENT2"       => "file1 | file2",
	"DATE1_PERIOD" => "01.12.2005",
	"DATE2_PERIOD" => "31.12.2005"
);

// получим список записей
$rs = CAdv::GetEventList(
	$adv_id, 
	($by="s_counter"), 
	($order="desc"), 
	$arFilter, 
	$is_filtered
);

// выведем все записи
while ($ar = $rs->Fetch())
{
	echo "<pre>"; print_r($ar); echo "</pre>";    
}
?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх