Custom Event Report (ReportEvent)

AndroidiOSWindows
If you are using the Unity engine, see Unity SDK's ReportEvent.

Report custom events.For the Adjust channel, events must be registered in the Adjust dashboard and acquire an event token before successful reporting.

Supported Channels:

• INTL
• Adjust
• AppsFlyer
• Facebook
• Firebase
• Garena
• TikTok

caution

Windows platform only supports INTL channel.

Function Definition

UFUNCTION(BlueprintCallable, Category = "INTLSDKAPI")
static bool ReportEvent(const FString EventName, TMap<FString, FString> ParamsMap, const FString SpecificChannel = "", const FString ExtraJson = "{}");

Parameter Description

Parameter Name	Parameter Type	Description
EventName	FString	Event Name 1. Adjust channel requires filling in the event token to track events 2. AppsFlyer channel suggests using only lowercase alphanumeric characters (a-z and 0-9) for in-app event names 3. Facebook channel requires events and parameters to consist of 2 to 40 alphanumeric characters, with each parameter value not exceeding 100 characters 4. Firebase channel requires 1 to 40 alphanumeric characters or underscores.Names must begin with a letter character.Please note that event names are case sensitive, and recording two events differing only in case will result in two different events. 5. INTL channel requires event_name not to exceed 12 characters, allowing uppercase/lowercase letters, numbers, underscores, and no spaces.
ParamsMap	TMap<FString, FString>	Parameters to be reported in key-value form.
SpecificChannel	FString	Specify the channel 1. If no specific channel is required, leave as an empty string.An empty string will default to report to the initialized channel, that is, the reporting channel configured by ANALYTICS_REPORT_CHANNEL in INTLConfig.ini.For more information, please refer to the Integration Guide. 2. Specify reporting to a certain channel, such as "Facebook". 3. Specify reporting to multiple channels, separated by English comma ',', e.g., "Facebook,Firebase".
ExtraJson	FString	Extended parameters, additional judgment conditions of the Player Network SDK client, this parameter will not be reported to specified channels.

Code example

TMap<FString, FString> ParamsMap;
ParamsMap.Add("k1", "v1");
UINTLSDKAPI::ReportEvent("INTL_EVENT_TEST", ParamsMap);