Navigation
API > API/Runtime > API/Runtime/AnalyticsET > API/Runtime/AnalyticsET/FAnalyticsET
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.
| Name | Config |
| Type | struct |
| Header File | /Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsET.h |
| Include Path | #include "AnalyticsET.h" |
Syntax
struct Config
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
Config () |
Default ctor to ensure all values have their proper default. | AnalyticsET.h | |
| Ctor exposing common configurables . | AnalyticsET.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AltAPIServersET | TArray< FString > | ET Alt API Servers - Base URLs to send events on retry. | AnalyticsET.h | |
| APIEndpointET | FString | ET API Endpoint - This is the API endpoint for the provider. | AnalyticsET.h | |
| APIKeyET | FString | ET APIKey - Get from your account manager | AnalyticsET.h | |
| APIServerET | FString | ET API Server - Base URL to send events. | AnalyticsET.h | |
| APIUnixSocketPathET | FString | ET API UnixSocketPath - This is the UnixSocketPath to use as the target for the API endpoint for the provider. | AnalyticsET.h | |
| AppEnvironment | FString | The AppEnvironment that the data router should use. Defaults to GetDefaultAppEnvironment. | AnalyticsET.h | |
| AppVersionET | FString | AppVersion - defines the app version passed to the provider. | AnalyticsET.h | |
| bDropEventsOnFlushFailure | bool | When true (default), events are dropped if flush fails | AnalyticsET.h | |
| FlushIntervalSec | float | Maximum time to elapse before forcing events to be flushed. | AnalyticsET.h | |
| MaximumPayloadSize | int32 | Maximum size a payload can reach before we force a flush of the payload. | AnalyticsET.h | |
| PreallocatedPayloadSize | int32 | We preallocate a payload. | AnalyticsET.h | |
| RetryLimitCount | uint32 | Maximum number of retries to attempt. | AnalyticsET.h | |
| UploadType | FString | The UploadType that the data router should use. Defaults to GetDefaultUploadType. | AnalyticsET.h | |
| UseLegacyProtocol | bool | When true, sends events using the legacy ET protocol that passes all attributes as URL parameters. | AnalyticsET.h |
Functions
Public
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FString GetDefaultAPIEndpoint() |
Default value if no APIEndpoint is given. | AnalyticsET.h | |
static FString GetDefaultAppEnvironment() |
Default value if no APIServer configuration is provided. | AnalyticsET.h | |
static FString GetDefaultUploadType() |
Default value if no UploadType is given, and UseDataRouter protocol is specified. | AnalyticsET.h | |
static FString GetKeyNameForAPIEndpoint() |
KeyName required for APIEndpoint configuration. | AnalyticsET.h | |
static FString GetKeyNameForAPIKey() |
KeyName required for APIKey configuration. | AnalyticsET.h | |
static FString GetKeyNameForAPIServer() |
KeyName required for APIServer configuration. | AnalyticsET.h | |
static FString GetKeyNameForAPIUnixSocketPath() |
KeyName required for APIEndpoint configuration. | AnalyticsET.h | |
static FString GetKeyNameForAppEnvironment() |
For the the data router backend protocol. | AnalyticsET.h | |
static FString GetKeyNameForAppVersion() |
KeyName required for AppVersion configuration. | AnalyticsET.h | |
static FString GetKeyNameForUploadType() |
For the the data router backend protocol. | AnalyticsET.h | |
static FString GetKeyNameForUseLegacyProtocol() |
Optional parameter to use the legacy backend protocol. | AnalyticsET.h |