Класс AMAAppMetrica

Методы класса используются для настройки работы библиотеки.

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

СвойстваСвойства

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

+activateReporterWithConfiguration:+activateReporterWithConfiguration:

+ (void)activateReporterWithConfiguration:(AMAReporterConfiguration *)configuration;

Инициализирует репортер с расширенной конфигурацией.

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

Репортер должен быть инициализирован с конфигурацией, которая содержит API key, отличный от API key приложения.

Параметры:

+activateWithConfiguration:+activateWithConfiguration:

+ (void)activateWithConfiguration:(AMAAppMetricaConfiguration *)configuration;

Инициализирует библиотеку в приложении с расширенной стартовой конфигурацией.

Параметры:

+clearAppEnvironment+clearAppEnvironment

+ (void)clearAppEnvironment;

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

+pauseSession+pauseSession

+ (void)pauseSession;

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

+reportAdRevenue:onFailure:+reportAdRevenue:onFailure:

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

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

Параметры:

+reportECommerce:onFailure:+reportECommerce:onFailure:

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

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

Параметры:

+reportEvent:onFailure:+reportEvent:onFailure:

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

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

Параметры:

+reportEvent:parameters:onFailure:+reportEvent:parameters:onFailure:

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

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

Параметры:

+reportExternalAttribution:source:onFailure:+reportExternalAttribution:source:onFailure:

+ (void)reportExternalAttribution:(NSDictionary *)attribution
                           source:(AMAAttributionSource)source
                        onFailure:(nullable void (^)(NSError *error))onFailure;

Отправляет данные о внешней атрибуции в AppMetrica.

Параметры:

+reportRevenue:onFailure:+reportRevenue:onFailure:

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

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

Параметры:

+reportUserProfile:onFailure:+reportUserProfile:onFailure:

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

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

Параметры:

+reporterForAPIKey:+reporterForAPIKey:

+ (nullable id<AMAAppMetricaReporting>)reporterForAPIKey:(NSString *)APIKey;

Создает репортер для отправки событий на дополнительный API key.

Чтобы инициализировать репортер с расширенной конфигурацией, используйте метод activateReporterWithConfiguration:. Конфигурация репортера должна быть инициализирована до первого обращения к репортеру. Иначе, конфигурация репортера игнорируется.

Параметры:

Возвращает:

Объект, реализующий протокол AMAAppMetricaReporting для заданного API key приложения.

+requestStartupIdentifiersWithCompletionQueue:completionBlock:+requestStartupIdentifiersWithCompletionQueue:completionBlock:

+ (void)requestStartupIdentifiersWithCompletionQueue:(nullable dispatch_queue_t)queue
                                     completionBlock:(AMAIdentifiersCompletionBlock)block;

Получение всех предопределенных идентификаторов

Параметры:

+requestStartupIdentifiersWithKeys:completionQueue:completionBlock:+requestStartupIdentifiersWithKeys:completionQueue:completionBlock:

+ (void)requestStartupIdentifiersWithKeys:(NSArray<AMAStartupKey> *)keys
                          completionQueue:(nullable dispatch_queue_t)queue
                          completionBlock:(AMAIdentifiersCompletionBlock)block;

Получение идентификаторов для определенных ключей

Параметры:

+resumeSession+resumeSession

+ (void)resumeSession;

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

+sendEventsBuffer+sendEventsBuffer

+ (void)sendEventsBuffer;

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

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

+setAppEnvironmentValue:forKey:+setAppEnvironmentValue:forKey:

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

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

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

Параметры:

+setDataSendingEnabled:+setDataSendingEnabled:

+ (void)setDataSendingEnabled:(BOOL)enabled;

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

Подробнее об использовании метода в разделе Отключение и включение отправки статистики.

Параметры:

+setupWebViewReporting:onFailure:+setupWebViewReporting:onFailure:

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

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

Замечания:

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

Параметры:

+trackOpeningURL:+trackOpeningURL:

+ (void)trackOpeningURL:(NSURL *)URL;

Обрабатывает URL, который открыл приложение.

Используется для регистрации открытия приложения с помощью deeplink

Параметры:

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

UUIDUUID

@property (class, nonatomic, readonly) NSString *UUID;

Извлекает текущий UUID.

accurateLocationTrackingEnabledaccurateLocationTrackingEnabled

@property (class, nonatomic, getter=isAccurateLocationTrackingEnabled) BOOL accurateLocationTrackingEnabled;

Контролирует точность отслеживания местоположения, используемого внутренним менеджером местоположения.

Если установлено значение YES, диспетчер местоположений пытается использовать наиболее точные доступные данные о местоположении. Это свойство вступает в силу только в том случае, если для параметра isLocationTrackingEnabled установлено значение YES и местоположение не было задано вручную с помощью свойства customLocation.

activatedactivated

@property (class, assign, readonly, getter=isActivated) BOOL activated;

Указывает, была ли активирована AppMetrica.

allowsBackgroundLocationUpdatesallowsBackgroundLocationUpdates

@property (class, nonatomic) BOOL allowsBackgroundLocationUpdates;

Включить/отключить фоновое отслеживание обновлений местоположения. По умолчанию отключен.

customLocationcustomLocation

@property (class, nonatomic, nullable) CLLocation *customLocation;

Устанавливает собственную информацию о местоположении устройства.

deviceIDHashdeviceIDHash

@property (class, nonatomic, nullable, readonly) NSString *deviceIDHash;

Извлекает appmetrica_device_id_hash.

deviceIDdeviceID

@property (class, nonatomic, nullable, readonly) NSString *deviceID;

Извлекает appmetrica_device_id.

libraryVersionlibraryVersion

@property (class, nonatomic, readonly) NSString *libraryVersion;

Возвращает текущую версию библиотеки AppMetrica.

locationTrackingEnabledlocationTrackingEnabled

@property (class, nonatomic, getter=isLocationTrackingEnabled) BOOL locationTrackingEnabled;

Включает/отключает отправку информации о местоположении устройства.

userProfileIDuserProfileID

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

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