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.

Variables

Name Description

Public variable

TArray < FString ...

 

AltAPIServersET

ET Alt API Servers - Base URLs to send events on retry.

Public variable

FString

 

APIKeyET

ET APIKey - Get from your account manager

Public variable

FString

 

APIServerET

ET API Server - Base URL to send events.

Public variable

FString

 

AppEnvironment

The AppEnvironment that the data router should use. Defaults to GetDefaultAppEnvironment.

Public variable

FString

 

AppVersionET

AppVersion - defines the app version passed to the provider.

Public variable

bool

 

bDropEventsOnFlushFailure

When true (default), events are dropped if flush fails

Public variable

uint32

 

RetryLimitCount

Maximum number of retries to attempt.

Public variable

FString

 

UploadType

The UploadType that the data router should use. Defaults to GetDefaultUploadType.

Public variable

bool

 

UseLegacyProtocol

When true, sends events using the legacy ET protocol that passes all attributes as URL parameters.

Constructors

Name Description

Public function

Config()

Default ctor to ensure all values have their proper default.

Public function

Config

(
    FString InAPIKeyET,
    FString InAPIServerET,
    FString InAppVersionET,
    bool InUseLegacyProtocol,
    FString InAppEnvironment,
    FString InUploadType,
    TArray < FString > InAltApiServers
)

Ctor exposing common configurables .

Functions

Name Description

Public function Static

FString

 

GetDefaultAppEnvironment()

Default value if no APIServer configuration is provided.

Public function Static

FString

 

GetDefaultUploadType()

Default value if no UploadType is given, and UseDataRouter protocol is specified.

Public function Static

FString

 

GetKeyNameForAPIKey()

KeyName required for APIKey configuration.

Public function Static

FString

 

GetKeyNameForAPIServer()

KeyName required for APIServer configuration.

Public function Static

FString

 

GetKeyNameForAppEnvironment()

For the the data router backend protocol.

Public function Static

FString

 

GetKeyNameForAppVersion()

KeyName required for AppVersion configuration.

Public function Static

FString

 

GetKeyNameForUploadType()

For the the data router backend protocol.

Public function Static

FString

 

GetKeyNameForUseLegacyProtocol()

Optional parameter to use the legacy backend protocol.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback