Complete Configuration Example

Comprehensive SDK Configuration

The following example demonstrates how to configure the Singular SDK with multiple options. Configuration can be done through the Unity Inspector on the SingularSDKObject GameObject.

SingularSDKObject Inspector Panel

Branded Domains

Sets branded domains for web-to-app attribution. This allows the Singular SDK to recognize the custom tracking domain and allowing for opening the app.

Usage Example

yourcompany.com

go.yourcompany.com

promo.yourcompany.com

Clipboard Attribution

Use this checkbox to enable clipboard attribution for iOS. When enabled, the SDK reads the clipboard on app launch to detect attribution links. iOS only.

Collect OAID

Check this box to enables collection of OAID (Open Anonymous Device Identifier) on Android devices. OAID is used as an alternative identifier in regions where Google Advertising ID is not available. Android only.

Ddl Timeout Sec

Sets the timeout in seconds for deferred deep link resolution. This determines how long the SDK will wait for a deferred deep link before continuing with initialization. Default value is 60 seconds.

Enable Logging

Check this box to enable SDK logging. When enabled, the SDK will output debug information to help with integration and troubleshooting. Should be disabled in production builds.

Enable ODM With Timeout Interval

Enables ODM (On-Device Matching) with a specified timeout interval in seconds. ODM allows for more accurate attribution by matching device fingerprints. Set to -1 to disable. iOS only.

Facebook App Id

Sets the Facebook App ID for Facebook attribution integration. This enables the SDK to track Facebook campaign attribution. Android only.

Initialize On Awake

Determines whether the SDK should automatically initialize when the GameObject awakes. When set to false, you must manually call InitializeSingularSDK() to initialize the SDK.

Limit Advertising Identifiers

Enables limited advertising identifiers mode in mixed audience apps. This option affects how the SDK collects and uses device identifiers for tracking. If enabled, the Advertising Identifiers will not be collected.

Log Level

Sets the log level for SDK logging. Valid values are: 0 (None), 1 (Error), 2 (Warning), 3 (Info/Debug), 4 (Verbose). Higher values provide more detailed logging output.

Manual SKAN Conversion Management

Enables manual SKAdNetwork conversion value management. When enabled, you must manually update conversion values using SkanUpdateConversionValue(). iOS only.

Push Notifications Link Paths

Specifies the JSON paths where deep link URLs can be found in push notification payloads. This enables the SDK to extract and process deep links from push notifications. iOS only.

notification/deep_link

data/url

custom_link

Session Timeout Sec

Sets the session timeout in seconds. This determines how long a user session lasts after the app goes to the background. Default value is 60 seconds.

Shortlink Resolve Timeout

Sets the timeout in seconds for short link resolution. This determines how long the SDK will wait for a short link to be resolved. Default value is 10 seconds.

Singular API Key

Sets the Singular API Key for your application. This is a required configuration value that identifies your app to the Singular platform. You can find your API Key in the Singular dashboard.

Singular API Secret

Sets the Singular API Secret for your application. This is a required configuration value used alongside the API Key for secure communication. You can find your API Secret in the Singular dashboard.

SKAN Enabled

Enables or disables SKAdNetwork functionality. When enabled, the SDK will automatically register for SKAdNetwork attribution and manage conversion values. iOS only.

Wait For Tracking Authorization With Timeout Interval

Sets the timeout in seconds to wait for ATT (App Tracking Transparency) authorization before initializing the SDK. Set to 0 to not wait. iOS only.