Integration with Singular

Glossary

Singular

Mobile attribution and marketing analytics platform. Singular enables application developers, marketers, and brands to track, measure, and optimize the effectiveness of their marketing campaigns across various channels and devices to drive faster growth with smarter ROI insights.

Refer to the Singular documentation for detailed information about the platform.

Application ID

Mobile application ID unique for each platform (Android, iOS). It corresponds to the Bundle ID value that you can find in Singular in the Settings > Apps section, in the pane of a necessary application.

In-app event

User action within the application. Refer to the Singular documentation for detailed information about the in-app events. User actions in Web Shop are also considered in-app events in the case of S2S integration and sent to Singular from the Xsolla backend.

User acquisition

The process of attracting new users to a site, service, platform, or application through marketing activity.

Retargeting

Reaching out to current or past users through advertising campaigns. Refers to the strategy of engaging users who have previously interacted with your application or site. Refer to the Singular documentation for detailed information.

Customer user ID (CUID)

User ID generated and set by the application owner at the time of user registration. The СUID should be the same for Web Shop and Singular. This parameter is used for user matching and attribution.

Notice

You need to pass this parameter in the postback. If CUIDs in the Web Shop and your mobile application don’t match, contact your Customer Success Manager or email to csm@xsolla.com to implement the User validation in Web Shop webhook or authentication via a deep link.

Postback

Process of receiving data on in-app events. Refer to the Singular documentation for detailed information.

SDK key

Token that is used to authorize calls for sending event data to Singular. It’s generated on the Singular side. Refer to the Singular documentation for detailed information.

Integration flow

Singular and Xsolla support mobile application S2S integration that allows you to measure and evaluate the effectiveness of user acquisition and retargeting campaigns for attracting traffic to Web Shop. Xsolla sends information about Web Shop purchases to Singular as mobile in-app events, which Singular then attributes to the corresponding source.

You can configure mobile application integration to get advanced event analytics if you:

• have a mobile application for Android/iOS
• use Singular
• use Web Shop solution to sell in-game items

The following event is available via the Xsolla and Singular S2S integration:

How it works

The integration includes a bidirectional data flow between Xsolla and Singular. Below is the system interaction scenario when a user makes a purchase.

  %%{init: {'themeVariables': { 'noteBkgColor': 'transparent', 'noteBorderColor': 'transparent', 'noteTextColor': '#495C6B' }}}%%
sequenceDiagram
    participant User
    participant Mobile App
    participant Web Shop
    participant Xsolla Backend
    participant Singular
    User->>Mobile App: 1. Logs in
    Mobile App->>Singular: 2. Sends CUID
    Singular->>Xsolla Backend: 3. Sends postback
    User->>Web Shop: 4. Logs in using CUID
    User->>Web Shop: 5. Makes a purchase
    Web Shop->>Xsolla Backend: 6. Sends purchase event
    Xsolla Backend->>Singular: 7. Sends xsolla-billing-payment event

1. The user (player) signs up or logs in to the mobile application.
2. Your application sends an in-app event to Singular, for example, login, or any other event that includes the CUID.
3. Singular sends a postback to Xsolla, which includes the CUID and other data about the user device.
4. The user logs into Web Shop using the CUID.
5. The user makes a purchase in Web Shop.
6. The purchase event is sent to the Xsolla server and matched with the data received from Singular.
7. Xsolla’s server sends an in-app event to Singular, which contains parameters required for mapping.

Singular attributes a new event, purchase, and revenue back to the media source that drove the user acquisition or the user re-engagement.

How to set up in Publisher Account

1. Open your project in the Publisher Account and go to the Integrations section.
2. Click the Singular pane.

3. In the Mobile app S2S integration pane, click Configure.
4. In the window that opens, make sure that the Enable this integration box is checked.
5. Provide the following data:
   1. Singular SDK key.
   2. Application ID, unique for each platform (Android/iOS). To add a platform, click Add application ID.
6. Click Save.
7. Enable the integration in Singular.

Once you save the settings, a green indicator will be displayed on the S2S integration pane.

To make changes to the connected integration:

1. Click the Singular pane.
2. In the window that opens, make the necessary changes.
3. Click Save.

How to set up in Singular

In Singular, you need to:

1. Get an SDK key.
2. Activate the integration with Xsolla.

Get SDK key

1. Log in to your Singular account.
2. Open the Developer Tools > SDK Integration section.
3. Go to the SDK Keys tab.
4. Click Show Keys.
5. Copy the value in the SDK Key field.

Activate integration with Xsolla

1. Log in to your Singular account.
2. Go to the Attribution Setup > Partner Configuration section.
3. Click Add Partner.
4. In the search bar, enter and select Xsolla.

5. In the window that opens, select an application for which you configure integration.
6. Click Next.
7. Make sure that in the Events Postbacks block, the Login event is selected.
8. Click Save.

Event value structure

If you want to set up a specific event or if the current integration options don’t cover your needs, contact your Customer Success Manager or email to csm@xsolla.com.

Item purchase

When a user makes a purchase in Web Shop, Xsolla sends the xsolla-billing-payment event to Singular. The following purchase information is passed in the event parameters:

Additional data

In addition to parameters passed in the xsolla-billing-payment event, Xsolla sends the following data: