Протокол AMAAppMetricaReporting

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

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

Свойства

userProfileID

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

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

-clearAppEnvironment

- (void)clearAppEnvironment;

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

-pauseSession

- (void)pauseSession;

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

-reportAdRevenue:onFailure:

- (void)reportAdRevenue:(AMAAdRevenueInfo *)adRevenue
              onFailure:(nullable void (^)(NSError *error))onFailure;

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

Параметры:

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

-reportECommerce:onFailure

- (void)reportECommerce:(AMAECommerce *)eCommerce
              onFailure:(nullable void (^)(NSError *error))onFailure;

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

Параметры:

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

-reportEvent:onFailure

- (void)reportEvent:(NSString *)name
          onFailure:(nullable void (^)(NSError *error))onFailure;

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

Параметры:

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

-reportEvent:parameters:onFailure

- (void)reportEvent:(NSString *)name
         parameters:(nullable NSDictionary *)params
          onFailure:(nullable void (^)(NSError *error))onFailure;

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

Параметры:

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

-reportRevenue:onFailure:

- (void)reportRevenue:(AMARevenueInfo *)revenueInfo
            onFailure:(nullable void (^)(NSError *error))onFailure;

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

Параметры:

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

-reportUserProfile:onFailure

- (void)reportUserProfile:(AMAUserProfile *)userProfile
                onFailure:(nullable void (^)(NSError *error))onFailure;

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

Параметры:

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

-resumeSession

- (void)resumeSession;

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

-sendEventsBuffer

- (void)sendEventsBuffer;

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

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

Внимание

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

-setAppEnvironmentValue:forKey:

- (void)setAppEnvironmentValue:(nullable NSString *)value
                        forKey:(NSString *)key;

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

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

Параметры:

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

-setDataSendingEnabled:

- (void)setDataSendingEnabled:(BOOL)enabled;

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

Примечание

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

Параметры:

enabled

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

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

-setupWebViewReporting:onFailure:

- (void)setupWebViewReporting:(id<AMAJSControlling>)controller
                    onFailure:(nullable void (^)(NSError *error))onFailure;

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

Замечания:

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

Параметры:

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

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

userProfileID

@property (class, nonatomic, nullable) NSString *userProfileID;

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

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

Протокол AMAAppMetricaPlugins

Протокол AMABirthDateAttribute