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
TimestampFrom

Момент времени, начиная с которого требуется получить записи о событиях. Указывается в формате ISO 8601, например 2011-05-24T23:59:59Z.

Да
TimestampTo

Момент времени, по который требуется получить записи о событиях. Указывается в формате ISO 8601, например 2011-05-25T23:59:59Z.

Если параметр не задан, возвращаются записи по текущий момент времени.

Нет
LastEventOnly

Получить только последнюю запись по каждому типу событий — Yes/No.

Если параметр не задан, возвращаются все записи за указанный период времени.

Нет
WithTextDescription

Выводить в ответ описания событий — Yes/No.

Если параметр не задан, описания не выводятся.

Нет
Currency

Валюта, в которой должны быть выражены денежные значения (минимальная цена, остаток средств, сумма зачисленных средств) в ответе.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

Да
Logins

Массив логинов, принадлежащих клиентам рекламных агентств. Метод возвращает записи о событиях указанных клиентов.

При отсутствии параметра возвращаются записи о событиях пользователя, от лица которого сделан запрос.

Только для рекламных агентств
Filter Объект GetEventsLogFilter с условиями фильтрации записей о событиях. Если не задан, фильтрация не применяется, и возвращаются все записи за указанный период времени. Нет
Limit

Количество возвращаемых событий (размер страницы). Вместе с параметром Offset позволяет организовать постраничную выборку. Список событий упорядочен по времени.

Если не задан, возвращаются все события.

Нет
Offset Количество событий, которое должно быть пропущено при выборке. Игнорируется, если не задан Limit. Нет
Объект GetEventsLogFilter
CampaignIDS Идентификаторы кампаний, для которых требуется получить записи о событиях. Нет
BannerIDS Идентификаторы объявлений, для которых требуется получить записи о событиях. Нет
PhraseIDS Идентификаторы фраз, для которых требуется получить записи о событиях. Нет
AccountIDS Идентификаторы общих счетов, для которых требуется получить записи о событиях. Нет
EventType

Типы событий, записи о которых требуется получить. Возможные значения указаны ниже:

  • BannerModerated — объявление проверено модератором;
  • CampaignFinished — кампания остановлена в связи с наступлением д