Google Analytics Measurement Protocol  1.0.0
Google Analytics plugin for Unreal Engine, using a native cross-platform implementation of the Measurement Protocol.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
UGoogleAnalyticsMPAttributesFilter Class Reference

Class to manipulate the event attributes processed by the Google Analytics Measurement Protocol plugin. More...

#include <GAMPAttributesFilter.h>

Inheritance diagram for UGoogleAnalyticsMPAttributesFilter:

Public Member Functions

void FilterAttributes (const FString &EventName, TMap< FString, FString > &Attributes)
 Filter the passed Attributes, for the event named EventName. More...
 

Protected Member Functions

bool FilterAttributesImpl (const FString &EventName, UPARAM(ref) TMap< FString, FString > &Attributes)
 Manipulate the set of attributes that will be sent with the corresponding logged event. More...
 

Protected Attributes

virtual bool FilterAttributesImpl_Implementation (const FString &EventName, TMap< FString, FString > &Attributes) PURE_VIRTUAL(UGoogleAnalyticsMPAttributesFilter
 C++ implementation of FilterAttributesImpl() More...
 

Detailed Description

Class to manipulate the event attributes processed by the Google Analytics Measurement Protocol plugin.

Subclasses must implement the overridable methods 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.

You can configure the filter used by your application in the Project Settings (see UGoogleAnalyticsMPSettings::AttributesFilterClass).

Member Function Documentation

◆ FilterAttributes()

void UGoogleAnalyticsMPAttributesFilter::FilterAttributes ( const FString &  EventName,
TMap< FString, FString > &  Attributes 
)

Filter the passed Attributes, for the event named EventName.

◆ FilterAttributesImpl()

bool UGoogleAnalyticsMPAttributesFilter::FilterAttributesImpl ( const FString &  EventName,
UPARAM(ref) TMap< FString, FString > &  Attributes 
)
protected

Manipulate the set of attributes that will be sent with the corresponding logged event.

Attributes can be either added and/or removed.

Parameters
EventNameEvent name. Some events could not have a name, so it could be empty.
AttributesThe attributes to manipulate.
Returns
Return true if changes to the attributes have been done, false otherwise.

Member Data Documentation

◆ FilterAttributesImpl_Implementation

virtual bool UGoogleAnalyticsMPAttributesFilter::FilterAttributesImpl_Implementation(const FString &EventName, TMap< FString, FString > &Attributes) PURE_VIRTUAL(UGoogleAnalyticsMPAttributesFilter
protected

C++ implementation of FilterAttributesImpl()


The documentation for this class was generated from the following file: