Settings for the Google Analytics Measurement Protocol plugin. More...

#include <GAMPSettings.h>

Inheritance diagram for UGoogleAnalyticsMPSettings:

Public Member Functions
bool	IsGAMPDefaultProvider () const
	Returns true if GAMP is configured as the default analytics provider, false otherwise. More...

void	SetupGAMPAsDefaultProvider () const
	Setup the GAMP as the default analytics provider. More...

	UGoogleAnalyticsMPSettings ()
	constructor More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="CPU Brand (+)")) FString CPUBrandCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the running CPU Brand to events (as returned by `FPlatformMisc::GetCPUBrand()`). More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="GPU Brand (+)")) FString GPUBrandCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the running GPU Brand to events (as returned by `FPlatformMisc::GetPrimaryGPUBrand()`). More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="OS Version (++)")) FString OSVersionCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the running OS Version to events (as returned by `FPlatformMisc::GetOSVersion()`). More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="Platform Name (++)")) FString PlatformNameCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the running Platform Name to events (as returned by `FPlatformProperties::IniPlatformName()`). More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="Project Name (+)")) FString ProjectNameCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the Project Name to events. More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="Project Version (++)")) FString ProjectVersionCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the ProjectVersion to events. More...

	UPROPERTY (config, EditAnywhere, Category="Runtime Settings\|Automatic Event Dimensions", meta=(DisplayName="System Message (++)")) FString SystemMessageCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add useful messages to some events (e.g the message of an error/exception). More...

	UPROPERTY (EditAnywhere, Category="Build Configuration Settings", meta=(DisplayName="PIE (Play-In-Editor)", FullyExpand=true)) FGoogleAnalyticsMPBuildSettings PIEConfiguration
	Settings for PIE (Play In Editor). More...

Public Attributes
TSubclassOf< class UGoogleAnalyticsMPAttributesFilter >	AttributesFilterClass = nullptr
	Optional class to manipulate the set of attributes sent with each logged event. More...

bool	bAutoInstrumentation = true
	Auto-instrumentation of the game/application (see the doc to know more about what is instrumented). More...

bool	bAutoSessionHandling = true
	Automatically start the analytics session when the application starts and close it when the application ends. More...

bool	bDebugEndpointEnabled = false
	Enable the auxiliary debug features for the selected protocol. More...

bool	bOptOutDefault = false
	The initial default value of the "opt-out" property. More...

bool	bPersistentUserID = true
	Save any set User ID in the persistent storage. More...

FString	BuildInfoCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the Build Info to events (as set by `IAnalyticsProvider::SetBuildInfo()`). More...

FGoogleAnalyticsMPBuildSettings	DebugConfiguration
	Settings for the Debug build configuration. More...

FGoogleAnalyticsMPBuildSettings	DevelopmentConfiguration
	Settings for the Development build configuration. More...

FString	EventLabelCustomDimension
	If set, this Custom Dimension is used by the plugin as a generic event "label" for some events used by IAnalyticsProvider. More...

FString	EventValueCustomMetric
	If set, this Custom Metric is used by the plugin as a generic event "value" for some events used by IAnalyticsProvider. More...

float	KeepAliveTimeInMinutes = 10
	Ensure proper session duration tracking, sending a "keep alive" event to the backend every X minutes. More...

FString	ProjectIDCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the ProjectID to events. More...

FGoogleAnalyticsMPBuildSettings	ReleaseConfiguration
	Settings for the Release build configuration. More...

FGoogleAnalyticsMPBuildSettings	TestConfiguration
	Settings for the Test build configuration. More...

FString	UserBirthyearCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the User Birth of Year to events. More...

FString	UserGenderCustomDimension
	If set, this Custom Dimension is used by the plugin to automatically add the User Gender to events. More...

Protected Member Functions
virtual void	ReadConfigSettings () override
	Provides a mechanism to read the section based information into this UObject's properties. More...

virtual void	WriteConfigSettings () override
	Provides a mechanism to save this object's properties to the section based ini values. More...

Detailed Description

Settings for the Google Analytics Measurement Protocol plugin.

Constructor & Destructor Documentation

◆ UGoogleAnalyticsMPSettings()

UGoogleAnalyticsMPSettings::UGoogleAnalyticsMPSettings ( )

constructor

Member Function Documentation

◆ IsGAMPDefaultProvider()

bool UGoogleAnalyticsMPSettings::IsGAMPDefaultProvider ( ) const

Returns true if GAMP is configured as the default analytics provider, false otherwise.

◆ ReadConfigSettings()

virtual void UGoogleAnalyticsMPSettings::ReadConfigSettings ( )

overrideprotectedvirtual

Provides a mechanism to read the section based information into this UObject's properties.

◆ SetupGAMPAsDefaultProvider()

void UGoogleAnalyticsMPSettings::SetupGAMPAsDefaultProvider ( ) const

Setup the GAMP as the default analytics provider.

◆ UPROPERTY() [1/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="CPU Brand (+)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add the running CPU Brand to events (as returned by FPlatformMisc::GetCPUBrand()).

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details.

◆ UPROPERTY() [2/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="GPU Brand (+)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add the running GPU Brand to events (as returned by FPlatformMisc::GetPrimaryGPUBrand()).

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details.

◆ UPROPERTY() [3/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="OS Version (++)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add the running OS Version to events (as returned by FPlatformMisc::GetOSVersion()).

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. We suggest to configure this option.

◆ UPROPERTY() [4/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="Platform Name (++)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add the running Platform Name to events (as returned by FPlatformProperties::IniPlatformName()).

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. We suggest to configure this option.

◆ UPROPERTY() [5/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="Project Name (+)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add the Project Name to events.

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. If multiple products send data to the same analytics property, then we suggest to configure this option.

◆ UPROPERTY() [6/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="Project Version (++)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add the ProjectVersion to events.

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. We suggest to configure this option.

◆ UPROPERTY() [7/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	config	,
		EditAnywhere	,
		Category	= `"Runtime Settings\|Automatic Event Dimensions"`,
		meta	= `(DisplayName="System Message (++)")`
	)

If set, this Custom Dimension is used by the plugin to automatically add useful messages to some events (e.g the message of an error/exception).

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. We suggest to configure this option.

◆ UPROPERTY() [8/8]

UGoogleAnalyticsMPSettings::UPROPERTY	(	EditAnywhere	,
		Category	= `"Build Configuration Settings"`,
		meta	= `(DisplayName="PIE (Play-In-Editor)", FullyExpand=true)`
	)

Settings for PIE (Play In Editor).

◆ WriteConfigSettings()

virtual void UGoogleAnalyticsMPSettings::WriteConfigSettings ( )

overrideprotectedvirtual

Provides a mechanism to save this object's properties to the section based ini values.

Member Data Documentation

◆ AttributesFilterClass

TSubclassOf<class UGoogleAnalyticsMPAttributesFilter> UGoogleAnalyticsMPSettings::AttributesFilterClass = nullptr

Optional class to manipulate the set of attributes sent with each logged event.

A custom filter can be used, for example, to add Custom Dimensions and Metrics to each logged event.

See also: UGoogleAnalyticsMPAttributesFilter

◆ bAutoInstrumentation

bool UGoogleAnalyticsMPSettings::bAutoInstrumentation = true

Auto-instrumentation of the game/application (see the doc to know more about what is instrumented).

◆ bAutoSessionHandling

bool UGoogleAnalyticsMPSettings::bAutoSessionHandling = true

Automatically start the analytics session when the application starts and close it when the application ends.

If false, you must manage the session duration manually calling the methods UGoogleAnalyticsMPStatics::StartSession() and UGoogleAnalyticsMPStatics::EndSession().

◆ bDebugEndpointEnabled

bool UGoogleAnalyticsMPSettings::bDebugEndpointEnabled = false

Enable the auxiliary debug features for the selected protocol.

This feature is automatically disabled in Shipping build configuration.

For all protocols:

Logged events are visible in the real-time DebugView of Google Analytics back-end.

For Universal protocol:

A copy of logged events is sent to the Google Analytics debug endpoint.
Detected errors and warnings are logged into the output console.

◆ bOptOutDefault

bool UGoogleAnalyticsMPSettings::bOptOutDefault = false

The initial default value of the "opt-out" property.

If true, no data to Google Analytics are sent and calls to log events are silently ignored.

See also: UGoogleAnalyticsMPStatics::SetOptOut()

◆ bPersistentUserID

bool UGoogleAnalyticsMPSettings::bPersistentUserID = true

Save any set User ID in the persistent storage.

Note that Google suggest to set this to false. If false, you must provide the User ID at every launch of the application calling the method. UGoogleAnalyticsMPStatics::SetUserID().

◆ BuildInfoCustomDimension

FString UGoogleAnalyticsMPSettings::BuildInfoCustomDimension

If set, this Custom Dimension is used by the plugin to automatically add the Build Info to events (as set by IAnalyticsProvider::SetBuildInfo()).

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details.

◆ DebugConfiguration

FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::DebugConfiguration

Settings for the Debug build configuration.

◆ DevelopmentConfiguration

FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::DevelopmentConfiguration

Settings for the Development build configuration.

◆ EventLabelCustomDimension

FString UGoogleAnalyticsMPSettings::EventLabelCustomDimension

If set, this Custom Dimension is used by the plugin as a generic event "label" for some events used by IAnalyticsProvider.

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. If you use the IAnalyticsProvider, then we suggest to configure this option.

See also: EventValueCustomMetric

◆ EventValueCustomMetric

FString UGoogleAnalyticsMPSettings::EventValueCustomMetric

If set, this Custom Metric is used by the plugin as a generic event "value" for some events used by IAnalyticsProvider.

You have to configure a proper Custom Metric (Event scope, Standard unit of measurement) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details. If you use the IAnalyticsProvider, then we suggest to configure this option.

See also: EventLabelCustomDimension

◆ KeepAliveTimeInMinutes

float UGoogleAnalyticsMPSettings::KeepAliveTimeInMinutes = 10

Ensure proper session duration tracking, sending a "keep alive" event to the backend every X minutes.

Set to zero to disable this feature.

See also: for GA4: https://support.google.com/analytics/answer/9191807; for UA: https://support.google.com/analytics/answer/2731565?hl=en.

◆ ProjectIDCustomDimension

FString UGoogleAnalyticsMPSettings::ProjectIDCustomDimension

If set, this Custom Dimension is used by the plugin to automatically add the ProjectID to events.

You have to configure a proper Custom Dimension (Event scope) in your backend and copy and paste here what you have set in the Event Parameter name. See https://support.google.com/analytics/answer/14240153?hl=en for details.

◆ ReleaseConfiguration

FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::ReleaseConfiguration

Settings for the Release build configuration.

◆ TestConfiguration

FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::TestConfiguration

Settings for the Test build configuration.

◆ UserBirthyearCustomDimension

FString UGoogleAnalyticsMPSettings::UserBirthyearCustomDimension

If set, this Custom Dimension is used by the plugin to automatically add the User Birth of Year to events.

You have to configure a proper Custom Dimension (User scope) in your backend and copy and paste here what you have set in the User Property name. See https://support.google.com/analytics/answer/14240153?hl=en for details.

◆ UserGenderCustomDimension

FString UGoogleAnalyticsMPSettings::UserGenderCustomDimension

If set, this Custom Dimension is used by the plugin to automatically add the User Gender to events.

You have to configure a proper Custom Dimension (User scope) in your backend and copy and paste here what you have set in the User Property name. See https://support.google.com/analytics/answer/14240153?hl=en for details.

The documentation for this class was generated from the following file:

GoogleAnalyticsMP/Public/GAMPSettings.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ UGoogleAnalyticsMPSettings()

Member Function Documentation

◆ IsGAMPDefaultProvider()

◆ ReadConfigSettings()

◆ SetupGAMPAsDefaultProvider()

◆ UPROPERTY() [1/8]

◆ UPROPERTY() [2/8]

◆ UPROPERTY() [3/8]

◆ UPROPERTY() [4/8]

◆ UPROPERTY() [5/8]

◆ UPROPERTY() [6/8]

◆ UPROPERTY() [7/8]

◆ UPROPERTY() [8/8]

◆ WriteConfigSettings()

Member Data Documentation

◆ AttributesFilterClass

◆ bAutoInstrumentation

◆ bAutoSessionHandling

◆ bDebugEndpointEnabled

◆ bOptOutDefault

◆ bPersistentUserID

◆ BuildInfoCustomDimension

◆ DebugConfiguration

◆ DevelopmentConfiguration

◆ EventLabelCustomDimension

◆ EventValueCustomMetric

◆ KeepAliveTimeInMinutes

◆ ProjectIDCustomDimension

◆ ReleaseConfiguration

◆ TestConfiguration

◆ UserBirthyearCustomDimension

◆ UserGenderCustomDimension