Протокол YMMYandexMetricaReporting
Методы экземпляра
-pauseSession | Приостанавливает сессию. |
-reportAdRevenue:onFailure: | Отправляет информацию о рекламной выручке на сервер AppMetrica. |
+reportECommerce:onFailure: | Отправляет сообщение о ecommerce-событии. |
-reportError:exception:onFailure: | Отправляет произвольное сообщение об ошибке. Внимание. Метод устарел. |
+reportError:onFailure: | Отправляет сообщение об ошибке типа |
+reportError:options:onFailure: | Отправляет сообщение об ошибке типа |
+reportNSError:onFailure: | Отправляет сообщение об ошибке типа |
+reportNSError:options:onFailure: | Отправляет сообщение об ошибке типа |
-reportEvent:onFailure: | Отправляет произвольное сообщение о событии. |
-reportEvent:params:onFailure: | Отправляет произвольное сообщение о событии c дополнительными параметрами. |
-reportRevenue:onFailure: | Отправляет информацию о покупке на сервер AppMetrica. |
-reportUserProfile:onFailure: | Отправляет информацию об обновлении пользовательского профиля. |
-resumeSession | Возобновляет сессию или создает новую, если тайм-аут сессии истек. |
-setStatisticsSending: | Включает/отключает отправку статистики на сервер AppMetrica. |
-setUserProfileID: | Устанавливает ID для пользовательского профиля. Если отправка ProfileId не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе. |
-pauseSession | Приостанавливает сессию. |
-reportAdRevenue:onFailure: | Отправляет информацию о рекламной выручке на сервер AppMetrica. |
+reportECommerce:onFailure: | Отправляет сообщение о ecommerce-событии. |
-reportError:exception:onFailure: | Отправляет произвольное сообщение об ошибке. Внимание. Метод устарел. |
+reportError:onFailure: | Отправляет сообщение об ошибке типа |
+reportError:options:onFailure: | Отправляет сообщение об ошибке типа |
+reportNSError:onFailure: | Отправляет сообщение об ошибке типа |
+reportNSError:options:onFailure: | Отправляет сообщение об ошибке типа |
-reportEvent:onFailure: | Отправляет произвольное сообщение о событии. |
-reportEvent:params:onFailure: | Отправляет произвольное сообщение о событии c дополнительными параметрами. |
-reportRevenue:onFailure: | Отправляет информацию о покупке на сервер AppMetrica. |
-reportUserProfile:onFailure: | Отправляет информацию об обновлении пользовательского профиля. |
-resumeSession | Возобновляет сессию или создает новую, если тайм-аут сессии истек. |
-setStatisticsSending: | Включает/отключает отправку статистики на сервер AppMetrica. |
-setUserProfileID: | Устанавливает ID для пользовательского профиля. Если отправка ProfileId не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе. |
Описание методов
-pauseSession
- (void)pauseSession
Приостанавливает сессию.
-reportAdRevenue:onFailure:
- (void)reportAdRevenue:(YMMAdRevenueInfo *)adRevenue
onFailure:(nullable void (^)(NSError *error))onFailure
Отправляет информацию о рекламной выручке на сервер AppMetrica.
adRevenue | Объект класса YMMAdRevenueInfo, который содержит информацию о рекламной выручке. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
adRevenue | Объект класса YMMAdRevenueInfo, который содержит информацию о рекламной выручке. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
+reportECommerce:onFailure:
+ (void)reportECommerce:(YMMECommerce *)eCommerce
onFailure:(nullable void (^)(NSError *error))onFailure
Отправляет сообщение о ecommerce-событии.
eCommerce | Объект класса YMMECommerce. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
eCommerce | Объект класса YMMECommerce. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
-reportError:exception:onFailure:
- (void)reportError:(NSString *)name
exception:(nullable NSException *)exception
onFailure:(nullable void (^)(NSError *error))onFailure
name | Короткое название или описание ошибки. |
exception | Объект класса NSException. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
name | Короткое название или описание ошибки. |
exception | Объект класса NSException. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
-reportEvent:onFailure:
- (void)reportEvent:(NSString *)name
onFailure:(nullable void (^)(NSError *error))onFailure
Отправляет произвольное сообщение о событии.
name | Короткое название или описание события. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
name | Короткое название или описание события. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
+reportError:onFailure:
- (void)reportError:(nonnull id<YMMErrorRepresentable>)error
onFailure:(void (^)(NSError *error))onFailure
Отправляет сообщение об ошибке типа YMMErrorRepresentable
.
error | Ошибка, которую необходимо отправить. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
error | Ошибка, которую необходимо отправить. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
+reportError:options:onFailure:
- (void)reportNSError:(nonnull id<YMMErrorRepresentable>)error
options:(YMMErrorReportingOptions)options
onFailure:(void (^)(NSError *error))onFailure
Отправляет сообщение об ошибке типа YMMErrorRepresentable
.
Используйте этот метод для установки параметров отправки.
error | Ошибка, которую необходимо отправить. |
options | Параметры отправки ошибки. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
error | Ошибка, которую необходимо отправить. |
options | Параметры отправки ошибки. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
+reportError:onFailure:
- (void)reportNSError:(NSError *)error
onFailure:(void (^)(NSError *error))onFailure
Отправляет сообщение об ошибке типа NSError
.
AppMetrica использует домен и код для группировки ошибок.
NSError
: - 200 символов для
domain
; - 50 пар ключ-значения для
userInfo
, 100 символов для ключа, 2 000 для значения; - 10 вложенных ошибок, которые используют
NSUnderlyingErrorKey
в качестве ключа вuserInfo
; - 200 фреймов стека в бэктрейсе
YMMBacktraceErrorKey
в качестве ключа вuserInfo
.
NSError
, подробнее в описании константы YMMBacktraceErrorKey.error | Ошибка, которую необходимо отправить. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
error | Ошибка, которую необходимо отправить. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
+reportNSError:options:onFailure:
- (void)reportNSError:(NSError *)error
options:(YMMErrorReportingOptions)options
onFailure:(void (^)(NSError *error))onFailure
Отправляет сообщение об ошибке типа NSError
.
AppMetrica использует домен и код для группировки ошибок.
Используйте этот метод для установки параметров отправки.
NSError
: - 200 символов для
domain
; - 50 пар ключ-значения для
userInfo
, 100 символов для ключа, 2 000 для значения; - 10 вложенных ошибок, которые используют
NSUnderlyingErrorKey
в качестве ключа вuserInfo
; - 200 фреймов стека в бэктрейсе
YMMBacktraceErrorKey
в качестве ключа вuserInfo
.
NSError
, подробнее в описании константы YMMBacktraceErrorKey.error | Ошибка, которую необходимо отправить. |
options | Параметры отправки ошибки. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
error | Ошибка, которую необходимо отправить. |
options | Параметры отправки ошибки. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
-reportEvent:params:onFailure:
- (void)reportEvent:(NSString *)name
parameters:(nullable NSDictionary *)params
onFailure:(nullable void (^)(NSError *error))onFailure
Отправляет произвольное сообщение о событии c дополнительными параметрами.
name | Короткое название или описание события. |
params | Параметры в виде пар «ключ-значение». |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
name | Короткое название или описание события. |
params | Параметры в виде пар «ключ-значение». |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
-reportRevenue:onFailure:
- (void)reportRevenue:(YMMRevenueInfo *)revenueInfo
onFailure:(nullable void (^)(NSError *error))onFailure
Отправляет информацию о покупке на сервер AppMetrica.
revenueInfo | Объект класса YMMRevenueInfo, который содержит информацию о покупке. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
revenueInfo | Объект класса YMMRevenueInfo, который содержит информацию о покупке. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
-reportUserProfile:onFailure:
- (void)reportUserProfile:(YMMUserProfile *)userProfile
onFailure:(nullable void (^)(NSError *error))onFailure
Отправляет информацию об обновлении пользовательского профиля.
userProfile | Объект класса YMMUserProfile, который содержит информацию о пользовательском профиле. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
userProfile | Объект класса YMMUserProfile, который содержит информацию о пользовательском профиле. |
onFailure | Блок, который выполняется при возникновении ошибки. Ошибка передается как блок-аргумент. |
-resumeSession
- (void)resumeSession
Возобновляет сессию или создает новую, если тайм-аут сессии истек.
-setStatisticsSending:
- (void)setStatisticsSending:(BOOL)enabled
Включает/отключает отправку статистики на сервер AppMetrica.
Отключение отправки статистики для репортера не влияет на отправку данных с главного API key. Но отключение отправки данных для главного API key прекращает отправку статистики со всех репортеров.
enabled | Признак отправки статистики. Значение по умолчанию — Возможные значения:
|
enabled | Признак отправки статистики. Значение по умолчанию — Возможные значения:
|
-setUserProfileID:
-(void)setUserProfileID:(nullable NSString *)userProfileID
Устанавливает ID для пользовательского профиля. Если отправка
ProfileId
не настроена, предопределенные атрибуты не отображаются в веб-интерфейсе.
userProfileID | Идентификатор пользовательского профиля. |
userProfileID | Идентификатор пользовательского профиля. |