ETTrackingPageView Class Reference
Inherits from | NSObject |
Declared in | ETTrackingPageView.h ETTrackingPageView.m |
Overview
This is the representation of a view. After creation of a new ETTrackingPageView, you can add several properties. Afterwards you should add the pageView to a ETTrackingSession and perhaps submit the collected data of the session.
Tasks
Adding Properties to a page view
-
– addBilling:customerId:total:country:cip:city:
Adds a billing property
-
– addContact:
Adds a contact property
-
– addContent:
Adds a content property
-
– addCountryId:
Adds a country property. Some shop systems can handle multiple sites. If we have to distinguish them, we set the countryId for the actual shop.
-
– addDownload:
Adds a download property
-
– addLangId:
Adds a language property. Some shop systems can handle multiple languages. If we have to distinguish them, we set the language.
-
– addLogin:result:
Adds a login property. We encrypt (generate md5-Hash) the userId to implement the German “Datenschutzgesetz” in this Method
-
– addMarketingChannel:
Adds a property for marketing channel (‘source’)
-
– addOrderProcess:
Adds a orderProcess property.
-
– addPageId:
Adds a pageId property. pageId is used by Clickmonitor to distinguish Pages
-
– addProductAddToBasket:
Adds a addToBasket – Event to this page
-
– addProductBuy:
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘buy’ and all ETBasketItem-Informations.
-
– addProductBuyList:
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘buy’ and all BasketItem-Informations.
-
– addProductCustomEvent:eventType:
Adds a ec_Event property with custom eventType. Stored as array of array. Array contains the custom eventType and all ETBasketItem-Informations.
-
– addProductRemoveFromBasket:
Adds a removeFromBasket – Event to this page
-
– addProductView:
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘view’ and all BasketItem-Informations.
-
– addProperty:boolValue:
Adds a custom boolean property
-
– addProperty:numberValue:
Adds a custom number property
-
– addProperty:stringValue:
Adds a custom string property
-
– addPropertyArray:array:
Adds a custom array property
-
– addPropertyArrays:array:
Adds a custom array of arrays property
-
– addRegister:result:
Adds a register property. This method encrypts the userId to implement the German “Datenschutzgesetz”
-
– addSearch:numberOfHits:
Adds a search property
-
– addSiteId:
Adds a siteid property. Some shop systems can handle multiple sites. If we have to distinguish them, we set the siteid for the actual shop.
-
– addTarget:additionalInfo:score:targetRule:
Adds a target property.
Instance Methods
addBilling:customerId:total:country:cip:city:
Adds a billing property
- (void)addBilling:(NSString *)billingId customerId:(NSString *)customerId total:(double)total country:(NSString *)country cip:(NSString *)cip city:(NSString *)city
Parameters
- billingId
unique identifier for this bill
- customerId
unique identifier for this customer
- total
the total sum of this bill!
- country
the country of the customer
- cip
the cip of the customer
- city
the city of the customer
Discussion
Adds a billing property
Declared In
ETTrackingPageView.h
addContact:
Adds a contact property
- (void)addContact:(NSString *)contactType
Parameters
- contactType
type of the contact-form used
Discussion
Adds a contact property
Declared In
ETTrackingPageView.h
addContent:
Adds a content property
- (void)addContent:(NSString *)content
Parameters
- content
a content-label for this page
Discussion
Adds a content property
Declared In
ETTrackingPageView.h
addCountryId:
Adds a country property. Some shop systems can handle multiple sites. If we have to distinguish them, we set the countryId for the actual shop.
- (void)addCountryId:(NSString *)countryId
Parameters
- countryId
unique identifier for this country
Discussion
Adds a country property. Some shop systems can handle multiple sites. If we have to distinguish them, we set the countryId for the actual shop.
Declared In
ETTrackingPageView.h
addDownload:
Adds a download property
- (void)addDownload:(NSString *)label
Parameters
- label
a download-label for this page
Discussion
Adds a download property
Declared In
ETTrackingPageView.h
addLangId:
Adds a language property. Some shop systems can handle multiple languages. If we have to distinguish them, we set the language.
- (void)addLangId:(NSString *)langId
Parameters
- langId
unique identifier for this language
Discussion
Adds a language property. Some shop systems can handle multiple languages. If we have to distinguish them, we set the language.
Declared In
ETTrackingPageView.h
addLogin:result:
Adds a login property. We encrypt (generate md5-Hash) the userId to implement the German “Datenschutzgesetz” in this Method
- (void)addLogin:(NSString *)userId result:(int)result
Parameters
- userId
UserID or email – must be a unique identifier
- result
result 0 if succes, positive int for error numbers
Discussion
Adds a login property. We encrypt (generate md5-Hash) the userId to implement the German “Datenschutzgesetz” in this Method
Declared In
ETTrackingPageView.h
addMarketingChannel:
Adds a property for marketing channel (‘source’)
- (void)addMarketingChannel:(NSString *)marketingChannel
Parameters
- marketingChannel
a marketing channel
Discussion
Adds a property for marketing channel (‘source’)
Declared In
ETTrackingPageView.h
addOrderProcess:
Adds a orderProcess property.
- (void)addOrderProcess:(NSString *)processStep
Parameters
- processStep
a Label to identify the step in the order-process by convention this is a positive int followed by an underscore and the label e.g. “1_Kundendaten”, “2_Zahlungsoptionen”, …
Discussion
Adds a orderProcess property.
Declared In
ETTrackingPageView.h
addPageId:
Adds a pageId property. pageId is used by Clickmonitor to distinguish Pages
- (void)addPageId:(NSString *)pageId
Parameters
- pageId
unique identifier for this page
Discussion
Adds a pageId property. pageId is used by Clickmonitor to distinguish Pages
Declared In
ETTrackingPageView.h
addProductAddToBasket:
Adds a addToBasket – Event to this page
- (void)addProductAddToBasket:(ETBasketItem *)item
Parameters
- item
the ETBasketItem this Event belongs to
Discussion
Adds a addToBasket – Event to this page
Declared In
ETTrackingPageView.h
addProductBuy:
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘buy’ and all ETBasketItem-Informations.
- (void)addProductBuy:(ETBasketItem *)item
Parameters
- item
Discussion
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘buy’ and all ETBasketItem-Informations.
Declared In
ETTrackingPageView.h
addProductBuyList:
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘buy’ and all BasketItem-Informations.
- (void)addProductBuyList:(NSArray *)basket
Parameters
- basket
Array of ETBasketItems
Discussion
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘buy’ and all BasketItem-Informations.
Declared In
ETTrackingPageView.h
addProductCustomEvent:eventType:
Adds a ec_Event property with custom eventType. Stored as array of array. Array contains the custom eventType and all ETBasketItem-Informations.
- (void)addProductCustomEvent:(ETBasketItem *)item eventType:(NSString *)eventType
Parameters
- item
the item the EC-Event belongs to
- eventType
type of the event like c_add, c_rmv, view, buy
Discussion
Adds a ec_Event property with custom eventType. Stored as array of array. Array contains the custom eventType and all ETBasketItem-Informations.
Declared In
ETTrackingPageView.h
addProductRemoveFromBasket:
Adds a removeFromBasket – Event to this page
- (void)addProductRemoveFromBasket:(ETBasketItem *)item
Parameters
- item
the ETBasketItem this Event belongs to
Discussion
Adds a removeFromBasket – Event to this page
Declared In
ETTrackingPageView.h
addProductView:
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘view’ and all BasketItem-Informations.
- (void)addProductView:(ETBasketItem *)item
Parameters
- item
ETBasketItem this detail View belongs to
Discussion
Adds a ec_Event property. Stored as array of array. Array contains the eventType = ‘view’ and all BasketItem-Informations.
Declared In
ETTrackingPageView.h
addProperty:boolValue:
Adds a custom boolean property
- (void)addProperty:(NSString *)key boolValue:(BOOL)value
Parameters
- key
key
- value
value
Discussion
Adds a custom boolean property
Declared In
ETTrackingPageView.h
addProperty:numberValue:
Adds a custom number property
- (void)addProperty:(NSString *)key numberValue:(NSNumber *)value
Parameters
- key
key
- value
value
Discussion
Adds a custom number property
Declared In
ETTrackingPageView.h
addProperty:stringValue:
Adds a custom string property
- (void)addProperty:(NSString *)key stringValue:(NSString *)value
Parameters
- key
key
- value
value
Discussion
Adds a custom string property
Declared In
ETTrackingPageView.h
addPropertyArray:array:
Adds a custom array property
- (void)addPropertyArray:(NSString *)key array:(NSArray *)array
Parameters
- key
key
- array
array
Discussion
Adds a custom array property
Declared In
ETTrackingPageView.h
addPropertyArrays:array:
Adds a custom array of arrays property
- (void)addPropertyArrays:(NSString *)key array:(NSArray *)arrays
Parameters
- key
key
- arrays
arrays
Discussion
Adds a custom array of arrays property
Declared In
ETTrackingPageView.h
addRegister:result:
Adds a register property. This method encrypts the userId to implement the German “Datenschutzgesetz”
- (void)addRegister:(NSString *)userId result:(int)result
Parameters
- userId
UserID or email must be a unique identifier
- result
result code 0 if success positive int for error numbers
Discussion
Adds a register property. This method encrypts the userId to implement the German “Datenschutzgesetz”
Declared In
ETTrackingPageView.h
addSearch:numberOfHits:
Adds a search property
- (void)addSearch:(NSString *)queryString numberOfHits:(int)numberOfHits
Parameters
- queryString
the search string
- numberOfHits
the number of hits found
Discussion
Adds a search property
Declared In
ETTrackingPageView.h
addSiteId:
Adds a siteid property. Some shop systems can handle multiple sites. If we have to distinguish them, we set the siteid for the actual shop.
- (void)addSiteId:(NSString *)siteId
Parameters
- siteId
unique identifier for this site
Discussion
Adds a siteid property. Some shop systems can handle multiple sites. If we have to distinguish them, we set the siteid for the actual shop.
Declared In
ETTrackingPageView.h
addTarget:additionalInfo:score:targetRule:
Adds a target property.
- (void)addTarget:(NSString *)target additionalInfo:(NSString *)additionalInfo score:(double)score targetRule:(ETTargetRule)rule
Parameters
- target
Name for this Target, e.g. download, lottery
- additionalInfo
additional Information, e.g. the Name of the downloaded Document
- score
Your value of this target (used for calculation of conversationrate)
- rule
Method to use. Only first of session, all or usage of default value configured in econda-monitor
Discussion
Adds a target property.
Declared In
ETTrackingPageView.h