Analytics Provider Configuration

Table of Contents

• Analytics Provider Configuration
  • Manual Configuration
    • Accessing the Configuration File
    • Registering Analytics Providers
    • Setting Up Google Analytics Measurement Protocol
    • Restart Unreal Engine
  • Example Configuration

Analytics Provider Configuration

The Google Analytics Measurement Protocol plugin integrates into Unreal Engine as a standard Analytics Provider. Integration is achieved through standard registration procedures outlined by Unreal Engine documentation.

The plugin offers a straightforward option to automatically set itself as the default Analytics Provider for your project:

Automatic configuration of the plugin

For advanced requirements or limitations where automatic configuration is inappropriate, manual configuration is necessary. In these cases, refer to the official Unreal Engine documentation.

Manual Configuration

To manually integrate the Google Analytics Measurement Protocol plugin as your project's analytics provider, follow the steps below.

Accessing the Configuration File

To configure the Analytics Providers, you must edit the project configuration file located at <PROJECT_ROOT>\Config\DefaultEngine.ini. Before editing the file, please familiarize yourself with the Unreal Engine configuration file syntax. In particular, ensure no unnecessary spaces are present around section names, key names, “=” symbols, or values.

Registering Analytics Providers

You must first register the default analytics provider within the [Analytics] section.

Optionally, for varied configurations across different build types (e.g., development, testing, Play-In-Editor/PIE), utilize the corresponding sections such as [AnalyticsDevelopment], [AnalyticsTest], [AnalyticsPIE], etc.

Setting Up Google Analytics Measurement Protocol

To manually configure the plugin across all relevant sections:

1. Define the Provider Module Name:
   • set ProviderModuleName to GoogleAnalyticsMP
2. Establish the Protocol to use:
   • set GAMP_Protocol based on the analytics service:
     • use GA4_gtag for Google Analytics 4
     • use UNIVERSAL_ANALYTICS_V1 for Google Universal Analytics
3. Specify the Measurement or Tracking ID:
   • assign GAMP_TrackingID with your specific Measurement ID/Tracking ID matching the chosen protocol.

Restart Unreal Engine

After making and saving your changes, restart Unreal Engine for them to take effect.

Example Configuration

Below is an example where the Google Analytics 4 (GA4) protocol is configured with a common Measurement ID G-1234567890 for all build types. It is crucial to replace G-1234567890 with your actual Measurement ID.

[Analytics]
ProviderModuleName=GoogleAnalyticsMP
GAMP_Protocol=GA4_gtag
GAMP_TrackingID=G-1234567890
 
[AnalyticsDebug]
ProviderModuleName=GoogleAnalyticsMP
GAMP_Protocol=GA4_gtag
GAMP_TrackingID=G-1234567890
 
[AnalyticsTest]
ProviderModuleName=GoogleAnalyticsMP
GAMP_Protocol=GA4_gtag
GAMP_TrackingID=G-1234567890
 
[AnalyticsDevelopment]
ProviderModuleName=GoogleAnalyticsMP
GAMP_Protocol=GA4_gtag
GAMP_TrackingID=G-1234567890
 
[AnalyticsPIE]
ProviderModuleName=GoogleAnalyticsMP
GAMP_Protocol=GA4_gtag
GAMP_TrackingID=G-1234567890

Ensure that settings align with your project's analytics requirements for accurate data tracking across different stages of development and deployment.