About User Reporting
User Reporting is a service that collects bug reports or feedback from your players during development. A report includes a collection of name/value pairs, screenshots, or optional attachments you can use to analyze issues and feedback about your game.
In your app you can use built-in reporting, build customized reports, or use a combination of both. The built-in functionality provides a form that your users fill out and submit with a title, description, and screenshot. If you build your own reports, you can design the form to collect any specific data you need. You can adjust which types of reports you collect from users. You don’t need to display a form to capture information for a report, as you can configure automatic user reports.
Benefits of user reports
- Capture in-game bug reports or general feedback from your players.
- Include custom fields such as a title, summary, and attachments.
- Analyze device metadata, events, metrics, and screenshots.
- Add filters to search reports as dimensions.
- Get direct information to streamline player feedback.
- Integrate with tools like your email, Slack, or JIRA to receive notifications when a new report arrives.
Reporting overhead
User Reporting doesn’t allocate resources and has negligible overhead when idle. When it runs, most reporting operations also have a negligible impact on performance. However, screenshots use data and might impact performance.
Memory usage is directly related to the limits set when configuring a user report.
User Reporting and Compliance with PIPL
From November 1 2021, a new data privacy law came into effect from the People's Republic of China (hereinafter “China”) . The new law, known as Personal Information Protection Law (or PIPL), is a data privacy law passed by China’s National People’s Congress to protect the data privacy of people based in China. Game players located in China are now required to consent (“Opt-In”) to having their personal information transferred and processed or transferred outside of China. Read more on PIPL.
How PIPL impacts User Reporting
To respect user privacy, the User Reporting SDK now includes the following changes:
- For the User Reporting page, Unity no longer provides “DeviceUniqueIdentifier” in metadata.
- Support has been deprecated for the User Reporting SDK for Unity 2017.1 to 2018.2.
Actions you need to take
We’ve updated the User Reporting SDK to implement these changes. If you already use User Reporting, upgrade to the latest SDK as of November 2021. If you install the User Reporting SDK for the first time, the User Reporting SDK version is compatible with PIPL as of November 2021.
What’s next?
- Learn how to configure user reports in your game. See Setting up User Reporting.
- Learn how to configure custom user reports in your game. See Configuring User Reporting.
- Learn how to access and view user reports from the Dashboard. See Understanding User Reporting.