The HUAWEI Analytics Kit server provides three types of events for developers, 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 |
|---|---|
DISPLAYNOTIFICATION | Event reported when a notification is sent and displayed to users. |
CLICKNOTIFICATION | Event reported when a user clicks a displayed notification. |
CLEARNOTIFICATION | Event reported when a user clears a displayed notification. |
JOINABTASK | Event reported when a user participates in an A/B test. |
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 when the automatic collection function is enabled and an activity is entered. |
EXITSCREEN | Event reported when the automatic collection function is enabled and an activity exits. |
CLEARDATA | Event reported when a user clears data. The possible cause is that the storage space occupied by the app data is too large. |
CLEARCACHE | Event reported when a user clears cache. The possible cause is that the storage space occupied by the app cache is too large. |
UNINSTALLAPP | Event reported when a user uninstalls an app. |
SIGNOUT | Event reported when a user signs out of HUAWEI Analytics Kit using a HUAWEI ID. |
| SIGNIN | Event reported when a user signs in of HUAWEI Analytics Kit using a HUAWEI ID. |
| APPERROR | Event reported when an app crashes or an exception occurs on the app. |
| INAPPPURCHASE | Event reported when a user purchases or subscribes to an in-app product using HUAWEI In-App Purch. |
| OPENAPPFROMAGCLINK | Event reported when a user launches an app through a dynamic link for the first time. |
| UPDATEAPPFROMAGCLINK | Event reported when a user taps a dynamic link to upgrade an app. |
| REOPENAPPFROMAGCLINK | Event reported when a user re-launches an app through a dynamic link. |
| REQUESTAD | Event reported when the app developed by a developer functions as the ad medium, a user accesses the page where the ad bar is located, and the app requests the ad from the ad platform. |
| DISPLAYAD | Event reported when a developer's app functions as the ad medium and displays an ad in an ad slot. |
| CLICKAD | Event reported when a user taps an ad displayed in the ad slot of a developer's app. |
| OBTAINADAWARD | Event reported when a user obtains an ad reward after completing the action specified in the rewarded ad requirements. |
| DISPLAYINAPPMESSAGE | Event triggered when an in-app message is sent and displayed to users. |
| DISMISSINAPPMESSAGE | Event triggered when a user deletes an in-app message or cancels the display of an in-app message. |
| CLICKINAPPMESSAGE | Event triggered when a user taps a displayed in-app message. |
Automatic collection events, including INAPPPURCHASE, REQUESTAD, DISPLAYAD, CLICKAD, OBTAINADAWARD, INSTALLAPP, CLEARDATA, CLEARCACHE, UNINSTALLAPP, SIGNIN and SIGNOUT depend on HMS Core (APK). Therefore, HMS Core (APK) must be integrated before collection.
HUAWEI Analytics Kit predefines some event IDs based on common application scenarios. It is recommended that predefined constants be used for event tracing and analytics. Based on preset events, you can customize various insight reports.
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 Name |
|---|---|---|
String | Add payment information | |
String | Add to shopping cart | |
String | Add to wishlist | |
String | Open app | |
String | Start check-out | |
String | Marketing Impression | |
String | Settlement Step Viewing | |
String | Obtain virtual currency | |
String | Payment Completion | |
String | Obtain lead | |
String | Join group | |
String | Unlock level | |
String | Complete level | |
String | Level up | |
String | Sign in | |
String | Submit score | |
String | Display order | |
String | Refund | |
String | Remove product from shopping cart | |
String | Search | |
String | Touch content | |
String | Set check-out option | |
String | Share | |
String | Register | |
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 | SIGNOUT | User Sign-Out |
| String | UPDATEMEMBERSHIPLEVEL | Member Level Update |
| String | FILTRATEPRODUCT | Product Filtering |
| String | VIEWCATEGORY | Product Category Display |
| String | UPDATEORDER | Order Update |
| String | CANCELORDER | Order Cancellation |
| String | COMPLETEORDER | Order Completion |
| String | CANCELCHECKOUT | Payment Cancellation |
| String | OBTAINVOUCHER | Coupon Claiming |
| String | CONTACTCUSTOMSERVICE | Customer Service Contact |
| String | RATE | Comment |
| String | INVITE | User Invitation |
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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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. This event can also be used to analyze developers' products that users are interested in, enabling developers to promote the products to the users.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 from which the product added to the shopping cart comes. |
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 favorites.
It can be used to analyze developers' products that users are interested in, enabling developers to promote the products to the users.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
PRODUCTID | Product ID | String | Mandatory | ID of the product added to favorites. |
PRODUCTNAME | Product name | String | Mandatory | Name of the product added to favorites. |
PRODUCTFEATURE | Product features | String | Optional | Features of the product added to favorites. |
BRAND | Product brand | String | Optional | Brand of the product added to favorites. |
CATEGORY | Product category | String | Mandatory | Category of the product added to favorites. |
STORENAME | Store name | String | Optional | Store from which the product added to favorites comes. |
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 opens the app.
This event is reported when a user taps the checkout button after placing an order. It can be used with events such as VIEWPRODUCT and COMPLETEPURCHASE to analyze the e-commerce purchase conversion rate.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
REVENUE | Revenue | Double | Optional | Revenue you 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 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. |
VOUCHERS | Coupon Name | String | Optional | Names of coupons applicable to a product. |
SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
Event reported when a marketing content item is displayed to a user. It can be used to analyze the conversion rate of a marketing campaign.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 | Keyword | String | Optional | Keyword 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. |
CLICKID | Ad network flag | String | Optional | Flag generated by the ad network for marking the ad click. |
EXTENDPARAM | Custom parameter | String | Optional | Custom parameter. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
MATERIALSLOTTYPE | Display Position Type | String | Optional | Type of the position where a creative asset is displayed, for example, the ad slot, operations slot, or banner. |
Event reported when a user views steps of the settlement process.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 checkout 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, supporting product design optimization.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 content items that users are more interested in, supporting operations policy optimization.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 you receive through the transaction. This parameter must be used together with CURRNAME. |
| TRANSACTIONID | Transaction ID | String | Optional | Transaction ID generated by your transaction system. |
| TAXFEE | Tax | Double | Optional | Tax generated for the transaction. |
| SHIPPING | Transportation fee | Double | Optional | Transportation fee generated for the transaction. |
| VOUCHER | Coupon | String | Optional | Coupon 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 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. |
| BRAND | Product brand | String | Optional | Product brand. |
| CATEGORY | Product category | String | Mandatory | Product category. |
| ORDERID | Order ID | String | Optional | Order ID generated by the developer transaction system. |
| SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
| 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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
| MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
| MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
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 is used to evaluate the possible revenue brought by the lead to developers. In addition, the event can also be used to evaluate the ROI of the placed ad.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 a product's social features to users.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 with COMPLETELEVEL to analyze whether the game level design is optimal and make targeted optimization policies.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 optimal and make targeted optimization policies.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
LEVELNAME | Level name | Level name | Mandatory | Name of a game level. |
RESULT | Level completion status | String | Mandatory | Game level completion status. |
This event is reported when a user levels up in a game app. It can be used to analyze whether the product's user level design is optimal and make targeted optimization policies.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 into an app requiring sign-in. It can be used to analyze users' sign-in habits and make targeted operations policies.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
| CHANNEL | Sign-In Channel | String | Mandatory | Indicates the channel through which a user signs in. |
| EVTRESULT | Sign-In Result | String | Optional | Indicates the sign-in result. |
| OCCURREDTIME | Sign-In Time | String | Mandatory | Indicates the 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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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. |
Event reported when a user creates an order.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 from which the associated product comes. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | 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 the developer transaction system. |
BRAND | Product Brand | String | Optional | Associated product brand. |
CATEGORY | Product Category | String | Mandatory | Associated product category. |
SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
This event is reported when the refund is successful for a user. It can be used to analyze loss caused by the refund and make targeted optimization policies.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 the developer transaction system. |
PRODUCTID | Product ID | String | Mandatory | ID of the product in an order involved in refund. |
PRODUCTNAME | Product Name | String | Product name | Name of the product in an order involved in a refund. |
QUANTITY | Purchase Quantity | Long | Purchase quantity | Number of products that a user wants to purchase. |
BRAND | Product brand | String | Optional | Product brand. |
CATEGORY | Product category | String | Mandatory | Product category. |
SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset 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.
Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 from which the product removed from the shopping cart comes. |
REVENUE | Revenue loss | Double | Optional | Your expected revenue loss due to the removal. |
PRICE | 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 VIEWSEARCHRESULT and VIEWPRODUCT to analyze the accuracy of search results.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 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, touching 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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
CONTENTTYPE | Content type | String | Mandatory | Type of the content touched by a user. |
PRODUCTID | Content ID | String | Mandatory | ID of the content touched 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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 for a user to share 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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
ACOUNTTYPE | Account Type | String | Optional | Indicates the registration mode of a user, for example, mobile number, email, and WeChat. |
| REGISTMETHOD | User sources | String | Optional | User sources. |
| OCCURREDTIME | Registration Time | String | Mandatory | Indicates the registration time. |
This event is reported when a user consumes virtual currency. It can be used to analyze the products that users are interested in.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 measures.
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 measures.
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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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.
| Event Parameter ID | Parameter Name | Parameter Name | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
VOUCHERS | Applicable Coupon | String | Optional | Names of coupons applicable to a product. |
SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
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 from which the product viewed by a user comes. |
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. |
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 | Customers | Long | Optional | Number of customers in the case of 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. |
ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
SEARCHKEYWORDS | Search keyword | String | Optional | Search keywords generated by your transaction system. |
CLASS | Room level | String | Optional | Level of a room reserved by a user in the case of hotel reservation. |
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.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 VIEWPRODUCT and SEARCH to measure the accuracy of the search algorithm.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
SEARCHKEYWORDS | Search keyword | String | Optional | Keyword for search. |
This event is reported when when a user signs out through HUAWEI Analytics Kit.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
| CHANNEL | Sign-Out Channel | String | Mandatory | Sign-Out Channel. |
| EVTRESULT | Sign-Out Result | String | Mandatory | Sign-Out Result. |
| OCCURREDTIME | Sign-Out Time | String | Mandatory | Sign-Out Time. |
Event reported when a user purchases membership or signs in for the first time after membership expires. This event is used to analyze user habits.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Optional/Mandatory |
|---|---|---|---|---|
PREVLEVEL | Level Before Change | String | Mandatory | Indicates the level before change. |
CURRVLEVEL | Current Level | String | Mandatory | Indicates the current level. |
REASON | Change Reason | String | Mandatory | Indicates the change reason. |
Event reported when a user sets conditions to filter products displayed. This event is used to analyze user preferences.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Optional/Mandatory |
|---|---|---|---|---|
| LISTID | Product ID list | String | Optional | Product ID list. |
| CATEGORY | Product Category | String | Optional | Product Category. |
| FILTERS | Filter Condition | String | Optional | Filter Condition. |
| SORTS | Sorting Condition | String | Optional | Sorting Condition. |
| KEYWORDS | Keyword | String | Optional | Keyword. |
Event reported when a user taps a product category. This event is used to analyze popular product categories or user preferences.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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. |
Event reported when an order is modified.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 from which the associated product comes. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | 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 the developer transaction system. |
BRAND | Product Brand | String | Optional | Associated product brand. |
CATEGORY | Product Category | String | Mandatory | Associated product category. |
SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
Event reported when a user cancels an order.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
| REASON | Cancellation Reason | String | Mandatory | Reason for payment cancellation. |
| 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. |
| BRAND | Product brand | String | Optional | Brand of the associated product. |
| CATEGORY | Product category | String | Mandatory | Category of the associated product. |
| STORENAME | Store name | String | Optional | Store from which the associated product comes. |
| QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
| PRICE | 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 the developer transaction system. |
| SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
| 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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
| MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
| MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
Event reported when a user confirms the reception.
| Event Parameter ID | Event Parameter ID | Parameter Type | Optional/Mandatory | Parameter 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 from which the associated product comes. |
QUANTITY | Purchase quantity | Long | Mandatory | Number of products purchased by a user. |
PRICE | 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 the developer transaction system. |
BRAND | Product Brand | String | Optional | Associated product brand. |
CATEGORY | Product Category | String | Mandatory | Associated product category. |
SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
Event reported when a user cancels an ongoing payment of a submitted order. This event is used to analyze the cause of user churn.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
| REASON | Payment 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 you 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 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. |
| VOUCHERS | Coupon Name | String | Optional | Names of coupons applicable to a product. |
| SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
| 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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
| MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
| MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
Event reported when a user claims a coupon.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
VOUCHER | Coupon Name | String | Mandatory | Coupon selected by a user. |
EXPIREDATE | Expiration Time | String | Optional | Expiration time of a coupon. |
VOUCHERTYPE | Coupon Type | String | Mandatory | Coupon Type. |
Event reported when a user contacts customer service personnel to query product details or make a complaint.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 from which the product viewed by a user comes. |
| 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. |
| 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 | Customers | Long | Optional | Number of customers in the case of 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. |
| ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
| SEARCHKEYWORDS | Search keyword | String | Optional | Search keywords generated by your transaction system. |
| CLASS | Room level | String | Optional | Level of a room reserved by a user in the case of hotel reservation. |
| VOUCHERS | Applicable Coupon | String | Optional | Names of coupons applicable to a product. |
| SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
| 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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
| MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
| MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
| REASON | Customer Service Request Reason | String | Mandatory | Reason why a user requests the customer service. |
| SERVICETYPE | Service Scenario | String | Mandatory | Type of a service provided for a user, for example, consultation or complaint. |
Event reported when a user comments on an app, service, or product.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter 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 from which the product viewed by a user comes. |
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. |
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 | Customers | Long | Optional | Number of customers in the case of 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. |
ENDDATE | Check-out date | String | Optional | User check-out date for a hotel reservation. |
SEARCHKEYWORDS | Search keyword | String | Optional | Search keywords generated by your transaction system. |
CLASS | Room level | String | Optional | Level of a room reserved by a user in the case of hotel reservation. |
VOUCHERS | Applicable Coupon | String | Optional | Names of coupons applicable to a product. |
| SOURCE | Marketing Source | String | Optional | ID of a marketing activity provider, for example, HUAWEI Ads. |
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 | Keyword | String | Optional | Keyword of a marketing activity, for example, a keyword for searching for an ad. |
MATERIALNAME | Creative Name | String | Optional | Name of the creative asset used in a marketing activity. |
MATERIALSLOT | Marketing Display Position ID | String | Optional | ID of the position where a creative asset is displayed. |
COMMENTTYPE | Evaluation Type | String | Mandatory | Evaluated object. |
DETAILS | Evaluation Details | String | Optional | Details of user evaluation on an object. |
LEVELID | Evaluation Grade | String | Optional | Grade of user evaluation on an object. |
Event reported when a user invites another one to use an app through social media.
| Event Parameter ID | Parameter Name | Parameter Type | Optional/Mandatory | Parameter Description |
|---|---|---|---|---|
CHANNEL | Invitation Channel | String | Mandatory | Channel through which an invitation is made. |
Custom Events
Developers may need personalized events for tracing and analytics. HUAWEI Analytics Kit allows developers 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.
- //Customize tracing points and add tracing point code to the proper position of the project.
- Bundle bundle = new Bundle();
- bundle.putString("exam_difficulty","high");
- bundle.putString("exam_level","1-1");
- bundle.putString("exam_time","20190520-08");
- instance.onEvent("begin_examination", bundle);