Analytics external object

This documentation is valid for:
GeneXus 18 Help

The Analytics external object allows increasing the number of scenarios that can be solved using the Enable (Google) Analytics property on client-side events.

Warning: The methods are not available in objects without UI, such as Procedures or Data Providers.

Methods

TrackView method

It allows tracking a certain view by indicating its name. The most natural way of tracking views is by using the ClientStart event.

Return value	None
Parameters	ViewName:Character(100)

Note: Note that the PageView is tracked automatically in Web Panel objects (.NET and Java) by the Analytics Control.

TrackEvent method

It allows tracking events through their features in order to obtain relevant data of consumers.
These features and their meanings are described below.

Category - Name of the category that the event belongs to. Its purpose is only to group these events by category for reporting.
Action - Name of the action that identifies the event.
Label - A label associated with the event.
Value - A numerical weighted value for the event. Its objective is to allow managing reports (such as total, averages, etc.).
customParameters - Extra parameter to customize the events to be sent to the Enable (Google) Analytics property.

Return value	None
Parameters	Category:Character(100), Action:Character(100), Label:Character(100), Value:Numeric(18.2-), customParameters: AnalyticsKeyValue Structured Data Type (it is a collection and each instance contains the following members: Key:VarChar(40), Value: VarChar(200)).

TrackPurchase method

For e-commerce purposes. It allows sending in-app purchase data to be statistically processed. This information is loaded through the AnalyticsPurchase SDT.

Return value	None
Parameters	PurchaseInfo:AnalyticsPurchase

It allows univocally identifying end users when they access the main platform through more than one smart device, or at least one smart device and the web page.
This identifier must be provided by the developer (e.g. an authentication token, a username or an email, but not the device ID).

Return value	None
Parameters	UserId:Character(100)

TransactionId:Character(100)
Unique identifier for that sale.
Affiliation:Character(100)
Unique affiliation identifier that the sale must be associated with.
Revenue:Numeric(18.2-)
Deposit amount.
Tax:Numeric(18.2-)
Tax amount.
Shipping:Numeric(18.2-)
Shipping cost amount.
CurrencyCode:Character(100)
Currency code for the transaction (e.g. 'USD' for American dollars).
Items:Collection
A collection of purchased items with their associated data.
Id:Character(100)
Product Identifier.
Name:Character(100)
Product name.
Category:Character(100)
Category name that the product belongs to.
Price:Numeric(18.2-)
Product unit price.
Quantity:Numeric(18.2-)
Product quantity bought.
CurrencyCode:Character(100)
Currency code for the set price.