You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/production/promotion/referral-system.md
+73-11Lines changed: 73 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,40 @@
1
1
---
2
-
title: Friend invite reward system
2
+
title: Friend referral system
3
3
description: Use referral links to track and reward players that have successfully invited other players into your experience, and players that have joined your experience using a referral link invitation from another player.
4
4
---
5
5
6
6
<Alertseverity="info">
7
-
This feature is still in beta. If you'd like to provide Roblox with feedback about this feature, join the [User Acquisition Referrals](https://www.guilded.gg/i/EwKQPZWE) Guilded group.
7
+
If you previously used this feature while it was still in beta, make sure to implement the new [customized reward banners](#create-a-reward-banner) to maximize the reach of your friend referral system.
8
8
</Alert>
9
9
10
-
<iframewidth="880"height="495"src="https://www.youtube-nocookie.com/embed/qfWKYgO63OI"title="YouTube video player"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"allowfullscreen></iframe>
The friend referral system encourages existing players to bring new players into your experience, increasing player retention and overall engagement. Players can access and share referral links from [player invite prompts](./invite-prompts.md) or directly from the default in-experience invite menu.
15
20
16
-
As a developer, you can use these shareable referral links to:
21
+
As a developer, you can create customized banners to advertise your reward system and use shareable referral links to:
17
22
18
23
- Track which players have successfully invited other players into your experience.
19
24
- Track which players have joined your experience using a referral link invitation from another player.
20
25
- Create and distribute rewards to both inviters and invitees.
To implement a friend referral system, [set up a referral event](#set-up-a-referral-event) and [create referral rewards](#grant-referral-rewards). The `ReferredByPlayerId` property of `Class.Player:GetJoinData()|GetJoinData()` automatically populates for all types of invitations and gives you access to the user ID of the referring player. You can then access this data in the `Players.PlayerAdded` event to identify the inviter and grant rewards to the inviter and the invitee.
37
+
To implement a referral system, [set up a referral event](#set-up-a-referral-event) and [create referral rewards](#grant-referral-rewards) in Studio. The `ReferredByPlayerId` property of `Class.Player:GetJoinData()|GetJoinData()` automatically populates for all types of invitations and gives you access to the user ID of the referring player. You can then access this data in the `Players.PlayerAdded` event to identify the inviter and grant rewards to both the inviter and the invitee.
27
38
28
39
```lua
29
40
functiononPlayerAdded(player)
@@ -37,6 +48,8 @@ end
37
48
Players.PlayerAdded:Connect(onPlayerAdded)
38
49
```
39
50
51
+
To make sure that players understand the reward system, [implement a customized reward banner](#create-a-reward-banner) at the top of your friend invite modal showing them details about the rewards they can earn.
52
+
40
53
## Set up a referral event
41
54
42
55
To set up a referral event:
@@ -113,7 +126,31 @@ end
113
126
Players.PlayerAdded:Connect(onPlayerAdded)
114
127
```
115
128
116
-
## Manage abuse prevention
129
+
## Create a reward banner
130
+
131
+
Reward banners encourage users to invite friends to join your experience by showing them details about the referral rewards they can earn. These banners are displayed at the top of your friend invite modal.
132
+
133
+
To create a customized reward banner:
134
+
135
+
1. In the Creator Hub, go to **Creations** and select the experience that you have set up a referral event for.
136
+
2. Go to **Engagement** > **Referral Rewards**.
137
+
3. Click **Add Reward Details**.
138
+
4. In the **Referral Rewards** page:
139
+
1. Replace the default icon with an image that represents your experience.
140
+
2. Enter a reward name to display on the banner.
141
+
3. Select a start and end date for when you want to show the banner to players.
142
+
4. (Optional) Enter a description with details about the reward.
143
+
5. (Optional) If you want to add reward restrictions, enter a reward limit. For example, a limit of up to 3 rewards per inviter.
144
+
5. Click **Save** to save your changes.
145
+
6. Click **Publish** to make the banner visible to players.
146
+
147
+
You can create many different banners, but only one banner can be published and shown at a time. Make sure that the published banner accurately describes the referral system you have implemented in Studio.
You can implement safeguards to prevent players from exploiting the friend referral system.
119
156
@@ -140,3 +177,28 @@ function onPlayerAdded(player)
140
177
end
141
178
end
142
179
```
180
+
181
+
## Best practices
182
+
183
+
Follow the best practices to get the most out of your friend referral system.
184
+
185
+
- To encourage players in your experience to take advantage of referrals, add an in-experience button to advertise the referral system. Give the button a descriptive title and connect the button click event to the friend invite modal where players can see the reward banner.
186
+
- Update the title and description of your experience to include the referral system. For example, you can add "[Referral reward live]" to your experience's title to make players who are browsing Roblox aware of referral rewards.
187
+
188
+
## Frequently asked questions
189
+
190
+
**Which experiences are eligible to use this feature?**
191
+
192
+
This feature is open to any experience that has been live for at least one day and that doesn't violate the [Community Standards](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards).
193
+
194
+
**Which players can take advantage of referrals?**
195
+
196
+
All players are eligible to earn rewards through referrals.
197
+
198
+
**Is the invite restricted to a player's friends on Roblox?**
199
+
200
+
No, players can send an invite to friends they aren't connected with on the Roblox platform yet.
0 commit comments