Интеграция iOS

Интеграция

Чтобы интегрировать библиотеку, система должна вызывать следующий метод:

 (void)startWithTrackerURL:(NSURL *)trackerURL appId:(NSUInteger)appId;  

appId и trackerURL могут быть получены во время регистрации вашего приложения.

Для того, чтобы контролировать логику работы системы аналитики Maxymizely, используйте следующее поля и методы:

A. Регистрация минимального количества событий в пакете:

(void)setMinEventsInPacketCount:(NSUInteger)minEvents;  

Заметка! Когда вызов closeSession сделан, пакет посылается независимо от количества событий, что осуществляется.

B. Открытие сессии:

 + (void)openSession;  

Сессия открывается автоматически после события UIApplicationWillEnterForegroundNotification.

C. Закрытие сессии:

 + (void)closeSession; 

Сессия закрывается автоматически после события UIApplicationDidEnterBackgroundNotification.

D. Добавление «parameter-value» в поток логирования:

 + (void)logValue:(double)value forKey:(NSString *)key; 

E. Добавление введенного события:

(void)addEventWithType:(BMTEventType)type
//event type

content:(NSString *)content
//section (level) where the event occurred
        
referrer:(NSString *)referrer
//previous section (level)

title:(NSString *)title
//section description

name:(NSString *)name
//an element's name

value:(double)value
//value of the element

externalId:(NSString *)externalId
//user's identifier(ex. Logins)

customAttribute1:(NSString *)customAttribute1     
customAttribute2:(NSString *)customAttribute2   
customAttribute3:(NSString *)customAttribute3
//3 custom event attributes that are filled
//at the discretion of the developer

configurationId:(NSInteger)configurationId
//configuration identifier within the application
        
windowId:(UInt32)windowId;
//identifier of the window where the event occurred    

Значение временной метки и значение параметра siteId будет размещен автоматически. Ниже — сокращенные версии метода вызова добавления событий:

(void)logEmpty;
(void)logLoadPage:(NSString *)pageName;
(void)logClick:(NSString *)clickName;
(void)logViewElement:(NSString *)elementName; 
(void)logDownload:(NSString *)item; 
(void)logUpload:(NSString *)item; 
(void)logSubmit:(NSString *)item; 
(void)logRegistration:(NSString *)info; 
(void)logPurchase:(NSString *)purchaseId price:(double)price; 
(void)logLogin:(NSString *)info; 
(void)logError:(NSError *)error; 
(void)log:(NSString *)string;       

F. Добавление пользовательских атрибутов:

(void)addUserAttributeWithName:(NSString *)name
//attribute name

value:(NSString *)value
//attribute value

externalId:(NSString *)externalId
//user’s identifier (ex. Email, different Login)

configurationId:(NSInteger)configurationId;
//configuration identifier within the application  

Конфигурация

Для того, чтобы контролировать логику работы системы слежения Maxymizely, используйте такие поля и методы:

Основные поля конфигурации:

• SiteId — идентификатор ресурса который необходимо отслеживать
• ConfigurationId — идентификатор для отслеживания пользователей
• ExternalId — уникальный идентификатор пользователя (например, внутренний идентификатор пользователя в базе данных, эл. адрес, логин, идентификатор Facebook, или любая другая информация, которая помогает идентифицировать уникального пользователя)

Дополнительный метод конфигурации:

(void)addUserAttributeWithName  

Этот метод позволяет назначить ряд дополнительных параметров для пользователя.

Приложение

Основой для анализа является процесс отслеживания событий, которые происходят в приложении. Эти события могут быть инициированы  пользователем, а также через интерактивное окно, в котором находится содержание.

Для системного интегратора, существует два уровня регистрируемых событий:

• Системный уровень
• Пользовательский уровень

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

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

• Значение — идентификатор контрольной точки (идентификатор HTML элемента, имя поля, и т.д.)
• CustomAttribute1, CustomAttribute2, CustomAttribute3 — 3 дополнительные атрибуты, которые устанавливаются по усмотрению пользователя/разработчика