Интеграция SDK

iOS

Справочник

Swift

Протоколы

YMMYandexMetricaReporting

Протокол YMMYandexMetricaReporting

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


pauseSession()	Приостанавливает сессию.
report(eCommerce:onFailure:)	Отправляет сообщение о ecommerce-событии.
reportError(_:exception:onFailure:)	Отправляет произвольное сообщение об ошибке. Внимание. Метод устарел.
report(error:onFailure:)	Отправляет сообщение об ошибке типа `YMMErrorRepresentable`.
report(error:options:onFailure:)	Отправляет сообщение об ошибке типа `YMMErrorRepresentable`.
report(nserror:onFailure:)	Отправляет сообщение об ошибке типа `NSError`.
report(nserror:options:onFailure:)	Отправляет сообщение об ошибке типа `NSError`.
report(adRevenue:onFailure:)	Отправляет информацию о рекламной выручке на сервер AppMetrica.
reportEvent(_:onFailure:)	Отправляет произвольное сообщение о событии.
reportEvent(_:parameters:onFailure:)	Отправляет произвольное сообщение о событии c дополнительными параметрами.
reportRevenue(_:onFailure:)	Отправляет информацию о покупке на сервер AppMetrica.
report(_:onFailure:)	Отправляет информацию об обновлении пользовательского профиля.
resumeSession()	Возобновляет сессию или создает новую, если тайм-аут сессии истек.
sendEventsBuffer()	Отправляет сохраненные события из буфера.
setStatisticsSending(_:)	Включает/отключает отправку статистики на сервер AppMetrica.
setUserProfileID(_:)	Устанавливает ID для пользовательского профиля. Если отправка `ProfileId` не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе.


pauseSession()	Приостанавливает сессию.
report(eCommerce:onFailure:)	Отправляет сообщение о ecommerce-событии.
reportError(_:exception:onFailure:)	Отправляет произвольное сообщение об ошибке. Внимание. Метод устарел.
report(error:onFailure:)	Отправляет сообщение об ошибке типа `YMMErrorRepresentable`.
report(error:options:onFailure:)	Отправляет сообщение об ошибке типа `YMMErrorRepresentable`.
report(nserror:onFailure:)	Отправляет сообщение об ошибке типа `NSError`.
report(nserror:options:onFailure:)	Отправляет сообщение об ошибке типа `NSError`.
report(adRevenue:onFailure:)	Отправляет информацию о рекламной выручке на сервер AppMetrica.
reportEvent(_:onFailure:)	Отправляет произвольное сообщение о событии.
reportEvent(_:parameters:onFailure:)	Отправляет произвольное сообщение о событии c дополнительными параметрами.
reportRevenue(_:onFailure:)	Отправляет информацию о покупке на сервер AppMetrica.
report(_:onFailure:)	Отправляет информацию об обновлении пользовательского профиля.
resumeSession()	Возобновляет сессию или создает новую, если тайм-аут сессии истек.
sendEventsBuffer()	Отправляет сохраненные события из буфера.
setStatisticsSending(_:)	Включает/отключает отправку статистики на сервер AppMetrica.
setUserProfileID(_:)	Устанавливает ID для пользовательского профиля. Если отправка `ProfileId` не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе.

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

pauseSession()

func pauseSession()

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

report(eCommerce:onFailure:)

class func report(eCommerce: YMMECommerce, onFailure: ((Error) -> Void)? = nil)

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

Параметры:


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


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

reportError(_:exception:onFailure:)

func reportError(_ name: String, exception: NSException?, onFailure: ((Error) -> Void)? = nil)

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

Внимание. Метод устарел.

Параметры:


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


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

report(error:onFailure:)

func report(error: YMMErrorRepresentable, onFailure: ((Error) -> Void)? = nil)

Отправляет сообщение об ошибке типа YMMErrorRepresentable.

Примечание. Подробнее в описании протокола Протокол YMMErrorRepresentable.

Параметры:


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


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

report(error:options:onFailure:)

func report(error: YMMErrorRepresentable, options: YMMErrorReportingOptions = [], onFailure: ((Error) -> Void)? = nil)

Отправляет сообщение об ошибке типа YMMErrorRepresentable.

Используйте этот метод для установки параметров отправки.

Примечание. Подробнее в описании протокола Протокол YMMErrorRepresentable.

Параметры:


error	Ошибка, которую необходимо отправить.
options	Параметры отправки ошибки.
onFailure	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.


error	Ошибка, которую необходимо отправить.
options	Параметры отправки ошибки.
onFailure	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

report(nserror:onFailure:)

func report(nserror error: Error, onFailure: ((Error) -> Void)? = nil)

Отправляет сообщение об ошибке типа NSError.

AppMetrica использует домен и код для группировки ошибок.

Ограничения для NSError:

200 символов для domain;
50 пар ключ-значения для userInfo, 100 символов для ключа, 2 000 для значения;
10 вложенных ошибок, которые используют NSUnderlyingErrorKey в качестве ключа в userInfo;
200 фреймов стека в бэктрейсе YMMBacktraceErrorKey в качестве ключа в userInfo.

Если значение превышает ограничение, AppMetrica обрезает его.

Примечание. Вы можете отправлять собственный бэктрейс ошибки в NSError, подробнее в описании константы YMMBacktraceErrorKey.

Параметры:


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


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

report(nserror:options:onFailure:)

func report(nserror error: Error, options: YMMErrorReportingOptions = [], onFailure: ((Error) -> Void)? = nil)

Отправляет сообщение об ошибке типа NSError.

AppMetrica использует домен и код для группировки ошибок.

Используйте этот метод для установки параметров отправки.

Ограничения для NSError:

200 символов для domain;
50 пар ключ-значения для userInfo, 100 символов для ключа, 2 000 для значения;
10 вложенных ошибок, которые используют NSUnderlyingErrorKey в качестве ключа в userInfo;
200 фреймов стека в бэктрейсе YMMBacktraceErrorKey в качестве ключа в userInfo.

Если значение превышает ограничение, AppMetrica обрезает его.

Параметры:


error	Ошибка, которую необходимо отправить.
options	Параметры отправки ошибки.
onFailure	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.


error	Ошибка, которую необходимо отправить.
options	Параметры отправки ошибки.
onFailure	Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент.

report(adRevenue:onFailure:)

func report(_ adRevenue: YMMAdRevenueInfo, onFailure: ((NSError) -> Void)?)

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

Параметры:


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


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

reportEvent(_:onFailure:)

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

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

Параметры:


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


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

reportEvent(_:parameters:onFailure:)

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

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

Параметры:


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


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

reportRevenue(_:onFailure:)

func reportRevenue(_ revenueInfo: YMMRevenueInfo, onFailure: ((NSError) -> Void)?)

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

Параметры:


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


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

reportUserProfile(_:onFailure:)

func reportUserProfile(_ userProfile: YMMUserProfile, onFailure: ((NSError) -> Void)?)

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

Параметры:


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


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

resumeSession()

func resumeSession()

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

sendEventsBuffer()

func sendEventsBuffer()

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

AppMetrica SDK не отправляет события сразу после того, как оно произошло. Библиотека хранит данные о событиях в буфере. Метод

sendEventsBuffer()

отправляет данные из буфера и очищает его. Используйте этот метод для принудительной отправки сохраненных событий после прохождения важных сценариев пользователя.

Внимание.

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

setStatisticsSending(_:)

func setStatisticsSending(_ enabled: Bool)

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

Примечание.

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

Параметры:


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


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

setUserProfileID(_:)

func setUserProfileID(_ userProfileID: String?)

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

ProfileId

не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе.

Параметры:


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

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

Расскажите, что вам не понравилось в статье:

YMMNotificationsEnabledAttribute

YMMAdType

YMMNotificationsEnabledAttribute

YMMAdType