This article describes how to set up the Singular Events connector in your Customer Data Hub account.
In this article:
Table of Contents Placeholder
Connector Actions
Action Name |
AudienceStream |
EventStream |
Install Event |
✗ |
✓ |
Post Install Events |
✗ |
✓ |
Configure Settings
Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.
After adding the connector, configure the following settings:
- API Key: API Key is required. Clients can retrieve their API key from within their account from the Singular's portal.
Action Settings - Parameters and Options
Click Next or go to the Actions tab. This is where you configure connector actions.
This section describes how to set up parameters and options for each action.
Action - Install Event
Parameters
Parameter |
Description |
Device ID |
- At least one device identifier is required, for example:
- Advertiser Identifier (
idfa )
- Identifier for Vendor (
idfv ) for iOS apps
- Android advertising ID (
aifa ),
- Android ID (
andi ) for Android.
- Reference the following API documentation for more information.
|
Platform |
"Android" or "iOS". |
Application Name |
- Package Name (Android) or Bundle ID (iOS) of your application.
- Example:
com.mycompany.app
|
IP Address |
- IP address of the device session (with decimal points or colons).
- Both IPv4 and IPv6 are supported.
|
Device Make |
- Make of the device hardware, which is typically the consumer-facing name.
- Example: Samsung, LG, or Apple.
|
Device Model |
- Model of the device hardware.
- Example: iPhone 8, or Galaxy S10
|
Device Build |
- The build of the device, URL-encoded.
- Example:
Build%2F13D15 .
|
OS Version |
- Version of the OS on the device.
- Example: 9.2.
|
Language & Country Code |
- The IETF local tag for the device, using two-letter language and country code separated by an underscore.
- Example:
en_US .
|
Optional Parameters |
|
Action - Post Install Events
Parameters
Parameter |
Description |
Event Name |
- Name of the event to report in Singular.
- Example:
ViewItem
|
Application Name |
- Package Name (Android) or Bundle ID (iOS) of the mobile application.
- Example:
com.yourcompany.app
|
Device ID |
- At least one device identifier is required, for example:
- Advertiser Identifier (
idfa )
- Identifier for Vendor (
idfv ) for iOS apps
- Android advertising ID (
aifa ),
- Android ID (
andi ) for Android.
- Reference the following API documentation for more information.
|
Platform |
Android or iOS. |
IP Address |
- Raw IP address of the device (with decimal points or colons).
- Both IPv4 and IPv6 are supported.
|
Device Make |
- Make of the device hardware, typically the consumer-facing name.
- Example: Samsung, LG, or Apple
|
Device Model |
- Model of the device hardware.
- Example: iPhone XS, or Galaxy S10
|
Device Build |
- Build of the device, URL encoded.
- Example:
Build%2F13D15
|
OS Version |
- Version of the OS on the device.
- Example: 9.2
|
Language & Country Code |
- The IETF local tag for the device, using two-letter language and country code separated by an underscore.
- Example:
en_US
|
Optional Parameters |
|