HUAWEI Analytics Kit provides three types of events, including automatically collected events, preset events, and custom events.
Automatically collected events: Such events can be automatically collected without tracing points, and the only requirement is that the function of collecting system events is enabled. (The function is automatically enabled during initiation.)
Preset events: The HMS Core Analytics SDK predefines some event IDs based on common application scenarios. It is recommended that predefined constants be used for burying tracing points and analysis. The system provides various insight reports based on preset events.
Custom events: You can report custom events for personalized analysis requirements that cannot be met by automatically collected events and preset events.
Event IDs of automatically collected events are reserved by HUAWEI Analytics Kit and cannot be reused.
| Event ID | Description |
|---|---|
INSTALLAPP | Event reported when an app is launched for the first time after being installed. |
LAUNCHAPP | Event reported when a user launches an app or a user goes back to an app 30 seconds after accessing the home screen. |
UPDATEAPP | Event reported when an app is updated to the new version and launched again. |
APPFIRSTOPEN | Event reported when a user launches an app for the first time after installing or reinstalling it. The event will not be triggered when the user downloads the app to the device. Through this event, you can know the launch type, installation channel, and launch time. |
ENTERSCREEN | Event reported if a user enters the screen when the automatic collection function is enabled. |
EXITSCREEN | Event reported if a user exits the screen when the automatic collection function is enabled. |
Preset events and parameters are reserved for HUAWEI Analytics Kit. The ID of a custom event cannot be the same as that of a preset event. Otherwise, the custom event will be identified as a preset event.
| Type | Event ID | Event Description |
|---|---|---|
String | Add payment information | |
String | Add to shopping cart | |
String | Add to wishlist | |
String | Open app | |
String | Start check-out | |
String | View marketing campaign | |
String | View checkout step | |
String | Obtain virtual currency | |
String | Complete payment | |
String | Obtain lead | |
String | Join group | |
String | Unlock level | |
String | Complete level | |
String | Level up | |
String | Sign in | |
String | Submit score | |
String | Create order | |
String | Refund order | |
String | Remove product from shopping cart | |
String | Search | |
String | Touch content | |
String | Set check-out option | |
String | Share content | |
String | Register account | |
String | Consume virtual currency | |
String | Start tutorial | |
String | Complete tutorial | |
String | Unlock achievement | |
String | View product | |
String | View product list | |
String | View search result | |
String | UPDATEMEMBERSHIPLEVEL | Update member level |
String | Filter product | |
String | View product category | |
String | Update order | |
String | Cancel order | |
String | Complete order | |
String | Cancel payment | |
String | Obtain voucher |
This event is reported when a user has added payment information but has not initiated payment during checkout.
It can be used with STARTCHECKOUT and COMPLETEPURCHASE to construct funnel analysis for the checkout process.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PAYTYPE | Payment mode | String | Mandatory | Payment mode selected by a user. |
This event is reported when a user adds a product to the shopping cart.
It can be used with VIEWPRODUCT and STARTCHECKOUT to construct funnel analysis for product purchase. It can also be used to analyze products that users are interested in, helping you promote the products to the users.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Mandatory | ID of the product added to the shopping cart. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product added to the shopping cart. |
PRODUCTFEATURE | Product features | String | Optional | Features of the product added to the shopping cart. |
BRAND | Product brand | String | Optional | Brand of the product added to the shopping cart. |
CATEGORY | Product category | String | Mandatory | Category of the product added to the shopping cart. |
STORENAME | Store name | String | Optional | Store of the product added to the shopping cart. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products that a user wants to purchase. |
PRICE | Purchase price | Double | Optional | Product price. |
REVENUE | Expected revenue | Double | Optional | Your expected revenue after a user purchase the product. This parameter must be used together with CURRNAME. |
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
PLACEID | Location ID | String | Optional | ID of the product location. |
This event is reported when a user adds a product to the wishlist.
It can be used to analyze products that users are interested in, helping you promote the products to the users.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Mandatory | ID of the product added to the wishlist. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product added to the wishlist. |
PRODUCTFEATURE | Product features | String | Optional | Features of the product added to the wishlist. |
BRAND | Product brand | String | Optional | Brand of the product added to the wishlist. |
CATEGORY | Product category | String | Mandatory | Category of the product added to the wishlist. |
STORENAME | Store name | String | Optional | Store of the product added to the wishlist. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products that a user wants to purchase. |
PRICE | Purchase price | Double | Optional | Product price. |
REVENUE | Expected revenue | Double | Optional | Your expected revenue after a user purchase the product. This parameter must be used together with CURRNAME. |
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
PLACEID | Location ID | String | Optional | ID of the product location. |
This event is reported when a user launches the app.
This event is reported when a user clicks the checkout button after placing an order. It can be used with VIEWPRODUCT and COMPLETEPURCHASE to construct funnel analysis for the e-commerce purchase conversion rate.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
REVENUE | Revenue | Double | Optional | Revenue that you will receive. This parameter must be used together with CURRNAME. |
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
TRANSACTIONID | Transaction ID | String | Optional | Transaction ID generated by your transaction system. |
BOOKINGDAYS | Stay duration | Long | Optional | Number of days a user books for a hotel reservation. |
BOOKINGROOMS | Rooms booked | Long | Optional | Number of rooms a user books for a hotel reservation. |
PASSENGERSNUMBER | Guests | Long | Optional | Number of guests a user books for a hotel reservation. |
ORIGINATINGPLACE | Departure location | String | Optional | User departure location for a hotel reservation. |
DESTINATION | Destination | String | Optional | User destination for a hotel reservation. |
BEGINDATE | Check-in date | String | Optional | User check-in date for a hotel reservation. |
ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
CLASS | Room level | String | Optional | Level of a room booked by a user for a hotel reservation. |
VOUCHER | Voucher name | String | Optional | Voucher selected by a user. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
This event is reported when a user view details of a marketing campaign. It can be used to analyze the conversion rate of a marketing campaign.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
SOURCE | Marketing source | String | Mandatory | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Mandatory | Type of a marketing activity, for example, CPC or email. |
PROMOTIONNAME | Marketing name | String | Mandatory | Name of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
CLICKID | Ad network flag | String | Optional | Flag generated by the ad network for marking the ad click. |
EXTENDPARAM | Custom parameter | String | Optional | Custom parameter. |
MATERIALSLOTTYPE | Display slot type | String | Optional | Type of the slot where a creative material is displayed, for example, the ad slot, operations slot, or banner. |
This event is reported when a user views steps of the settlement process.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
STEP | Check-out step | String | Optional | Current step of a user in the check-out process. |
OPTION | Check-out option | String | Optional | Check-out option entered by a user in the current check-out step. |
This event is reported when a user obtains virtual currency. It can be used to analyze the difficulty for users to obtain virtual currency, which helps you optimize the product design.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
VIRTUALCURRNAME | Virtual currency type | String | Mandatory | Type of the virtual currency obtained by a user. |
REVENUE | Virtual currency amount | Long or Double | Mandatory | Virtual currency amount obtained by a user. |
Event reported after a user completes payment. It can be used to analyze the products or contents that users are more interested in, which helps you optimize the operations policy.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Mandatory | ID of the product added to the shopping cart. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product added to the shopping cart. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products that a user wants to purchase. |
OCCURREDTIME | Purchase time | String | Mandatory | Time when a user purchases a product. |
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
REVENUE | Revenue | Double | Optional | Revenue that you will receive through the transaction. This parameter must be used together with CURRNAME. |
TAXFEE | Tax | Double | Optional | Tax generated for the transaction. |
SHIPPING | Transportation fee | Double | Optional | Transportation fee generated for the transaction. |
VOUCHER | Voucher | String | Optional | Voucher used in the transaction. |
PLACE | Location ID | String | Optional | ID of the product location. |
BOOKINGDAYS | Stay duration | Long | Optional | Number of days a user books for a hotel reservation. |
BOOKINGROOMS | Rooms booked | Long | Optional | Number of rooms a user books for a hotel reservation. |
PASSENGERSNUMBER | Guests | Long | Optional | Number of guests a user books for a hotel reservation. |
ORIGINATINGPLACE | Departure location | String | Optional | User departure location for a hotel reservation. |
DESTINATION | Destination | String | Optional | User destination for a hotel reservation. |
BEGINDATE | Check-in date | String | Optional | User check-in date for a hotel reservation. |
ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Optional | Category of the associated product. |
ORDERID | Order ID | String | Optional | Order ID generated by your transaction system. |
TRANSACTIONID | Transaction ID | String | Optional | Transaction ID generated by your transaction system. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
CLASS | Room level | String | Optional | Level of a room booked by a user for a hotel reservation. |
This event is reported when a sales lead is obtained. For example, it can be reported after a user touches the ad placed by a developer and fills in and submits the contact information. In this case, the event can be used to evaluate the possible revenue brought by the lead to you and to evaluate the ROI of the placed ad.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
REVENUE | Expected revenue | Double | Optional | Expected revenue generated after lead conversion, which is not the real revenue. |
This event is reported when a user joins in a group, for example, joining in a group chart in a social app. It can be used to evaluate the attractiveness of your product's social features to users.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
USERGROUPID | Group ID | String | Mandatory | ID of the user group that a user joins. |
This event is reported when a user starts a game level in a game app. It can be used together with COMPLETELEVEL to analyze whether the game level design is proper and make targeted optimization policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
LEVELNAME | Level name | Long | Mandatory | Name of a game level. |
This event is reported when a user completes a game level in a game app. It can be used with STARTLEVEL to analyze whether the game level design is proper and make targeted optimization policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
LEVELNAME | Level name | Long | Mandatory | Name of a game level. |
RESULT | Level completion status | String | Optional | Game level completion status. |
This event is reported when a user levels up in a game app. It can be used to analyze whether your product's user level design is optimal and make targeted optimization policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
LEVELID | User level | Long | Mandatory | Level of a user after level-up. |
ROLENAME | User role | String | Optional | Role of a user. |
This event is reported when a user signs in to an app requiring sign-in. It can be used to analyze users' sign-in habits and make targeted operations policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CHANNEL | Sign-in channel | String | Mandatory | Channel through which a user signs in. |
EVTRESULT | Sign-in result | String | Optional | Sign-in result. |
OCCURREDTIME | Sign-in time | String | Mandatory | Sign-in time. |
This event is reported when a user submits the score in a game or education app. It can be used to analyze the difficulty of product content and make targeted optimization policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
SCORE | Score | Long | Mandatory | Score of a user. |
LEVELID | User level | Long | Optional | Current level of a user. |
ROLENAME | User role | String | Optional | Role of a user. |
This event is reported when a user creates an order.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Optional | ID of the associated product. |
PRODUCTNAME | Product name | String | Mandatory | Name of the associated product. |
PRODUCTFEATURE | Product features | String | Optional | Feature of the associated product. |
STORENAME | Store name | String | Optional | Store of the associated product. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | Product price | Double | Optional | Product price. |
REVENUE | Revenue | Double | Optional | Revenue you will receive through the transaction. |
CURRNAME | Currency type | String | Optional | Revenue currency type. |
PLACEID | Location ID | String | Optional | ID of the product location. |
ORDERID | Order ID | String | Optional | Order ID generated by your transaction system. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Mandatory | Category of the associated product. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
This event is reported when a subscriber cancels an order and applies for refund. It can be used to analyze loss caused by the refund and make targeted optimization policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CURRNAME | Currency type | String | Optional | Refund currency type. |
REVENUE | Refund amount | Double | Optional | Your revenue loss due to the refund. |
TRANSACTIONID | Transaction ID | String | Optional | Transaction ID generated by your transaction system. |
ORDERID | Order ID | String | Optional | Order ID generated by your transaction system. |
PRODUCTID | Product ID | String | Mandatory | ID of the product in an order involved in refund. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product in an order involved in a refund. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products that a user wants to purchase. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Mandatory | Category of the associated product. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
REASON | Refund Reason | String | Mandatory | Reason for refund. |
This event is reported when a user removes a product from the shopping cart. It can be used for marketing to the user.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
QUANTITY | Purchase quantity | Long | Optional | Number of products removed from the shopping cart. |
CATEGORY | Product category | String | Mandatory | Category of the product removed from the shopping cart. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product removed from the shopping cart. |
PRODUCTID | Product ID | String | Mandatory | ID of the product removed from the shopping cart. |
PRODUCTFEATURE | Product features | String | Optional | Features of the product removed from the shopping cart. |
BRAND | Product brand | String | Optional | Brand of the product removed from the shopping cart. |
STORENAME | Store name | String | Optional | Store of the product removed from the shopping cart. |
REVENUE | Revenue loss | Double | Optional | Your expected revenue loss due to the removal. |
PRICE | Product price | Double | Optional | Price of the product removed from the shopping cart. |
CURRNAME | Currency type | String | Optional | Currency type of the revenue loss. |
PLACEID | Location ID | String | Optional | ID of the product location. |
BEGINDATE | Adding to shopping cart time | String | Optional | Time when the product is added to the shopping cart. |
ENDDATE | Removing from shopping cart time | String | Optional | Time when the product is removed from the shopping cart. |
ORIGINATINGPLACE | Place of delivery | String | Optional | Place from which the product is delivered. |
DESTINATION | Place of receipt | String | Optional | Place where the user receives the product. |
This event is reported when a user searches for content in an app. It can be used with events such as HA_SEARCH_RESULTS and HA_VIEW_ITEM to analyze the accuracy of search results.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
SEARCHKEYWORDS | Search keyword | String | Optional | Keyword for search. |
BOOKINGDAYS | Stay duration | Long | Optional | Number of days a user books for a hotel reservation. |
BOOKINGROOMS | Rooms booked | Long | Optional | Number of rooms a user books for a hotel reservation. |
PASSENGERSNUMBER | Guests | Long | Optional | Number of guests a user books for a hotel reservation. |
ORIGINATINGPLACE | Departure location | String | Optional | User departure location for a hotel reservation. |
DESTINATION | Destination | String | Optional | User destination for a hotel reservation. |
BEGINDATE | Check-in date | String | Optional | User check-in date for a hotel reservation. |
ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
CLASS | Room level | String | Optional | Level of a room booked by a user for a hotel reservation. |
This event is reported when a user touches a content, for example, a user touches a product in the product list in an e-commerce app to view the product details. It can be used to analyze the products that users are interested in.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CONTENTTYPE | Content type | String | Mandatory | Type of the content touched by a user. |
PRODUCTID | Content ID | String | Mandatory | ID of the content shared by a user. |
This event is reported when a user sets some checkout options during checkout. It can be used to analyze checkout preferences of users.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
STEP | Check-out step | String | Optional | Current step of a user in the check-out process. |
OPTION | Check-out option | String | Optional | Check-out option entered by a user in the current check-out step. |
This event is reported when a user shares a product or content through a social channel. It can be used to analyze users' loyalty to the product.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CONTENTTYPE | Shared content type | String | Mandatory | Type of the content shared by a user. |
PRODUCTID | Shared content ID | String | Mandatory | ID of the content shared by a user. |
CHANNEL | Sharing mode | String | Mandatory | Channel through which a user shares the content. |
This event is reported when a user registers an account. It can be used to analyze the user sources and optimize operations policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
REGISTMETHOD | User source | String | Optional | User source. |
ACOUNTTYPE | Account type | String | Optional | Account type of a user, for example, email or mobile number. |
OCCURREDTIME | Registration time | String | Mandatory | Time when an account is registered. |
This event is reported when a user consumes virtual currency. It can be used to analyze the products that users are interested in.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTNAME | Product name | String | Mandatory | Name of the product purchased by a user. |
VIRTUALCURRNAME | Virtual currency unit | String | Mandatory | Currency unit of the virtual currency used by a user. |
REVENUE | Virtual currency amount | Long or Double | Mandatory | Amount of the virtual currency consumed by a user. |
This event is reported when a user starts to use the tutorial. It can be used with COMPLETETUTORIAL to evaluate the tutorial quality and formulate targeted optimization policies.
This event is reported when a user completes the tutorial. It can be used with STARTTUTORIAL to evaluate the tutorial quality and formulate targeted optimization policies.
This event is reported when a user unlocks an achievement. It can be used to analyze whether the achievement level design is optimal and make targeted optimization policies.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
ACHIEVEMENTID | Achievement ID | String | Mandatory | ID of an achievement. |
This event is reported when a user browses a product. It can be used to analyze the products that users are interested in, or used with other events for funnel analysis.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Mandatory | ID of the product viewed by a user. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product viewed by a user. |
PRODUCTFEATURE | Product features | String | Optional | Features of the product viewed by a user. |
CATEGORY | Product category | String | Mandatory | Category of the product viewed by a user. |
BRAND | Product brand | String | Optional | Brand of the product viewed by a user. |
STORENAME | Store name | String | Optional | Store of the product viewed by a user. |
PLACEID | Location ID | String | Optional | ID of the product location. |
POSITIONID | Product index | String | Optional | Index of the product viewed by a user in the product list. |
PRODUCTLIST | Product list | String | Optional | List of products viewed by a user. |
PRICE | Product price | Double | Optional | Product price. |
QUANTITY | Quantity | Long | Optional | Number of products that a user wants to purchase. |
REVENUE | Revenue | Double | Optional | Your expected revenue after a user purchase the product. This parameter must be used together with CURRNAME. |
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
REVENUE | Revenue | Double | Optional | Your expected revenue after a user purchase the product. This parameter must be used together with CURRNAME. |
FLIGHTNO | Flight number | String | Optional | Flight number generated by your transaction system. |
PASSENGERSNUMBER | Guests | Long | Optional | Number of guests a user books for a hotel reservation. |
BOOKINGDAYS | Stay duration | Long | Optional | Number of days a user books for a hotel reservation. |
BOOKINGROOMS | Rooms booked | Long | Optional | Number of rooms a user books for a hotel reservation. |
ORIGINATINGPLACE | Departure location | String | Optional | User departure location for a hotel reservation. |
DESTINATION | Destination | String | Optional | User destination for a hotel reservation. |
BEGINDATE | Check-in date | String | Optional | User check-in date for a hotel reservation. |
SEARCHKEYWORDS | Search keyword | String | Optional | Keyword for search. |
CLASS | Room level | String | Optional | Level of a room booked by a user for a hotel reservation. |
VOUCHERS | Applicable vouchers | String | Optional | Names of vouchers applicable to a product. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
This event is reported when a user browses a list of products, for example, browsing the list of products by category. It can be used to analyze the types of contents that users are more interested in.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CATEGORY | Product category | String | Mandatory | Category of the product viewed by a user in the product list. |
This event is reported when a user views the search results. It can be used with HA_VIEW_ITEM and HA_SEARCH to measure the accuracy of the search algorithm.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
SEARCHKEYWORDS | Search keyword | String | Optional | Keyword for search. |
This event is reported when a user signs out through HUAWEI Analytics Kit.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CHANNEL | Sign-out channel | String | Mandatory | Channel through which a user signs out. |
EVTRESULT | Sign-out result | String | Mandatory | Sign-out result. |
OCCURREDTIME | Sign-out time | String | Mandatory | Sign-out time. |
This event is reported when a user purchases membership or signs in for the first time after membership expires. It is used to analyze user habits.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PREVLEVEL | Level before change | String | Mandatory | Level before the change. |
CURRVLEVE | Current level | String | Mandatory | Current level. |
REASON | Change reason | String | Mandatory | Change reason. |
This event is reported when a user sets conditions to filter products displayed. It is used to analyze user preferences.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
LISTID | Product ID list | String | Optional | Product ID list. |
CATEGORY | Product category | String | Optional | Category of the associated product. |
FILTERS | Filter condition | String | Optional | Filter condition. |
SORTS | Sorting condition | String | Optional | Sorting condition. |
KEYWORDS | Keywords | String | Optional | Keyword for search. |
This event is reported when a user taps a product category. It is used to analyze popular product categories or user preferences.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
CATEGORY | Product category | String | Mandatory | Name of the product category viewed by a user. |
POSITIONID | Product index | String | Optional | Index of the product viewed by a user in the product list. |
This event is reported when a user modifies an order.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Optional | ID of the associated product. |
PRODUCTNAME | Product name | String | Mandatory | Name of the associated product. |
PRODUCTFEATURE | Product features | String | Optional | Features of the associated product. |
STORENAME | Store name | String | Optional | Store of the associated product. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | Product price | Double | Optional | Product price. |
REVENUE | Revenue | Double | Optional | Revenue you receive through the transaction. |
CURRNAME | Currency type | String | Optional | Revenue currency type. |
PLACEID | Location ID | String | Optional | ID of the product location. |
ORDERID | Order ID | String | Optional | Order ID generated by your transaction system. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Mandatory | Category of the associated product. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
This event is reported when a user cancels an order.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Optional | ID of the associated product. |
PRODUCTNAME | Product name | String | Mandatory | Name of the associated product. |
PRODUCTFEATURE | Product features | String | Optional | Features of the associated product. |
STORENAME | Store name | String | Optional | Store of the associated product. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | Product price | Double | Optional | Product price. |
REVENUE | Revenue | Double | Optional | Revenue you receive from the transaction. |
CURRNAME | Currency type | String | Optional | Revenue currency type. |
PLACEID | Location ID | String | Optional | ID of the product location. |
ORDERID | Order ID | String | Optional | Order ID generated by your transaction system. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Mandatory | Category of the associated product. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
REASON | Cancellation reason | String | Mandatory | Reason for canceling an order. |
This event is reported when a user confirms the reception.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Optional | ID of the associated product. |
PRODUCTNAME | Product name | String | Mandatory | Name of the associated product. |
PRODUCTFEATURE | Product features | String | Optional | Features of the associated product. |
STORENAME | Store name | String | Optional | Store of the associated product. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | Product price | Double | Optional | Product price. |
REVENUE | Revenue | Double | Optional | Revenue you receive from the transaction. |
CURRNAME | Currency type | String | Optional | Revenue currency type. |
PLACEID | Location ID | String | Optional | ID of the product location. |
ORDERID | Order ID | String | Optional | Order ID generated by your transaction system. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Mandatory | Category of the associated product. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
This event is reported when a user cancels an ongoing payment of a submitted order. It is used to analyze the cause of user churn.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
REASON | Cancellation reason | String | Mandatory | Reason for payment cancellation. |
STEP | Check-out step | String | Mandatory | Current step of a user in the check-out process. |
REVENUE | Revenue | Double | Optional | Revenue that you will receive. This parameter must be used together with CURRNAME. |
CURRNAME | Currency type | String | Optional | Revenue currency type. This parameter must be used together with REVENUE. |
TRANSACTIONID | Transaction ID | String | Optional | Transaction ID generated by your transaction system. |
BOOKINGDAYS | Stay duration | Long | Optional | Number of days a user books for a hotel reservation. |
BOOKINGROOMS | Rooms booked | Long | Optional | Number of rooms a user books for a hotel reservation. |
PASSENGERSNUMBER | Guests | Long | Optional | Number of guests a user books for a hotel reservation. |
ORIGINATINGPLACE | Departure location | String | Optional | User departure location for a hotel reservation. |
DESTINATION | Destination | String | Optional | User destination for a hotel reservation. |
BEGINDATE | Check-in date | String | Optional | User check-in date for a hotel reservation. |
ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
CLASS | Room level | String | Optional | Level of a room booked by a user for a hotel reservation. |
VOUCHER | Voucher name | String | Optional | Voucher selected by a user. |
SOURCE | Marketing source | String | Optional | ID of a marketing activity provider, for example, HUAWEI PPS. |
MEDIUM | Marketing type | String | Optional | Type of a marketing activity, for example, CPC, email, operational position, or banner. |
PROMOTIONNAME | Marketing name | String | Optional | Name of a marketing activity. |
CONTENT | Marketing content | String | Optional | Marketing content of a marketing activity. |
KEYWORDS | Keywords | String | Optional | Keywords of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative name | String | Optional | Name of the creative material used in a marketing activity. |
MATERIALSLOT | Material display slot ID | String | Optional | ID of the slot where a creative material is displayed. |
This event is reported when a user claims a voucher.
| Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Description |
|---|---|---|---|---|
VOUCHER | Voucher name | String | Mandatory | Voucher selected by a user. |
EXPIREDATE | Expiration time | Optional | Optional | Expiration time of a voucher. |
VOUCHERTYPE | Voucher type | String | Mandatory | Voucher type. |
Custom Events
You may need personalized events for tracing and analytics. HUAWEI Analytics Kit allows you to customize events and extend event parameters, or add personalized parameters for predefined events.
For example, you can add custom event begin_examination to indicate the event of entering a new exam and add the exam_difficulty parameter to define the exam difficulty, to meet analysis requirements of specific service scenarios.
The following is an example of a custom event.
- //Set user attributes.
- [HiAnalytics setUserProfile:@"student_id" setValue:@"009527"];
- //Customize tracing points and add tracing point code in the proper position of the project.
- [HiAnalytics onEvent:@"begin_examination" setParams:@{@"exam_difficulty":@"high",@"exam_level":@"1-1",@"exam_time":@"20190520-08"}];