Протокол AppMetricaReporting

Методы экземпляра

clearAppEnvironment()	Удаление всех данных ключ-значение, связанных со всеми будущими событиями.
pauseSession()	Приостанавливает сессию.
reportAdRevenue(_:onFailure:)	Отправляет информацию о рекламной выручке на сервер AppMetrica.
reportECommerce(_:onFailure)	Отправляет сообщение о ecommerce-событии.
reportEvent(name:onFailure)	Отправляет произвольное сообщение о событии.
reportEvent(name:parameters:onFailure)	Отправляет произвольное сообщение о событии c дополнительными параметрами.
reportRevenue(_:onFailure:)	Отправляет информацию о покупке на сервер AppMetrica.
reportUserProfile(_:onFailure)	Отправляет информацию об обновлении пользовательского профиля.
resumeSession()	Возобновляет сессию или создает новую, если таймаут сессии истек.
sendEventsBuffer()	Отправляет сохраненные события из буфера.
setAppEnvironment(_:forKey:)	Устанавливает пару ключ-значение, которая ассоциирована со всеми будущими событиями.
setDataSendingEnabled(_:)	Включает/отключает отправку статистики на сервер AppMetrica.
setupWebViewReporting(with:onFailure:)	Добавляет для указанной вебвью JavaScript-интерфейс с названием AppMetrica в window. Это позволяет отправлять клиентские события из JavaScript-кода.

Свойства

userProfileID

Устанавливает ID для пользовательского профиля.

Описание методов

clearAppEnvironment()

func clearAppEnvironment()

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

pauseSession()

func pauseSession()

Приостанавливает сессию.

reportAdRevenue(_:onFailure)

func reportAdRevenue(_ adRevenue: AdRevenueInfo, onFailure: ((Error) -> Void)?)

Отправляет информацию о рекламной выручке на сервер AppMetrica.

Параметры:

`adRevenue`	Объект класса AdRevenueInfo, который содержит информацию о рекламной выручке.
`onFailure`	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

reportECommerce(_:onFailure)

func reportECommerce(_ eCommerce: ECommerce, onFailure: ((Error) -> Void)?)

Отправляет сообщение о ecommerce-событии.

Параметры:

`eCommerce`	Объект класса ECommerce.
`onFailure`	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

reportEvent(name:onFailure)

func reportEvent(name: String, onFailure: ((Error) -> Void)?)

Отправляет произвольное сообщение о событии.

Параметры:

`name`	Короткое название или описание события.
`onFailure`	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

reportEvent(name:parameters:onFailure)

func reportEvent(name: String, parameters: [AnyHashable : Any]?, onFailure: ((Error) -> Void)?)

Отправляет произвольное сообщение о событии c дополнительными параметрами.

Параметры:

`name`	Короткое название или описание события.
`parameters`	Параметры в виде пар «ключ-значение».
`onFailure`	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

reportRevenue(_:onFailure:)

func reportRevenue(_ revenueInfo: RevenueInfo, onFailure: ((Error) -> Void)?)

Отправляет информацию о покупке на сервер AppMetrica.

Параметры:

`revenueInfo`	Объект класса RevenueInfo, который содержит информацию о покупке.
`onFailure`	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

reportUserProfile(_:onFailure)

func reportUserProfile(_ userProfile: UserProfile, onFailure: ((Error) -> Void)?)

Отправляет информацию об обновлении пользовательского профиля.

Параметры:

`userProfile`	Объект класса UserProfile, который содержит информацию о пользовательском профиле.
`onFailure`	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

resumeSession()

func resumeSession()

Возобновляет сессию или создает новую, если таймаут сессии истек.

sendEventsBuffer()

func sendEventsBuffer()

Отправляет сохраненные события из буфера.

AppMetrica SDK не отправляет события сразу после того, как оно произошло. Библиотека хранит данные о событиях в буфере. Метод +sendEventsBuffer отправляет данные из буфера и очищает его. Используйте этот метод для принудительной отправки сохраненных событий после прохождения важных сценариев пользователя.

Внимание

Частое использование метода может привести к повышению энергопотребления и расходу исходящего интернет-трафика.

setAppEnvironment(_:forKey:)

func setAppEnvironment(_ value: String?, forKey: String)

Установка данных ключ - значение, которые будут использоваться в качестве дополнительной информации, связанной со всеми будущими событиями.

Если значение равно нулю, ранее установленное значение ключа удаляется. Ничего не делает, если ключ не был добавлен.

Параметры:

`value`	Значение.
`key`	Ключ.

setDataSendingEnabled(_:)

func setDataSendingEnabled(_ enabled: Bool)

Включает/отключает отправку статистики на сервер AppMetrica.

Примечание

Отключение отправки статистики для репортера не влияет на отправку данных с главного API key. Но отключение отправки данных для главного API key прекращает отправку статистики со всех репортеров.

Параметры:

enabled

Признак отправки статистики. Значение по умолчанию — true. Возможные значения:

true — отправка статистики включена.
false — отправка статистики выключена.

setupWebViewReporting(with:onFailure:)

class func setupWebViewReporting(with: JSControlling, onFailure: ((Error) -> Void)?)

Добавляет для указанной вебвью JavaScript-интерфейс с названием AppMetrica в window. Это позволяет отправлять клиентские события из JavaScript-кода.

Замечания:

Метод должен вызываться из главной очереди.
Метод недоступен на tvOS.
Метод необходимо вызывать до загрузки любого контента. Рекомендуется вызывать метод до создания вебвью и до добавления своих скриптов в WKUserContentController. Подробнее см. в разделе Примеры использования методов.

Параметры:

`controller`	Объект `JSControlling`.
`onFailure`	Callback-метод, который будет вызван в случае ошибки.

Описание свойств

userProfileID

var userProfileID: String { get; set; }

Устанавливает ID для пользовательского профиля. Если отправка ProfileId не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе.

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

Протокол AppMetricaPlugins

Протокол BirthDateAttribute