Using the SDK Console

 

The SDK console is a tool you can use to test whether your SDK or server-to-server integration is communicating with Singular properly.

After you add a test device to the console (by providing its ID), the console shows you whether your app is sending the information that Singular needs in order to attribute installs, track events, etc.

We recommend using this article to get familiar with the SDK console before you start following the testing guides.

Adding a Test Device

To add a device to the console:

  1. In the Singular platform, go to Settings > SDK Console.
  2. Click Add Device and select the platform of the device you are adding, and then select the keyspace (i.e., the type of advertising ID):

    Platform Possible Keyspaces
    iOS IDFA
    Android Google Advertising ID (AIFA)
    Android ID (ANDI)
  3. Input the ID from your device and click Add.

    image11.png

    Note: Your device's advertising ID should be available in your device's Settings menu. Singular also offers a Device Assist application that you can install on your test devices to help you acquire the device IDs. Download our app for iOS or for Android.
  4. Make sure the new device appears in the 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.

      image12.png

Reading the Event Log

After you've registered a device, the events sent from the device start appearing in the event log:

image8.png

Note: If no events from the device are appearing, make sure the device is enabled in the Tracked Devices list (the eye icon is not disabled):

screenshot-app.singular.net-2020.02.14-19-23-49.png

Click on a row to show the full details of the event as sent from the app:

image9.png

Removing a Device

To delete a device, hover over the Device ID and click Delete. This will clear all event logs from the screen, but will not clear the attribution.

Resetting a Device and Clearing the Install Attribution

If you want to re-test your SDK integration again with the same device, you have to remove all locally cached data from the device, in addition to clearing the device's attribution in the Singular platform.

Steps for Android Devices

  1. Close the app and confirm that it is not running (use Force Stop from the Settings menu if you have the option).
  2. Go to the Settings menu by tapping the wheel icon in your notification window or in the Apps menu.
  3. Go to Apps, select the app you are testing, long press on the app and select App Info.
  4. Select Storage and then select Clear Cache and Clear Data.
  5. In the Singular SDK Console, hover over the device row and click Forget to have our system forget this device attribution.

    image5.png

Note: Google Play offers apps that perform this function for you (see example).

Steps for iOS Devices

  1. Close the app and then uninstall.
  2. Open the SDK Console and click Forget to have our system forget this device attribution.

    image5.png

 

Was this article helpful?