Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AnalyticsET > FAnalyticsET > Config

Light Theme

Dark Theme

Config

Configuration functionality.

Windows

MacOS

Linux

References

Module	AnalyticsET
Header	/Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsET.h
Include	#include "AnalyticsET.h"

Syntax

struct Config

Remarks

Defines required configuration values for ET analytics provider. APIKeyET MUST be set. Set APIServerET to an empty string to create a "NULL" analytics provider that will be a valid instance but will suppress sending any events.

Variables

	Name	Description
TArray< FString...	AltAPIServersET	ET Alt API Servers - Base URLs to send events on retry.
FString	APIKeyET	ET APIKey - Get from your account manager
FString	APIServerET	ET API Server - Base URL to send events.
FString	AppEnvironment	The AppEnvironment that the data router should use. Defaults to GetDefaultAppEnvironment.
FString	AppVersionET	AppVersion - defines the app version passed to the provider.
bool	bDropEventsOnFlushFailure	When true (default), events are dropped if flush fails
float	FlushIntervalSec	Maximum time to elapse before forcing events to be flushed.
int32	MaximumPayloadSize	Maximum size a payload can reach before we force a flush of the payload.
int32	PreallocatedPayloadSize	We preallocate a payload.
uint32	RetryLimitCount	Maximum number of retries to attempt.
FString	UploadType	The UploadType that the data router should use. Defaults to GetDefaultUploadType.
bool	UseLegacyProtocol	When true, sends events using the legacy ET protocol that passes all attributes as URL parameters.

Constructors

	Name	Description
	Config()	Default ctor to ensure all values have their proper default.
	Config ( FString InAPIKeyET, FString InAPIServerET, FString InAppVersionET, bool InUseLegacyProtocol, FString InAppEnvironment, FString InUploadType, TArray< FString > InAltApiServers, float InFlushIntervalSec, int32 InMaximumPayloadSize, int32 InPreallocatedPayloadSize )	Ctor exposing common configurables .

Functions

	Name	Description
FString	GetDefaultAppEnvironment()	Default value if no APIServer configuration is provided.
FString	GetDefaultUploadType()	Default value if no UploadType is given, and UseDataRouter protocol is specified.
FString	GetKeyNameForAPIKey()	KeyName required for APIKey configuration.
FString	GetKeyNameForAPIServer()	KeyName required for APIServer configuration.
FString	GetKeyNameForAppEnvironment()	For the the data router backend protocol.
FString	GetKeyNameForAppVersion()	KeyName required for AppVersion configuration.
FString	GetKeyNameForUploadType()	For the the data router backend protocol.
FString	GetKeyNameForUseLegacyProtocol()	Optional parameter to use the legacy backend protocol.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss