プレイヤー招待プロンプト | 文書 - Roblox クリエーターハブ

一般的なプロモーション方法に加えて、ゲーム内で直接招待プロンプトを実装し、プレイヤーに友達を招待してもらい、共同体験を促進することができます。

招待プロンプトシステムの特徴は次のとおりです：

動的な招待者 — プレイヤーに選択リストから複数の友達を招待するよう促すか、特定の友達を1人招待します。
ローンチデータ — 招待された友達が参加したときに Player:GetJoinData() を通じて読み取ることができるオプションのローンチデータを含めます。具体的な使用例には、招待された友達を座標位置にルーティングしたり、参加者のために参加ゲームをパーソナライズすることが含まれます。
カスタマイズ可能なテキスト — 招待プロンプトメッセージと通知メッセージをカスタマイズします。例えば、プレイヤー用の招待プロンプトは「友達に冒険に参加するように頼んでください！」と表示され、招待された友達への通知メッセージは「{displayName} があなたに {experienceName} の冒険に参加するように求めています！」となるかもしれません。

また、フレンド招待報酬システムを使用して、招待者と招待された友達を追跡および報酬を与えることもできます。

招待オプションの設定

デフォルトでは、プレイヤー用の招待プロンプトには招待ボタンを持つ友達のメニューが表示されます。プロンプトメッセージをカスタマイズしたり、特定の友達をターゲットにしたり、招待にローンチデータを含めたりするには、必要なプロパティを持つ ExperienceInviteOptions オブジェクトを設定する必要があります。

プロパティ	タイプ	説明
PromptMessage	string	送信者向けの招待プロンプトに表示されるカスタムテキスト。例えば、複数の友達を招待するプロンプトでは「友達に冒険に参加するように頼んでください！」、特定の友達を招待するプロンプトでは「この友達を冒険に招待します！」などを示します。カスタム招待プロンプトメッセージがUIの境界を超えるほど長い場合は表示されません。
InviteUser	number	招待する特定の友達のRoblox UserId。指定しない場合、プレイヤーは友達のリストから選ぶよう促されます。
InviteMessageId	string	通知アセットタイプにマップされるアセットID。このアセットは、友達が受け取る招待通知用のカスタム文字列をストア/ローカライズするために使用されます。詳細については通知オプションの設定を参照してください。
LaunchData	string	友達が招待通知から参加する際に Player:GetJoinData() に設定されるパラメーター。最大200文字。使用例についてはローンチデータの含め方を参照してください。

LocalScript - 複数の友達を招待
local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

-- カスタムプロンプトメッセージで招待オプションを構築
local inviteOptions = Instance.new("ExperienceInviteOptions")
inviteOptions.PromptMessage = "友達に冒険に参加するように頼んでください！"

通知オプションの設定

デフォルトでは、友達が受け取る招待通知には送信者の DisplayName、ユーザー名、ゲーム名が含まれています。メッセージをカスタマイズするには、クリエイターダッシュボードで通知アセットを作成し、そのアセットIDを ExperienceInviteOptions のパラメータとして含めます。

クリエイターダッシュボードに移動します。
バッジと同様に、通知文字列は特定のゲームに関連付けられています。そのゲームのサムネイルを見つけてクリックします。
左のカラムでエンゲージメントの中の通知をクリックします。
中央の領域で通知文字列を作成するボタンをクリックします。
識別名（あなたにだけ見える）とカスタム通知テキストを入力します。「{experienceName}」を含めて、招待された友達のゲーム名を特定し、送信者の DisplayName を {displayName} プレースホルダーを介してオプションで含める必要があります。

例の通知文字列：
- {displayName} があなたに {experienceName} の冒険に参加するように求めています！
- {displayName} が {experienceName} の第六ステージをクリアしました。あなたはできる？
準備ができたら、通知文字列を作成するボタンをクリックします。
通知ページの通知のテーブルで、アクションカラムの ⋯ ボタンをクリックし、アセットIDをコピーを選択します。

招待プロンプトの ExperienceInviteOptions オブジェクトに、アセットIDを InviteMessageId プロパティの値として貼り付けます。

LocalScript - 複数の友達を招待
local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

-- 友達のユーザーIDで招待オプションを構築
local inviteOptions = Instance.new("ExperienceInviteOptions")
inviteOptions.InviteMessageId = "ef0e0790-e2e8-4441-9a32-93f3a5783bf1"

招待を促す

招待を促すには、まずプレイヤーが招待を送信できるかどうかを確認する必要があります。この能力はプラットフォームやプレイヤーによって異なる場合があります。確認が取れたら、プレイヤーに招待プロンプトを表示できます。

SocialService:CanSendGameInviteAsync() を呼び出し、pcall() でラップします。これは非同期のネットワーク呼び出しで、時折失敗する可能性があります。
招待能力が確認された場合、SocialService:PromptGameInvite() を、オプションの招待オプションオブジェクトを第二引数として呼び出します。

プロンプトが表示されると、プレイヤーは複数の友達を招待するか、招待オプションオブジェクトで定義された特定の友達を招待するための画面上のプロンプトを確認できます。その後、プレイヤーが1人以上の友達の招待ボタンをクリックすると、その友達には送信者の DisplayName、ユーザー名、経験名が含まれた通知が送信されます。通知は、通知オプションの設定に記載されているようにさらにカスタマイズできます。

LocalScript - 複数の友達を招待
local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

-- プレイヤーが招待を送信できるかどうかを確認する関数
local function canSendGameInvite(sendingPlayer)
	local success, canSend = pcall(function()
		return SocialService:CanSendGameInviteAsync(sendingPlayer)
	end)
	return success and canSend
end

local canInvite = canSendGameInvite(player)
if canInvite then
	SocialService:PromptGameInvite(player)
end

ローンチデータの含め方

体験内の協力をさらに強化するためやプレイヤーの招待を促すために、招待プロンプトにローンチデータを含めることができます。これは、招待された友達を座標位置にルーティングしたり、参加者のために参加ゲームをパーソナライズしたりするのに便利です。

招待を促すときに、友達がゲームに参加する際に使用される関連データを含む ExperienceInviteOptions オブジェクトを含めます。例えば、送信者の Player.UserId、友達が参加した際に贈るバッジのID、または友達をスポーンさせるための座標位置などです。複数のデータをまとめる必要がある場合は、JSONEncode() を使用してデータをエンコードします。

LocalScript - 複数の友達を招待
local HttpService = game:GetService("HttpService")
local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

local data = {
	senderUserID = player.UserId,
	spawnLocation = {12, 48, 205.5}
}

local launchData = HttpService:JSONEncode(data)

-- ローンチデータで招待オプションを構築
local inviteOptions = Instance.new("ExperienceInviteOptions")
inviteOptions.LaunchData = launchData

-- プレイヤーが招待を送信できるかどうかを確認する関数
local function canSendGameInvite(sendingPlayer)
	local success, canSend = pcall(function()
		return SocialService:CanSendGameInviteAsync(sendingPlayer)
	end)
	return success and canSend
end

local canInvite = canSendGameInvite(player)
if canInvite then
	SocialService:PromptGameInvite(player, inviteOptions)
end

常にローンチデータを含む inviteOptions を PromptGameInvite() の第二引数として含めることを忘れないでください（最大200文字）。

通知を介して参加する友達のために、サーバー側で Player:GetJoinData() を介してローンチデータをチェックします。招待プロンプトのためであれば、JSONで複数のデータをエンコードした場合は、 JSONDecode() でデコードすることを忘れないでください。

Script - 招待ローンチデータの使用
local HttpService = game:GetService("HttpService")
local Players = game:GetService("Players")

local ATTEMPT_LIMIT = 10
local RETRY_DELAY = 1

local function onPlayerAdded(player)
	local launchData

	for _ = 1, ATTEMPT_LIMIT do
		task.wait(RETRY_DELAY)
		local joinData = player:GetJoinData()
		if joinData.LaunchData ~= "" then
			launchData = joinData.LaunchData
			break
		end
	end

	if launchData then
		local data = HttpService:JSONDecode(launchData)
		print(data.senderUserID)
		print(data.spawnLocation)
	else
		warn("ローンチデータは受信されませんでした！")
	end
end

Players.PlayerAdded:Connect(onPlayerAdded)

ローンチデータは、友達が招待から参加した後、数秒かかることがあります。上記のコードサンプルのように、試使用する前にローンチデータが到着するのを待つことをお勧めします。

ローンチデータが存在する場合、次のようなさまざまなデザインシナリオに利用できます：
- 招待者がちょうどクリアした挑戦的な障害物コースの始まりに友達をスポーンさせるために、ローンチデータを介して渡された座標位置を基にします。
- ローンチデータ内の Player.UserId に基づいて送信者がその場所にいるかどうかチェックし、友達のキャラクターを彼らのキャラクターの近くにテレポートさせます。