Revist Incentives
Drive user retention by navigating users to TikTok profile sidebar missions, adding desktop shortcuts, and claiming revisit reward incentives after completing entrance or shortcut missions.
TTMinis.game.startEntranceMission(opts)
Navigates to the TikTok profile sidebar to guide users to revisit.
Parameters
Field | Type | Description | Required |
|
| The callback function for a successful API call | No |
|
| The callback function for a failed API call | No |
|
| The callback function called when the API call ends (executed for both success and failure) | No |
Example
TTMinis.game.startEntranceMission({
success: () => {
console.log('success');
},
fail: () => {
console.log('fail');
},
complete: () => {
console.log('complete');
}
});TTMinis.game.getEntranceMissionReward(opts)
Checks whether the user can receive the revisit incentive reward. After adding to the home screen, canReceiveReward is true only when the user enters the mini game from the home screen.
Parameters
Field | Type | Description | Required |
|
| The callback function for a successful API call | No |
|
| The callback function for a failed API call | No |
|
| The callback function called when the API call ends (executed for both success and failure) | No |
Success callback parameters
The success callback receives an object with the following fields:
Field | Type | Description |
|
| Whether the user can receive the reward |
Example
TTMinis.game.getEntranceMissionReward({
success: ({ canReceiveReward }) => {
console.log('success', canReceiveReward);
},
fail: () => {
console.log('fail');
},
complete: () => {
console.log('complete');
}
});TTMinis.game.addShortcut(opts)
Adds a shortcut to the home screen.
Parameters
Field | Type | Description | Required |
|
| The callback function for a successful API call | No |
|
| The callback function for a failed API call | No |
|
| The callback function called when the API call ends (executed for both success and failure) | No |
Example
TTMinis.game.addShortcut({
success: () => {
console.log('success');
},
fail: (error) => {
console.log('fail', error);
},
complete: () => {
console.log('complete');
}
});TTMinis.game.getShortcutMissionReward(opts)
Checks whether the user can receive the add-to-home-screen reward.
Parameters
Field | Type | Description | Required |
|
| The callback function for a successful API call | No |
|
| The callback function for a failed API call | No |
|
| The callback function called when the API call ends (executed for both success and failure) | No |
Success callback parameters
The success callback receives an object with the following fields:
Field | Type | Description |
|
| Whether the user can receive the reward |
Example
TTMinis.game.getShortcutMissionReward({
success: ({ canReceiveReward }) => {
console.log('success', canReceiveReward);
},
fail: (error) => {
console.log('fail', error);
},
complete: () => {
console.log('complete');
}
});