22. Reward Invitation (beta)

Guide you how to implement Reward Invitation in your game.

 


What is a Reward Invitation?

  • A feature to provides rewards to both the invited and inviting users.

Pre-requisites for Reward Invitation

  • A reward invitation event should have been created. 

  • Reward invitation does not work if the invited user has not signed up for KakaoTalk. 

  • The invited user should not have no history of signing up for the game. 

  • The reward will not be given if the invited user has already signed up for the game before receiving the invitation (e.g. CBT participant), or re-sign up for the game after unregistering from the game.

Users who sign up through invitation will be counted in the following case:

  1. The inviting user sends the invited a reward invitation via KakaoTalk. 

  2. The invited clicks the KakaoTalk invitation message. 

  3. The invited completes game installation and logs into (and signs up for) the game (app) for the first time.

    • When the invited user receives an invitation and signs up for the game between 00:00 of the date before the sign-up date and the sign-up time, he or she is eligible for a reward. (Max 24 hours + n hours) 

Precautions when sending invitation messages

Add "{invitation_event_id}" when calling the "send invitation message" API. An error will occur if "{invitation_event_id}" is not included in the call.



Conditions for reward: Tracking through invitation (Only applicable to users using friend invitation based on registration probability)

  • When the invited user receives an invitation and signs up for the game, it is counted as a reward invitation and the reward will be issued.

    • The inviting user's invitation is counted for reward when the invited user's sign-up time is within 24 hours of 00:00 of the day before the sign-up date. (Valid sign-up time range: between 00:00 of the day before and the sign-up time.) 

    • E.g.) When the invited user signs up at 16:00 on Jan 2, the inviting user who sent the invitation between 00:00 on Jan 1 and 16:00 on Jan 2 is eligible for a reward.

  • The inviting user's perspective

    • When the inviting user sends invitations to multiple users, rewards will be given when any of the invited users signs up for the game between 00:00 of the date before the sign-up date and the sign-up time.) 

    • E.g.) A sends invitations to B1, B2 and B3 and all three users sign up for the game at 16:00 on Jan 2. If A sent the invitations between 00:00 on Jan 1 and 16:00 on Jan 2, it will be recognized that the three users signed up for the game through A's invitation. (The reward will be counted based on the sign-up time of the invited.) 

    • Invited users who sign up for the game after the valid sign-up time range, it will not be counted for A's reward invitation.

  • Invited user's perspective

    • When the invited user receives an invitation and signs up for the game between 00:00 of the date before the sign-up date and the sign-up time, he or she is eligible for a reward. (Max 24 hours + n hours) 

    • E.g. #1) If C signs up for the game at 16:00 on Jan 2 through an invitation message, he will receive a reward if the inviting user has sent an invitation between 00:00 on Jan 1 and 16:00 on Jan 2. 

    • E.g. #1) If D signs up for the game at 16:00 on Jan 5 through an invitation message, he will not receive a reward if the inviting user has sent an invitation between 00:00 on Jan 3 and 24:00 on Jan 3.

       

       

 

 

Pre-setup

Go to the Game Center to configure a pre-setup in order to use the reward invitation API.

Read the following information carefully.

Step 1. Create reward invitation event

  • Go to Kakao Game Center > Admin > select a game to which the reward invitation will be applied > enter reward invitation event. 

  • A reward invitation event screen will appear when "create event" is clicked. 

  • Tracking Method (Refer to "Conditions for reward" above) 

    • Type A: Tracked through invitation (only applicable to users using friend invitation based on registration probability) 

    • Type B - Tracked when the invited user receives an invitation and clicks the download button 

  • Link Method 

    • API: A reward item is issued when the reward invitation API is called from the game server. 

    • Kakao SDK 3.0 (publishing, Friends game): A reward item issued by linking to the KakaoGame platform delivery server. 

  • Max reward limit for the inviting user : Max reward limit for each inviting user 

  • Item code for inviter reward: Reward for inviting user 

  • Item code for invited user reward: Reward for invited user 

  • Event Card (998*637) 

    • The invited user is redirected to the game page when clicking the invitation message. An event card containing event info should be registered so that it can be shown to the invited user. 

    • The event card will be displayed only when the invited user visits the game page through the invitation message. 

  • Event Card Display 

    • If set to "Display", the event card may be displayed in the game page. Please make sure that it is not displayed during the test period.

       

 

 

Step 2. Create an invitation message template

 

Test During Development

 

Step

Description

Step

Description

Step 0

Test account connected to KakaoTalk

  • You may have a difficulty arranging multiple test accounts connected to KakaoTalk. Please refer to the following guideline.

    • A Kakao Account can be connected when you unregister from KakaoTalk and re-register.

    • You can perform a new test if you skip this point and register a new Kakao Account with KakaoTalk. You may unregister up to twice per day.

    • Please provide the account information to the Q&A Board and we will reset the account.

Step 1

The inviting user sends a reward invitation message. 

  • To send an invitation message in the game, 1) the reward invitation template ID should be used, and 2) the reward invitation event ID should be provided.

  • Whether or not the invited user is subject to reward invitation is stored in the Kakao DB.

Step 2

 The invited completes game installation and logs into (and signs up for) the game (app) for the first time. 

  • In the game server, the “reward delayed user list inquiry” API is to be called every five seconds to check the users to receive rewards, and the list of users who have received rewards is to be updated using the “reward completion update” API. 

  • If the invitation receiver subscribes to the game under the following conditions, even if the message is received by several users, the invitation count is collected for all the invited senders and the reward is paid.

    • Condition : When the invited user receives an invitation and signs up for the game between 00:00 of the date before the sign-up date and the sign-up time, he or she is eligible for a reward. (Max 24 hours + n hours) 

    • (E.g.) When A, B, and C users send a message to 'a' users, respectively, 'a' is satisfied with the condition and all users A, B, and C are recorded as invited.