Integrating the Singular SDK

You can easily integrate the Singular SDK within your app using our SDK documentation.

Find all the tools for building the integration under Settings > SDK Keys.

SDK Key

This key is necessary for the Singular servers to identify your account.

image3.png

Developer Account

Use a developer account during the development and QA process in order to keep your main account data clean. You can find your Developer Account credentials in the SDK Keys page, as in the following example.

image4.png

The developer account contains a separate SDK key that can be used in development versions of your app.

image2.png

Important: Remember to switch to the main SDK Key before deploying to the App Store.

Available SDKs

We currently provide 4 ways to integrate with Singular:

 

SDK Console

The SDK Console displays calls for session and event data sent by the Singular SDK or direct use of the Singular Server to Server API. It is a tool for application developers to verify if their instrumented events and sessions are being received by the Singular platform.

Adding Devices

To add a device:

  1. Select the Platform and Keyspace of the device that you want to test
  2. Insert the identifier and click "Add"

https___staging01_singular_net__user_rovio_dev_rovio_com__tracking_events.png

Once the Device is added, the event logs will start collecting data. You can view event logs for multiple devices at once by selecting the Show/Hide Button:

SDK_Console_Preview_Mode_-_InVision.png

Note: you can add up to 20 devices at once.

Deleting Devices and Clearing Attribution

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

To clear a device's attribution, select the Forget button. This will reset the attribution for a specific device so you can retest with the same device.

SDK_Console_Preview_Mode_-_InVision.png

Using the Console

Once a device is registered, events trigged in the app via the SDK will appear in the console . You can drill down on a specific line item to view more details:

SDK_Console_History_Mode_-_InVision.png

Automatically Tracked Events

Aside from your explicitly tracked sessions and events, there are some events that are tracked automatically by the SDK and may become useful in debugging/understanding the data in some scenarios:

SDK Event Name Description
__installReferrer__ Android Only - This event contains the payload of the Android install referrer (when available). If the Android install referrer is implemented, this event is automatically sent shortly after the Android SDK initialization. This event is used as part of the Singular attribution process.
__iAd_Attribution__ iOS Only - This event contains the payload of the Apple Search Ads API response (when available). This event is sent shortly after the Android SDK initialization. This event is used as part of the Singular attribution process.

 

Questions? For additional information, contact support@singular.net.

Was this article helpful?
0 out of 0 found this helpful