Referral

Players can invite other players to the game and get rewarded for it. P00LS games sdk provides the referral link generation, as long as referrer / referee tracking, but it's on the game developer to define the rewards.

Typically, game developers should check if a player is a new player and if he was referred to by another player and reward both players accordingly.

UserProfile object has a referrer field, that is only present if the user was referred by another user, which is the most basic way to check if a player was referred.

Generate referral link

The SDK provides a unique an immutable link per user and game.

sdk.GetReferralLink(link => { // do something with the link });

                    const referralLink = await sdk.referral.getReferralLink();
                    // do something with the link
                

You can directly invoke the Telegram share UI with the link and an optional message:

sdk.ShareReferralLink()

You can pass an optional string as argument, to override the default message.

sdk.referral.shareLink();

You can pass an optional string as argument, to override the default message.

Get referrer

The sdk can provide very basic information about the referrer to the referee. It can be useful to display a specific onboarding message. The method will yield null or undefined if there is no referrer.

sdk.GetReferrer(referrer => { Debug.Log(referrer.firstName); });

                    const referrer = await referral.getReferrer();
                    referrer && console.log(`You were invited by ${referrer.firstName}`);
                

Get referees

The referrer can have access to a list of all his referees. It can be useful to display a list of «friends» but also to reward this action with something meaningful inside the game.

This request is paginated. It's possible to specify the page size in the first call, then use the cursor returned to fetch the next page.

In case you just want to check new referees since the last check, it's possible to filter results with a since query parameter. Only referees who onboarded after that date will appear.

                    sdk.GetReferees(referees =>
                    {
                        Debug.Log($"Total: {referees.total}");
                        Debug.Log($"Next: {referees.next}");
                        foreach (var referee in referees.page)
                        {
                            Debug.Log(
                                $"Referee: {referee.firstName}, {referee.createdAt.ToString(CultureInfo.InvariantCulture)}");
                        }
                    });
                

GetReferees accept three optional parameters :

pageSize: Default 50
next: Cursor to fetch the next page
since: DateTime. Filter referees to get only those who onboarded after this date

const {page, total, next} = await sdk.referral.getReferees();

getReferees accept an optional parameter, where next is the next page cursor, pageSize is the initial page size, and since is the query filter mentioned above.

                    type Params = {
                        next?: string;
                        pageSize?: number;
                        since?:Date;
                    }
                

Last modified: 21 November 2024