Unreal Engine SDK - Setting a User ID

Follow
Avatar
Jared Ornstead
Updated

Setting a Custom User ID

Send your internal user ID to Singular to enable cross-device tracking and user-level data reporting across all platforms.

Note: If you use Singular's Cross-Device solution, you must collect the User ID across all platforms.

User ID Requirements

Privacy and Best Practices

Follow these guidelines when implementing user ID tracking to ensure privacy compliance and proper cross-device measurement.

  • No PII: The User ID should not expose Personally Identifiable Information (PII) such as email addresses, usernames, or phone numbers. Use a hashed value unique to your first-party data.
  • Consistency Across Platforms: The User ID value must be the same internal identifier you capture across all platforms (Web/Mobile/PC/Console/Offline) for accurate cross-device measurement.
  • First-Party Data: Singular includes the User ID in user-level exports, ETL, and Internal BI postbacks (if configured). The User ID is first-party data and is not shared with third parties.
  • Persistence: The User ID persists until explicitly unset using UnsetCustomUserId or until the app is uninstalled. Closing or restarting the app does not clear the User ID.

Best Practice: If multiple users share a single device, implement a logout flow that calls odedeSetCustomUserId on login and UnsetCustomUserId on logout.

Implementation Overview

When to Set the User ID

Use SetCustomUserId to set the user identifier and UnsetCustomUserId to clear it during logout.

If you know the user ID when the app opens, call SetCustomUserId before initializing the Singular SDK. This ensures Singular receives the User ID from the first session. However, the User ID is typically unavailable until the user registers or logs in, in which case call SetCustomUserId after the registration or authentication flow completes.

SDK Methods

Set Custom User ID

Send your internal user ID to Singular for cross-device tracking and user-level reporting.

C++ 
// Set the user ID after login or registration
FString UserId = TEXT("user_abc123xyz");
USingularSDKBPLibrary::SetCustomUserId(UserId);
UE_LOG(LogTemp, Log, TEXT("Custom user ID set: %s"), *UserId);

Method Signature: 

static void SetCustomUserId(FString customUserId);

Timing: If you know the user ID when the app opens, call SetCustomUserId before initializing the SDK. Otherwise, call it after user registration or login is complete.

Unset Custom User ID

Clear the user ID when a user logs out to ensure accurate session tracking for multi-user devices.

C++ 
// Clear the user ID on logout
USingularSDKBPLibrary::UnsetCustomUserId();
UE_LOG(LogTemp, Log, TEXT("Custom user ID has been cleared"));

Method Signature: 

static void UnsetCustomUserId();

Advanced Features

Custom User ID Device Mapping

Map the User ID to Singular's mobile device tracking identifier for server-to-server integrations.

Important: This advanced Enterprise feature is only available in exceptional cases. Consult with a Singular Solution Engineer before implementing it.

Singular can receive additional mobile event tracking data via server-to-server integration. To utilize this feature, you must map the User ID to Singular's mobile device tracking identifier.

Note: Call this method as soon as possible after initializing the Singular SDK or once you have the User ID.

Implementation

Use SetDeviceCustomUserId to set the custom user ID and map it to Singular's tracking identifier.

C++ 
// Map user ID to device identifier for S2S integration
FString UserId = TEXT("user_abc123xyz");
USingularSDKBPLibrary::SetDeviceCustomUserId(UserId);
UE_LOG(LogTemp, Log, TEXT("Device-User ID mapping set: %s"), *UserId);

Method Signature: 

static void SetDeviceCustomUserId(FString customUserId);

Description: Sets the custom user ID (same as login) and maps it to Singular's tracking identifier for server-to-server event attribution.