After you have integrated the Singular SDK/S2S into your app, it's important to make sure it works correctly before you go live with the new version of the app.
Singular offers two main tools for testing your integration: an audit report, which automatically identifies any issues in your integration, and the SDK console, which allows you to manually test the different features you have implement as you implement them.
The following guide will get you started with both tools.
|Prerequisites||Have the Singular SDK or S2S implemented for an app. To use the SDK Console, you will need a mobile device to test with.|
Automatic Testing: Running an SDK Audit
Singular offers an SDK audit report that tests your SDK and S2S integrations to see if they are correctly implemented. The audit outputs a list of all the issues that it finds, with tips for how to solve them. To use the SDK audit report:
Run an SDK Audit Report
Go to Settings > SDK Console and click Audit your SDK integration in the top right corner.
Download and Read the Report
Once the report finishes running, you'll be able to download it in CSV format.
The report is a list of issues that have been found in your SDK and S2S integrations. Not all issues are critical, and some may not be relevant for you (because they pertain to SDK features you have chosen not to implement). For more about how the report is built, see How do I read the SDK audit report?
Fix the Relevant Issues
Go over the issues in the report and fix them according to the tips in the Error Description field.
Note: For warning/info type issues, make sure to check the Validation Name and see whether this is an optional SDK feature that you have chosen not to implement, such as deferred deep linking (DDL). If so, you can ignore the error message.
Manual Testing Using the SDK Console
- Use these testing steps in combination with the SDK auditing tool to make sure your SDK/S2S implementation is functioning correctly.
- You can also use the SDK console to test features one by one as you implement them (before you've completed the entire integration).
For general questions about the SDK console, see the SDK Console FAQ.
Add a Test Device
To add a device to the console:
Ensure Device Appears in Tracked Devices List
The device has to be in enabled mode (the eye icon on the left should not be disabled) for any events from the device to appear in the Events Log.
You can add a descriptive name for the device in the Device Name column to make sure you don't confuse it with other devices you may be tracking.
Test Initialization and Sessions
The first thing to test is whether your integration is initializing and sending information to Singular. This already allows Singular to start tracking attribution for this app! To check, look for user sessions in the event log.
To test initialization:
If this row does not show up, check the user-level logs for the session event. It is possible you opened the app before the SDK console finished processing the registration of the new device.
[iOS] Test Apple iAd Referrer
On iOS devices, Singular should be receiving the iAd Attribution data. To validate it, after having added a device to the console and installed the app on it, check the SDK console and confirm that “__iAd_Attribution__” event shows up.
Test Custom User ID
If your SDK integration sends a custom user ID to Singular, here's how to test it.
If the user ID does not show up:
If you've implemented event tracking or revenue tracking in your SDK integration, follow the instructions below to test them.
For more about events, see:
For every event you've implemented in your SDK integration:
If the event does not show up, it is possible the app was opened before the device was completely registered in the SDK console. Check the attribution logs for the event.
For each type of revenue event you've implemented in your SDK integration:
Test Deep Linking
If you've implemented deep linking in your SDK integration, follow the instructions below to test your deep linking functionality.
Note: This article assumes your organization is using Singular Links - Singular's new tracking link technology, launched in 2019. Older customers of Singular may be using Singular's older tracking links (legacy links).
1. Set Up a Test Destination
In the Singular platform, go to Settings > Apps, find the app, and add a deep link destination.
The destination should be one of the deep link destinations that the handler code in your SDK integration can recognize and handle.
Now that you have a destination to link to, you can create a deep link.
To test the link:
Alternative way to test the link (Android only):
Open a command-line terminal on your computer to trigger a deep-link:
When my app is already running, a deep link opens a new instance of the app instead of switching to the existing one.
To avoid this situation, edit your manifest file and add the following to your activity:
See Google's <activity> documentation for more information about launchMode options.
Test Deferred Deep Linking
Test Uninstall Tracking
If you've implemented uninstall tracking in your SDK integration, follow the instructions below to test it.
Testing uninstall tracking is more complicated than testing other SDK functions, because Singular depends on Google/iOS services to report the uninstall, and the process takes some time. You can't see the uninstall event in the Singular platform in real time, and you can't use the SDK console for it.
Also, double-check that you have entered your FCM Server Key (for Android) or your iOS Push Certificate in the App Configuration page.
To test uninstall tracking:
Note: While you are waiting to validate the uninstall event, don't reset the device ID and don't reinstall the app.