Reward Integration

This page aims to help businesses quickly and smoothly integrate the LI PASS package reward functionality.The reward feature involves multiple collaborations, please complete the process step by step.

LI PASS Reward feature supports two scenarios: binding rewards and first login rewards.

The LI PASS Reward interface only determines whether players are eligible to receive Rewards; the specific Reward content and distribution are managed by other teams.Please contact your business interface person to configure reward activities, reward delivery routes, and in-game reward resource positions.

Go to Reward Product Documentation for more information.

LI PASS Interface

Linking rewards

This logic has been implemented in the LI PASS account center. On the game side, simply call the SetRewardExtraJson interface to set extraJson when entering the lobby with role information; there is no need to call SendBindReward. After the gift pack implementation, acceptance can be performed directly.

First login rewards

To grant a first login reward to a player, after the player enters the game lobby, call the SetRewardExtraJson API, then call the SendBindReward API.LI PASS's reward service will automatically check if players meet the package issuance requirements and then issue packages to eligible players.

The SetRewardExtraJson interface's input parameter is a JSON string that complies with the IDIP protocol.The SendBindReward interface's input parameter is a string representing the package activity ID and a JSON string that complies with the IDIP protocol.

note

It is recommended to add JSON format validation when calling the SetRewardExtraJson interface. Interface inputs in a non-standard JSON format will cause the SDK to fail to parse them.

To obtain the string representing the package activity ID, please contact the Player Network assistant.

Unity

INTLAPI.SetRewardExtraJson("{}");
INTLAPI.SendBindReward("110001", "{}");

Unreal Engine

UINTLSDKAPI::SetRewardExtraJson("{}");
UINTLSDKAPI::SendBindReward("110001", "{}");

The JSON string format is:

{
    "area_id": xx,     // int type (the area’s region Id obtained from the Idip side)
    "role_id": "xx",   // string type (the roleId / character Id from the game side)
    "plat_id": xx,     // int type (the platform Id obtained from the Idip side)
    "zone_id": xx      // int type (the partition Id obtained from the Idip side)
}

Handling Reward Activities

Unity

1. Add/Remove AuthBaseResultObserver
2. Add/Remove LIEventObserver

AuthResult and LIBaseEventResult data structures contain login information.To obtain login information, see AuthResultObserver and LIEventObserver.

Unreal Engine

1. AuthBaseResultObserver
2. LIEventObserver
3. LI PASS Lua Error Callback (LILuaErrorObserver)

AuthResult and LIBaseEventResult data structures contain login information.To obtain login information, see AuthResultObserver and LIEventObserver.

Reward Implementation

1. Confirm Reward Issuance Interface

The business side needs to confirm that the IDIP award distribution interface channel is available to ensure that players can normally receive packages after becoming LI PASS users.

IDIP interface person: havenni(Ni Haiwen)

2. Confirm Reward Activity Configuration Platform

The business side needs to confirm that the reward activity platform and delivery interface are connected (LI PASS activity award distribution supports AMS platform), then confirm the package content and configure the package activity sheet.

AMS onboarding contact: eagleyin

3. Confirm Reward Content

AMS activities use rewards/items as the basic unit, and reward content needs to be identified in advance.If it has not yet been confirmed, you can first configure testing activities using test items, and after the award distribution process is smooth, replace with the official Reward.

Contact the Player Network assistant to configure the LI PASS backend reward distribution interface, providing the following information:

• Item ID (must be character-bound type)

• Item Name (if multilingual, provide each language version and specify the default language)

• Item Quantity

• AMS Package Activity Sheet (if multilingual mail settings, provide each language version and specify the default language)

If the business party needs assistance configuring package activity sheets, contact Player Network Assistant.

Note: Item icons do not need to be configured in the package activity sheet, confirm the specific required fields with the AMS platform from the game side.

4. Confirm 【LI PASS Binding Guide】Resource Slot

The business side must confirm the in-game announcement resource slot (such as slapface announcements, notification announcements, event slots, website notifications, etc.), and adjust the visual style, copy tone, and size according to the placement position.

If UI design assistance is needed from the LI PASS team, contact Player Network Assistant for connection and scheduling (involving scheduling, it is recommended for the business side to initiate communication two months before game launch).

Need to provide the following materials:

• Size, specification, template

• Game Materials

• Announcement Text (multilingual versions + default language)

• Event Entry Information

5. Reward Activity Joint Debugging and Acceptance

Confirm package delivery capability and configuration, the game has integrated the client award distribution interface, provide package activity configuration information to the account joint debugging team for LI PASS backend reward distribution interface debugging; after successful debugging, use the business package for delivery route joint debugging, this requires collaboration from debugging colleagues/account backend/business development/activity platform development to ensure the smooth arrival of package route.

Pre-launch testing needs to include package arrival route testing; the LI PASS team can provide test cases; if needed, contact Player Network Assistant.

Note: The game side needs to confirm that the SetRewardExtrajson passed in different scenarios reflects the latest player region and role information.