Version: 2020.2
LanguageEnglish
  • C#

Analytics.enabled

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static bool enabled;

Description

Controls whether the Analytics service is enabled at runtime.

Setting this property to false at runtime disables the Analytics service. You can set this property to true to re-enable Analytics service, but only if Analytics was enabled when the project was built.

If Analytics was not enabled when the project was built, you cannot use this setting to enable it at runtime.

using System;
using UnityEngine;
using UnityEngine.Analytics;

public class DataPrivacyOptInFlow { [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] static void InitStepOne() { Analytics.initializeOnStartup = false; }

public void EnableAnonymizingData() { Analytics.limitUserTracking = true; }

// Call this when the user has given permission to collect data public void UserHasOptedIntoDataCollection_LetsResumeAnalyticsInitialization() { Analytics.ResumeInitialization(); }

// Call this when the user has given limited data collection permission public void UserHasOptedIntoLimitedDataCollection_LetsResumeAnalyticsInitialization() { EnableAnonymizingData(); Analytics.ResumeInitialization(); }

// Call this when the user doesn't want any data collection. public void UserHasOptedOutOfAllDataCollection() { // Don't call ResumeInitialization // But disable Analytics so the code knows to shutdown DisableAnalyticsCompletely(); }

// If you want to disable Analytics completely during runtime public void DisableAnalyticsCompletely() { Analytics.enabled = false; Analytics.deviceStatsEnabled = false; PerformanceReporting.enabled = false; } }