1.1 Web JS SDK #

1.1.1 check item validation #

1.1.2 Integration verification #

1. After opening the web page, you can see "sdk is ready" in the browser console to prove that the sdk initialization was successful.

   

2. Select Network. If the code event tracking is successfully completed, the list interface will be reported every time you click on the web interface. You can check:

   • Check if the http code of the list interface is 200 and if the interface returns e: 0.
   • See custom events and property reports in the payload.
     If the interface HTTP code is 200, the return value is e: 0, and you can see the custom event and custom properties to prove that the event was successfully reported.
   

   If the return value e is not 0, you can check this table again.

   Return field	Type	Return value description
   e	int	Status Code: 0: normal -1: Request parameter validation error (missing user, header, or event) -2: event format error -3: Request parameter parsing error (no parsing json) -4: Unsupported request types -5: Request array is too long (only for list interface, limit 50) -6: Too many events in the request (limit 50) -7: Get APPID error -8: Parse user errors (mostly internal errors) -9: Parse header error (multidimensional internal error) -10: Parse event error (mostly internal error) -11: Data sent downstream error (internal error) -12: event array is empty -100: Unknown error
   m	string	Error message, only appears when the request is verbose
   tc	int	Total number of events in the request
   sc	int	Number of events successfully parsed and collected

1.2 Android SDK #

1.2.1 check item validation #

After the above check and verification, you can call the relevant APIs, such as user, event, and other APIs to report.

1.2.2 Integration verification #

1.2.2.1 Power builder verification (Android stuido)

1. See the two proofs marked in the picture to prove that the sdk was successfully initialized (provided that the log switch is turned on during initialization to see it)

   

2. When reporting an event, to see if the event is successfully reported, you need to use the capture or event tracking verification function, refer to 1.2.2.2 or 1.2.2.3.

1.2.2.2 DevTools validation event report

Function description: event tracking developer tool
After accessing DevTools according to the documentation, open the DevTools panel to view access status, parameter configuration, event reporting and log requests, etc
Reference to determine whether the local report is normal:

• The status in the information bar is started, and there are SSID, BD_DID and other information
• Events in the event list exist and have been reported
• In the network list/service/2/app_log/interface status is 200 (green)

1.2.2.3 Event tracking verification function verification

Function description:Event Tracking Real-Time Verification
It needs to be integrated according to the relevant requirements of real-time event tracking. When the integration is successful, in Data Management - General Events, click Verify Event Tracking, and select Mobile End.

After scanning the code, you will see the reported behavior data in real time. The left side is the real-time behavior, and the right side is the attribute information of the corresponding behavior.

1.2.2.4 capture verification

Configure the packet capture tool, select the interface corresponding to the data reporting address to view the interface of the app_logevent_v3
Saas address: http://toblog.volceapplog.com , private deployment needs to select the corresponding data reporting address

1.3 iOS SDK #

1.3.1 Check item validation #

After the above inspection and verification, you can call the relevant APIs, such as user, event and other APIs to report

1.3.2 Integration verification #

1.3.2.1 Developer Tools Verification

1. Turn on the log switch during initialization, and you can see the Track Launch event related information in the output to prove that the sdk initialization was successful.

   

2. After reporting user data or event data, you can see the corresponding event in ouput to prove that the event and attributes were sent successfully.

   

1.3.2.2 DevTools validation event report

Function description: event tracking developer tool
Access DevTools in the Debug environment, you can view the event tracking report status, debug log, configuration parameters and other information locally in real time.

Reference to determine whether the local report is normal:

• The status in the information bar is Running, and there are SSID, BD_DID and other information
• Events in the event list exist and have been reported

1.3.2.3 Event tracking verification function verification

Function description: Event Tracking Real-Time Verification
It needs to be integrated according to the relevant requirements of real-time event tracking. When the integration is successful, in Data Management - General Events, click Verify Event Tracking, and select Mobile End.

After scanning the code, you will see the reported behavior data in real time. The left side is the real-time behavior, and the right side is the attribute information of the corresponding behavior.

1.3.2.3 capture verification

Configure the packet capture tool, select the interface corresponding to the data reporting address to view the interface of the app_logevent_v3
Saas address: http://toblog.volceapplog.com , private deployment needs to select the corresponding data reporting address

1.4 Mini Program SDK (WeChat Mini Program as an example) #

1.4.1 Check item validation #

After the above inspection and verification, you can call the relevant APIs, such as user, event and other APIs to report

1.4.2 Integration verification #

1.4.2.1 Power builder verification

1. The integration has completed the compilation. In the debugger Console, you see the following information to prove that the sdk initialization was successful.

   

2. Verify that there is a list interface reported in the debugger network, and the status code is 200

   

3. When clicking the code event tracking button, the corresponding event tracking event will be triggered. You can find the list? tea interface in the network to view the specific information of the event. If the status code is 200, it proves that the event was reported successfully.

   

1.4.2.2 Real machine verification can be monitored or captured through real-time event tracking

Function description: Event Tracking Real-Time Verification.
It needs to be integrated according to the relevant requirements of real-time event tracking. When the integration is successful, in Data Management - General Events, click Verify Event Tracking, select WeChat Mini Program, and upload the Mini Program code according to the instructions.

After scanning the code, you will see the reported behavior data in real time. The left side is the real-time behavior, and the right side is the attribute information of the corresponding behavior.

1.4.2.3 DevTools validation event report

Function description: event tracking developer tool
Through the Mini Program SDK event tracking power builder (DevTools component), the content and format of event tracking can be conveniently checked during the development stage. The tool provides functions such as environmental information viewing, initialization information status viewing, and event log viewing.

Reference to determine whether the local report is normal:

• Init, send and other API calls, report the domain name and initialization status;
• Events in the event list have a reported status.

1.5 Server level SDK (Java language) #

1.6 Http API #

1.6.1 Validate Basic Configuration Items #

Verify that the configuration of the Appkey in the header is correct, do not write it as appid.

It needs to be configured as the following result:

1.6.2 check response message #

• If the value of e in the response message is not 0, it means that the report was not successful.
• If the return is successful (e = 0), but the data is still not seen in the system, check the local_time_ms event timestamp:
  • Whether the time of the day is set, if it is the time of the day, the data can be seen in the system in real time;
  • If it is not on the same day and within the window period (within the past 7 days and within the next 24 hours), the data will not be seen until the next day. It is recommended to use the same-day timestamp for testing when testing.
  • If the time is outside the window (7 days ago and beyond the next 24 hours), the data will not be stored.
  • If the time is outside the window period (7 days ago and more than the next 24 hours), and you want to report historical data or data outside the window period, you need to add is_history identification, local_time_ms can be seen in real time on the same day, not the next day of the day see

1.6.3 Common problem #

Q1: Error: get appid error
The appkey is wrong, you need to fill in the correct appkey.
Q2: Error: parse web/mp3 data error
This error is written as a problem with the parameters of the body. Just check the body and refer to it normally.

[{
    "user": {
        "user_unique_id": "useid1"
    },
    "header": {
        "app_name": "test031701",
        "ab_sdk_version": "24",
        "app_version":"1.0.1.2",
        "custom": {
              "public_prop222": "22222" 
        }
    },
    "events": [
        {
            "ab_sdk_version": "24",
            "event": "track11",
            "params": "{\"pay_real\":\"2990\", \"pro_type\":\"4\"}",
            "local_time_ms": 1656582814712
        }
    ]
}]

Q3: For anonymous user scenarios, can the client side SDK be reported without integration?
No, for anonymous users, you need to report deviceID or bddid. These two IDs need to be generated by the integrated client side and then passed through to the server level.

1. In Data Management - General Events/Event Properties/User Properties, verify that the reported custom events and custom properties exist in the event list, event properties and user properties list.

   

2. User-user detailed investigation, according to ssid or uuid query to see the specific behavior of the user, to see if the user exists, and whether there are behavioral events

   
   
   

3. It can also be verified in Advanced Analysis-Event Analysis, but it should be noted that if it is data transmitted on the same day, the date needs to be selected today when querying the data.

   

4. When users can scrutinize or analyze the reported data, then the SDK integration and event reporting are successful.

5. If the user does not report successfully, you need to see whether to call the API that sets the user (user_unique_id). If you do not set user_unique_id then the user is anonymous.

6. If the list in the browser developer network shows success, but the system does not find certain events or event properties, you can check whether there are failed events and properties reported in Data Management - Data Quality.

3.1 APP embedded H5 verification #

Description: If you need to do the app embedded H5 to get through, you can do the following checks. If you don't need it, you can ignore it.

3.1.1 Check item validation #

• Does the H5 page integrate with JavaScript?
• After the H5 page integrates with JSSDK, whether the initialized Nataive parameter is true (Native: true before the 5.1.3 version, enable_native: true after the 5.1.3 version)
• Whether the mobile end integrates the sdk (ios, android) of the mobile end
• Whether to refer to the integration code of each end for integration in mobile end integration needs to do two things
  • Turn on the H5Bridge switch during initialization
  • configuration whitelist

3.1.2 Data validation #

• When the data is connected, use the app to report the behavioral event data, and check whether the value of the platform field in the corresponding behavioral event is wap or ios/android through real-time event tracking monitoring or bag grabbing tools:

  • If the WAP proves that the data is not connected, it needs to be checked accordingly.
  • If it is iOS/Android, it proves that the data is successfully connected.

• Real-time event tracking monitoring and packet capture refer to the verification instructions of each end above

• Real-time event tracking data reference

  

  Packet capture tool data reference:

  • Get through the reference (platform is android):

    

  • If the platform is not opened, it is wap.

    

• When the platform attribute of the real-time event tracking monitoring or bag capture display behavior event is ios/android, you can check the corresponding user's behavior in the system-user scrutiny to determine whether the platform is ios/android in this user behavior event, and see if the event tracking triggered by H5 and the event tracking triggered by mobile end are the same user. If these two verifications are successful, then it proves that the H5 data embedded in the app is successfully connected