This is a Platform SDK feature requiring Data Use Checkup
To use this or any other Platform SDK feature, you must complete a Data Use Checkup (DUC). The DUC ensures that you comply with Developer Policies. It requires an administrator from your team to certify that your use of user data aligns with platform guidelines. Until the app review team reviews and approves your DUC, platform features are only available for test users.
Use the User object and related APIs to retrieve information about your players to customize their experience and help them find their friends. You can also use these APIs to join players in social experiences with Group Presence.
Age-based feature limitations
When developing your apps, consider the following limitations related to age:
Child users under 13 (10-12 year olds): Regardless of your app’s self-certification status, child users under 13 cannot access this Platform SDK feature. Implement error-handling for this unsupported feature to maintain a safe and pleasant experience for child users.
Mixed-audience apps: For mixed-audience apps, Friends List API calls will return no data for users under 13, effective April 22, 2026.
User and friends
To retrieve information about the logged-in user in Unreal, use the User Get Logged In User Blueprint node from the **OvrPlatform
User** category. This is a latent (async) node that returns the user’s display name, ID, and profile image URL.
To retrieve only the user ID immediately (without an async call), use the Platform Get Logged In User ID Blueprint node from the **OvrPlatform
Platform** category. The MetaXRPlatform plugin auto-initializes as a Game Instance Subsystem, so no explicit login call is needed.
For Unreal development, you can use the Platform native API and information found in the Platform Unreal Development - Get Setup guide.
Get the User Locale
If you have localized your app content into different languages, you can detect the locale of the user at runtime using the platform SDK or native Android methods. Then, use the locale to determine what language version of your app content you offer that user.
Get the Locale of the Logged-In User
To retrieve the locale of the logged-in user in Unreal, use the Platform Get Logged In User Locale Blueprint node from the **OvrPlatform
Platform** category. This node wraps ovr_GetLoggedInUserLocale() and returns a BCP 47 locale string (for example, “en-US” for United States English).
Use the returned locale string to decide what language your app should display and use for this user.
Get the Locale of a User for Android Apps
Quest devices run Android as their underlying operating system. If your app accesses native Android APIs directly, you can retrieve the locale using the Android Locale.getDefault method.
The returned Locale object provides the ISO 639 alpha-2 or alpha-3 language code and the ISO 3166 alpha-2 country/region code as properties, and you can use these to decide what language your app should display and use for this user.
See the Locale object in the Android documentation for more information.