Report Event
The version of each SDK plugin used in the game must be consistent, including the SDK version used by the launcher.If the game needs to upgrade a plugin or access different SDK versions concurrently, please contact Player Network assistant.
Player Network Data Insight Service can report predefined Player Network data events, as well as standard and custom game data events.These events can be reported by sending them through the data channel.
Prerequisites
To view and analyze event data, at least one analysis platform must be configured first.Businesses can choose to enable the data report functionality of Player Network Console to view data, please contact the Player Network assistant for data deployment.
Player Network Data Insight Service also supports the following analysis platforms, which require separate configuration:
- DataBrain
- AiX
- Adjust
- AppsFlyer
- Firebase
- Garena
- TikTok
For detailed information about Garena, please contact your business representative.
- Configure Adjust reporting
- Configure AppsFlyer reporting
- Configure Facebook reporting
- Configure Firebase reporting
- Configure TikTok reporting
Other platforms can refer to the official documentation of each platform.
Step 1: Configure SDK
In the ANALYTICS_REPORT_CHANNEL field of the INTLConfig.ini configuration file, add the data platforms to be reported.
[ANALYTICS]
ANALYTICS_REPORT_CHANNEL = INTL,AppsFlyer,Adjust,Facebook,Firebase,Garena
The ANALYTICS_REPORT_CHANNEL field specifies the names of platforms to be reported."INTL" represents the Player Network platform, supported third-party platforms include Adjust, AppsFlyer, Facebook, Firebase, and Garena.If there are multiple reporting channels, separate them with commas.
For more advanced configurations, see the following sections for details on configurable report fields and analysis fields.
Player Network SDK Reporting
| Field | Explanation | Remark |
|---|---|---|
| REPORT_ENABLE | Whether to enable reporting Default: 1, enabled | Optional field |
| REPORT_COMPRESS_ENABLE | Whether compression is needed Default: 1, compression | Optional field |
| REPORT_KV_MAX_LOCAL_FILE_NUM | Maximum quantity of landing files for KV logs Default: 10 | Optional field |
| REPORT_KV_MAX_LOCAL_FILE_SIZE | Size of landing files for KV logs Unit: bytes Default: 262144 | Optional field |
| REPORT_KV_TIME_INTERVAL | Reporting time interval for KV logs Unit: seconds Default: 5 | Optional field |
| REPORT_BIN_ENABLE | Whether to enable file reporting for binary logs Default: 1, enabled | Optional field |
| REPORT_BIN_SEG_SIZE | File segment size for binary logs Unit: bytes Default: 32768 | Optional field |
| REPORT_BIN_MAX_LOCAL_FILE_NUM | Maximum quantity of landing files for binary logs | Optional field |
| REPORT_BIN_MAX_LOCAL_FILE_SIZE | Maximum file size for binary logs Unit: bytes | Optional field |
| REPORT_BIN_TIME_INTERVAL | Reporting time interval for binary logs Unit: seconds Default: 10 | Optional field |
| REPORT_SRC_ID | Source ID for default data reporting Default: 1000 | Optional field |
| REPORT_LIFECYCLE_ENABLE | Whether to report changes with lifecycle Default: 1, enabled, switching to foreground and background will trigger report requests | Optional field |
| PING_TIMEOUT | Ping timeout when collecting network quality Unit: seconds Default: 1 | Optional field |
| REPORT_DISABLE_COLLECT_METHOD | Method ID to be excluded from reporting, separated by commas (,) Default is empty (all reportings) Suggestion: fill 501,703,706,721,724,731,732,902 | Optional field |
| REPORT_DISABLE_COLLECT_EVENT_NAME | Name of report events to be disabled, separated by commas (,) Default value: sdk_update_start | Optional field |
| REPORT_UA_DATA_ENABLE | Currently only supports Windows Whether to enable UA reporting function 0: disabled 1: enabled Default: 1, enabled | Optional field |
| REPORT_UA_DATA_SHORT_CODE_FILTER | Currently only supports Windows Configure UA short code filter list Short codes in the list will be reported directly (multiple short codes separated by English character (,)) Default: empty string | Optional field |
| SECURITY_FLAG | Whether to enable security checks on Android (including detection of HOOK, plugging, signature, etc.) 0: disabled 1: enabled Default: 1, enabled | Optional field |
Player Network SDK Analysis
| Field | Description | Remarks |
|---|---|---|
| ANALYTICS_REPORT_CHANNEL | The channel for data reportingINTL is the proprietary channel of Player Network SDK If LI PASS is connected, the ANALYTICS_REPORT_CHANNEL configuration item must enable INTL | Requir ed |
| ANALYTICS_CRASH_CHANNEL | Crash reporting channel | Requir ed |
| ANALYTICS_AUTH_REPORT_ENABLE | Whether to automatically report registration and login events You can confirm this configuration by contacting [killuachen(Chen Congcong)] Default: 1, enabled (versions V1.18.00 and earlier are disabled by default) | Optional |
| ANALYTICS_FIREBASE_IS_DELAY | Whether Firebase is delayed in initialization; if the toggle is enabled, the initialization method needs to be manually called in the startup method Default: 0 | Optional |
Step 2: Prepare Reporting Event
Before using any data insight functionality, initialize the data insight service via the InitAnalytics interface.Then use the device information name to call the IsDeviceInfoCollectEnable interface to check whether collection of specific device information is enabled.
iOS IDFA Authorization
In iOS 14.5 and later versions, Apple requires applications to obtain user consent when collecting IDFA, to enhance privacy management for iOS users.
- Add dependencies in iOS's "AppTrackingTransparency.framework".
- In the
Info.plistfile, addNSUserTrackingUsageDescriptionfor displaying the player consent prompt text and configuration. - Call
static void RequestTrackingAuthorization();to prompt for player consent to collect IDFA.- This interface is specifically designed for iOS and developed with Xcode 12 or later, compatible with devices running iOS 14.5 or later.
- This interface issues a one-time request, and the system saves the user's choice.Unless the user uninstalls and reinstalls the application, no further notifications will appear.
Google Ad ID on Android Devices
The AD_ID permission (<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>) is required to collect Google's advertising ID.Applications that use the advertising ID with Android 13 (API 33) must declare this in the Google Play console.You need to toggle the switch in Google Play Console > Policy > App Content > Ad ID.
Player Network SDK enables AD_ID collection by default.To revoke, add the following configuration to the AndroidManifest.xml file:
<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove" />
For more information on Google Advertising ID, see Advertising ID and AdvertisingIdClient.Info.
Step 3: Report Event
Call the ReportFunnel interface to report predefined event data, allowing user conversion rates to be calculated in funnel analysis.
- Unity
- Unreal Engine
int error_code = 0;
INTLAPI.ReportFunnel(FINTLFunnelStep.kStartAppLaunch, error_code);
int error_code = 0;
UINTLSDKAPI::ReportFunnel(step_name, error_code);
Call the ReportFunnelCustomEvent interface to report custom event data, allowing user conversion rates to be calculated in funnel analysis.
- Unity
- Unreal Engine
string l1_event_name = "l1_event_name";
string l2_event_name = "l2_event_name";
int error_code = 0;
INTLAnalytics.ReportFunnelCustomEvent(l1_event_name,l2_event_name, error_code);
FString l1_event_name = "l1_event_name";
FString l2_event_name = "l2_event_name";
int error_code = 0;
UINTLSDKAPI::ReportFunnelCustomEvent(l1_event_name, l2_event_name, error_code);;
Step 4: Verify Data
To ensure that all reported data is correct, please:
- Verify that the key fields and value fields are consistent with the reported data, including case sensitivity, underscores, and spacing.
- Check whether any key fields or value fields were lost during reporting.