Navigation
Unreal Engine C++ API Reference > Runtime > AnalyticsET > FAnalyticsET
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
Type | 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
Type | Name | Description | |
---|---|---|---|
![]() |
Config () |
Default ctor to ensure all values have their proper default. | |
![]() |
Ctor exposing common configurables . |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
FString | Default value if no APIServer configuration is provided. | |
![]() ![]() |
FString | Default value if no UploadType is given, and UseDataRouter protocol is specified. | |
![]() ![]() |
FString | KeyName required for APIKey configuration. | |
![]() ![]() |
FString | KeyName required for APIServer configuration. | |
![]() ![]() |
FString | For the the data router backend protocol. | |
![]() ![]() |
FString | KeyName required for AppVersion configuration. | |
![]() ![]() |
FString | For the the data router backend protocol. | |
![]() ![]() |
FString | Optional parameter to use the legacy backend protocol. |