GetEventsLog (Live)
Возвращает записи из журнала событий.
Яндекс Директ автоматически регистрирует события, связанные с общими счетами, кампаниями и объявлениями, например результаты модерации, пополнение баланса и другое. Журнал событий ведется для каждого пользователя. Метод GetEventsLog возвращает записи из журнала событий за указанный период времени.
Новое в версии Live 4
Входной параметр Currency стал обязательным.
Добавлен входной параметр Currency и результирующий параметр Currency.
Добавлен входной параметр AccountIDS и результирующий параметр AccountID.
Добавлены входные параметры Limit и Offset.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetEventsLog",
"param": {
/* GetEventsLogRequest */
"TimestampFrom": (string),
"TimestampTo": (string),
"LastEventOnly": (string),
"WithTextDescription": (string),
"Currency": (string),
"Logins": [
(string)
...
],
"Filter": {
/* GetEventsLogFilter */
"CampaignIDS": [
(int)
...
],
"BannerIDS": [
(long)
...
],
"PhraseIDS": [
(long)
...
],
"AccountIDS": [
(int)
...
],
"EventType": [
(string)
...
]
},
"Limit": (int),
"Offset": (int)
}
}
Ниже приведено описание параметров.
|
Параметр |
Описание |
Требуется |
|
Объект GetEventsLogRequest |
||
|
|
Момент времени, начиная с которого требуется получить записи о событиях. Указывается в формате ISO 8601, например |
Да |
|
|
Момент времени, по который требуется получить записи о событиях. Указывается в формате ISO 8601, например Если параметр не задан, возвращаются записи по текущий момент времени. |
Нет |
|
|
Получить только последнюю запись по каждому типу событий — Yes/No. Если параметр не задан, возвращаются все записи за указанный период времени. |
Нет |
|
|
Выводить в ответ описания событий — Yes/No. Если параметр не задан, описания не выводятся. |
Нет |
|
|
Валюта, в которой должны быть выражены денежные значения (минимальная цена, остаток средств, сумма зачисленных средств) в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
Да |
|
|
Массив логинов, принадлежащих клиентам рекламных агентств. Метод возвращает записи о событиях указанных клиентов. При отсутствии параметра возвращаются записи о событиях пользователя, от лица которого сделан запрос. |
Только для рекламных агентств |
|
|
Объект |
Нет |
|
|
Количество возвращаемых событий (размер страницы). Вместе с параметром Если не задан, возвращаются все события. |
Нет |
|
|
Количество событий, которое должно быть пропущено при выборке. Игнорируется, если не задан |
Нет |
|
Объект GetEventsLogFilter |
||
|
|
Идентификаторы кампаний, для которых требуется получить записи о событиях. |
Нет |
|
|
Идентификаторы объявлений, для которых требуется получить записи о событиях. |
Нет |
|
|
Идентификаторы фраз, для которых требуется получить записи о событиях. |
Нет |
|
|
Идентификаторы общих счетов, для которых требуется получить записи о событиях. |
Нет |
|
|
Типы событий, записи о которых требуется получить. Возможные значения указаны ниже:
|
Нет |
Результирующие данные
Метод возвращает массив объектов EventsLogItem, каждый из которых представляет одну запись о событии. Ниже показана структура результирующих данных в формате JSON.
{
"data": [
{ /* EventsLogItem */
"AccountID": (int),
"CampaignID": (int),
"BannerID": (long),
"PhraseID": (long),
"TextDescription": (string),
"EventType": (string),
"Timestamp": (string),
"EventName": (string),
"Attributes": {
/* EventsLogItemAttributes */
"ModerationResult": (string),
"MinPrice": (float),
"Rest": (float),
"Payed": (float),
"FinishDate": (date),
"OldPlace": (string),
"IsEditedByModerator": (string),
"StopTime": (string),
"Currency": (string)
}
}
...
]
}
Ниже приведено описание параметров.
|
Параметр |
Описание |
|
Объект EventsLogItem |
|
|
|
Идентификатор общего счета, к которому относится событие. Может отсутствовать. |
|
|
Идентификатор кампании, к которой относится событие. Может отсутствовать. |
|
|
Идентификатор объявления, к которому относится событие. Может отсутствовать. |
|
|
Идентификатор фразы, к которому относится событие. Может отсутствовать. |
|
|
Описание события. |
|
|
Тип события. Одно из значений:
|
|
|
Момент регистрации события в формате ISO 8601, например |
|
|
Краткое описание события. |
|
|
Объект |
|
Объект EventsLogItemAttributes |
|
|
|
Результат модерации. Выводится для события BannerModerated. |
|
|
Актуальная минимальная ценаминимальная цена за клик. Выводится для события WarnMinPrice. Значение конвертируется в валюту, указанную в параметре |
|
|
Остаток средств на балансе кампании. Выводится для события MoneyWarning. Значение конвертируется в валюту, указанную в параметре Если значение выражено в реальной валюте, оно не включает НДС. |
|
|
Сумма зачисленных средств. Выводится для события MoneyIn. Значение конвертируется в валюту, указанную в параметре Если значение выражено в реальной валюте, оно не включает НДС. |
|
|
Дата остановки кампании. Выводится для события CampaignFinished. |
|
|
Предыдущая позиция показа объявления. Выводится для события WarnPlace. |
|
|
Признак того, что объявление изменено модератором (Yes/No). Выводится для события BannerModerated. |
|
|
Дата и время остановки кампании. Выводится для события PausedByDayBudget. |
|
|
Валюта, в которой выражены денежные значения. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
Примеры входных данных
Python
{
'TimestampFrom': '2012-02-15T23:59:59Z',
'TimestampTo': '2012-02-18T23:59:59Z',
'Filter': {
'CampaignIDS': [3193279],
'EventType': ['MoneyIn', 'CampaignFinished']
}
}
PHP
array(
'TimestampFrom' => '2012-02-15T23:59:59Z',
'TimestampTo' => '2012-02-18T23:59:59Z',
'Filter' => array(
'CampaignIDS' => array(3193279),
'EventType' => array('MoneyIn', 'CampaignFinished')
)
)
Perl
{
'TimestampFrom' => '2012-02-15T23:59:59Z',
'TimestampTo' => '2012-02-18T23:59:59Z',
'Filter' ={
'CampaignIDS' => [3193279],
'EventType' => ['MoneyIn', 'CampaignFinished']
}
}