메시징 사용 가이드

*이 콘텐츠는 AI(베타)를 사용해 번역되었으며, 오류가 있을 수 있습니다. 이 페이지를 영어로 보려면 여기를 클릭하세요.

메시징 서비스 API()는 경험의 서버와 클라이언트 간에 통신할 수 있는 엔진의 오픈 클라우드 버전입니다.The Messaging Service API is the Open Cloud equivalent of the Engine which lets you communicate across your experience's servers and clients.엔진 API는 메시지 게시를 위해 Studio에서 스크립트를 수동으로 작성하고 업데이트할 수 있지만, 오픈 클라우드 API는 외부 도구에서 라이브 서버에 메시지를 보내 작업 워크플로를 자동화하고 개선할 수 있습니다.

사용

메시징 서비스 API를 통해 교차 서버 통신을 지원하여 빌드할 수 있는 몇 가지 유용한 도구가 있습니다. 여기에는 다음이 포함됩니다:

  • 공지 포털 : 웹 포털은 경험의 서버에서 모든 사용자에게 공지를 보내는 것을 지원하는 데 도움이 될 수 있으며, 예를 들어 다가오는 이벤트, 업데이트 및 경쟁의 우승자를 발표하는 것입니다.포털에서 메시지를 편집하고 API를 호출하는 버튼을 클릭하여 모든 사용자 또는 선택한 사용자에게 메시지를 보낼 수 있습니다.

  • 조정 시스템 : 조정 시스템을 사용하면 경험을 안전하고 안전하게 유지할 수 있습니다.부적절한 행동을 하는 사용자를 감지할 때 경험 서버에 메시지를 게시하여 특정 사용자를 경고하거나 금지할 수 있습니다.검열 시스템에서 데이터 저장소를 사용하여 사용자 계정을 차단 목록에 추가하여 재참여를 방지할 수도 있습니다.

  • LiveOps 대시보드 : LiveOps 대시보드는 할로윈 파티와 같은 라이브 이벤트를 관리하는 데 유용한 도구입니다.대시보드에서 이벤트를 미리 코딩하고, 이벤트 메시지를 업데이트하고, 준비되면 이벤트를 트리거하고, 경험의 코드를 업데이트하지 않고 선택한 사용자에게 가상 왕관과 같은 특별 아이템을 보상할 수 있습니다.

제한

제한설명
속도Roblox는 메시지 요청을 50 + (5 * number_of_players_in_experience) 제한합니다.예를 들어, 20명의 플레이어가 있는 경험은 분당 150개의 메시지 요청에서 속도를 줄이기 시작합니다.
주제 크기80 문자
메시지 크기1,024 문자(1KB)

메시징을 위한 주제 설정

경험의 라이브 서버에 메시지를 게시하려면 여러 서버에서 액세스할 수 있는 사용자 지정 메시지 채널인 주제 를 설정해야 합니다.주제를 정의한 후, 들어오는 메시지를 받기 위해 사용자를 주제에 구독합니다.

현재 Studio에서만 주제를 정의하고 Luau API MessagingService:SubscribeAsync()를 사용하여 사용자를 구독할 수 있습니다.다음 코드 샘플은 사용자가 경험에 참여할 때 토픽에 가입하도록 하며:

Set up and Subscribe Users to a Topic
local MessagingService = game:GetService("MessagingService")

local Players = game:GetService("Players")



local function onPlayerAdded(player)

	-- 주제 정의 및 구독 정의 및 구독 주제

	local topic = "YourTopic"

	local connection = MessagingService:SubscribeAsync(topic, function(message)

		print(message.Data)

	end)



	player.AncestryChanged:Connect(function()

		-- 플레이어 조상 변경 시 토픽 구독 취소

		connection:Disconnect()

	end)

end



Players.PlayerAdded:Connect(onPlayerAdded)

라이브 서버에 메시지 게시

토픽을 설정한 후 라이브 서버에 경험의 메시지 게시:

  1. 크리에이터 대시보드에서 API 키를 생성하고 안전한 위치에 복사하십시오 및 다음 설정을 수행하십시오:

    1. 메시징 서비스 를 액세스 권한 에 추가합니다.
    2. 경험을 선택하고 universe-messaging-service:publish 작업을 추가합니다.

  2. 경험에 대한 우주 ID 를 가져오세요:

    1. 탐색하여 크리에이터 대시보드로 이동합니다.

    2. 메시지를 게시하려는 경험을 찾으십시오.

    3. 경험의 썸네일 섬네일이동하고 ⋯ 버튼을 클릭하고 우주 ID 복사 를 선택합니다.

  3. 이 예제와 같이 API 키와 유니버스를 POST 요청에 추가하십시오.

    메시지 게시 요청 예시
    curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}:publishMessage' \

    -H 'x-api-key: {api-key}' \

    -H 'Content-Type: application/json' \

    --data '{

     "topic": "your-topic",

     "message": "Hello, everyone!"

    }'

  4. 메시지를 게시하기 위한 HTTP 요청을 보내십시오.

메시징 서비스 API를 OAuth 2.0 앱에 추가

사용자가 자신의 라이브 서버에 메시지를 게시할 수 있는 OAuth 2.0 응용 프로그램을 생성할 수 있습니다.

응용 프로그램에 메시징 서비스 API를 사용하고 사용자로부터 권한을 요청하려면 다음 설정을 수행하십시오:

  1. 응용 프로그램을 등록할 때 , 권한 아래에서 , 유니버스 메시징 서비스:public 범위를 선택합니다.When registering your application , under Permissions , select the univers-messaging-service:publish scope.

  2. 권한 흐름을 구현할 때 , 사용자를 응용 프로그램으로 다시 리디렉션하는 권한 URL의 매개 변수에 를 포함하십시오, 다음 예와 같이:

    https://authorize.roblox.com?client_id=816547628409595165403873012&redirect_uri=https://my-app.com/redirect&scope=openid+universe-messaging-service:publish&response_type=Code&prompts=login+consent&nonce=12345&state=6789

  3. 사용자가 메시지를 게시하려는 경험의 universeId에 액세스 요청을 요청하십시오.응용 프로그램은 액세스 토큰, 클라이언트 ID 및 비밀 또는 , 사용자 권한 흐름의 구현에 따라 토큰 리소스 끝점에 요청을 보낼 수 있습니다. 사용자가 허용한 경험 목록을 가져오기 위한 요청 매개변수로:

    예제 요청
    curl --location --request POST 'https://apis.roblox.com/oauth/v1/token/resources' \

    --header 'Content-Type: application/x-www-form-urlencoded' \

    --data-urlencode 'token=<access_token>' \

    --data-urlencode 'client_id=<client_id>' \

    --data-urlencode 'client_secret=<client_secret>'

    이 끝점은 다음 예시 응답과 같은 목록을 반환합니다 universeIds:

    예시 응답
    {

      "resource_infos": [

        {

          "owner": {

            "id": "1516563360",

            "type": "User"

          },

          "resources": {

            "universe": {

              "ids": ["3828411582"]

            }

          }

        }

      ]

    }

  4. 응용 프로그램은 사용자가 허용한 모든 경험에 메시지를 보낼 수 있습니다.요청을 보낼 때 권한 헤더에 액세스 토큰을 포함하고 요청 URI에서 universeId 및 주제를 다음 형식으로 포함하십시오:

    예제 요청
    curl --location --request POST 'https://apis.roblox.com/cloud/v2/universes/{universe}:publishMessage' \

    --header 'Authorization: Bearer <access_token>' \

    --header 'Content-Type: application/json' \

    --data-raw '{"topic": "some-topic","message":"message to publish"}'