Google Analytics Measurement Protocol 1.1.2
Google Analytics plugin for Unreal Engine, using a native cross-platform implementation of the Measurement Protocol.
|
Settings for the Google Analytics Measurement Protocol plugin. More...
#include <GAMPSettings.h>
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... | |
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 |
Send a copy of logged events to the Google Analytics debug endpoint. 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... | |
FGoogleAnalyticsMPBuildSettings | DebugConfiguration |
Settings for the Debug build configuration. More... | |
FGoogleAnalyticsMPBuildSettings | DevelopmentConfiguration |
Settings for the Development build configuration. More... | |
float | KeepAliveTimeInMinutes = 10 |
Ensure proper session duration tracking, sending a "keep alive" event to the backend every X minutes. More... | |
FGoogleAnalyticsMPBuildSettings | PIEConfiguration |
Settings for PIE (Play In Editor). More... | |
FGoogleAnalyticsMPBuildSettings | ReleaseConfiguration |
Settings for the Release build configuration. More... | |
FGoogleAnalyticsMPBuildSettings | TestConfiguration |
Settings for the Test build configuration. More... | |
Protected Member Functions | |
virtual void | ReadConfigSettings () |
Provides a mechanism to read the section based information into this UObject's properties. More... | |
virtual void | WriteConfigSettings () |
Provides a mechanism to save this object's properties to the section based ini values. More... | |
Settings for the Google Analytics Measurement Protocol plugin.
UGoogleAnalyticsMPSettings::UGoogleAnalyticsMPSettings | ( | ) |
constructor
bool UGoogleAnalyticsMPSettings::IsGAMPDefaultProvider | ( | ) | const |
Returns true if GAMP is configured as the default analytics provider, false otherwise.
|
protectedvirtual |
Provides a mechanism to read the section based information into this UObject's properties.
void UGoogleAnalyticsMPSettings::SetupGAMPAsDefaultProvider | ( | ) | const |
Setup the GAMP as the default analytics provider.
|
protectedvirtual |
Provides a mechanism to save this object's properties to the section based ini values.
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.
bool UGoogleAnalyticsMPSettings::bAutoInstrumentation = true |
Auto-instrumentation of the game/application (see the doc to know more about what is instrumented).
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().
bool UGoogleAnalyticsMPSettings::bDebugEndpointEnabled = false |
Send a copy of logged events to the Google Analytics debug endpoint.
Useful to debug/validate the logged events. Detected errors and warnings are logged into the output console. This feature is automatically disabled in Shipping build configuration.
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.
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().
FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::DebugConfiguration |
Settings for the Debug build configuration.
FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::DevelopmentConfiguration |
Settings for the Development build configuration.
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 https://support.google.com/analytics/answer/2731565?hl=en for details.
FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::PIEConfiguration |
Settings for PIE (Play In Editor).
FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::ReleaseConfiguration |
Settings for the Release build configuration.
FGoogleAnalyticsMPBuildSettings UGoogleAnalyticsMPSettings::TestConfiguration |
Settings for the Test build configuration.