*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Universe

Representa uma experiência do Roblox.

Atributos

pathstring

O caminho de recursos do universo.

Formato: universes/{universe_id}.

createTimestring

Apenas saída

O timestamp quando o universo foi criado. Esta cadeia de caracteres é formatada como um Timestamp.

updateTimestring

Apenas saída

O timestamp quando o universo foi atualizado pela última vez. Esta cadeia de caracteres é formatada como um Timestamp.

displayNamestring

Apenas saída

O nome do universo.

Este campo pode ser atualizado atualizando o nome do local raiz.

descriptionstring

Apenas saída

A descrição do universo.

Este campo pode ser atualizado atualizando a descrição do local raiz.

Um dos seguintes para owner:

userstring

Apenas saída

O universo é propriedade do usuário.

groupstring

Apenas saída

O universo é de propriedade do grupo.

visibilityEnum<string>

Apenas saída

Se o universo é ou não é acessível publicamente.

Valores possíveis:

| Valor | Descrição | | --- | --- | | VISIBILITY_UNSPECIFIED | Atualizações usando este valor vão lançar um erro no backend.| | PÚBLICO | O universo é público.| | PRIVADO | O universo é privado.Se a visibilidade de um universo for definida como PRIVADA, todos os jogadores ativos serão imediatamente removidos de todos os servidores em execução. |. Valores possíveis:

facebookSocialLinkobject

O víncular / conectarsocial do Facebook.

twitterSocialLinkobject

O víncular / conectarsocial do Twitter.

youtubeSocialLinkobject

O víncular / conectarsocial do Youtube.

twitchSocialLinkobject

O víncular / conectarsocial da Twitch.

discordSocialLinkobject

O víncular / conectarsocial do Discord.

robloxGroupSocialLinkobject

O víncular / conectarsocial do grupo Roblox.

guildedSocialLinkobject

O víncular / conectarsocial Guilded.

voiceChatEnabledboolean

Se o chat de voz está habilitado ou não para os usuários na Experiência.

Atualizar este valor não afetará servidores ativos.

ageRatingEnum<string>

Apenas saída

A classificação etária deste universo.

Valores possíveis:

| Valor | Descrição | | --- | --- | | AGE_RATING_UNSPECIFIED | A classificação de idade não é configurar.| | AGE_RATING_ALL | Suportado para todos os usuários.| | AGE_RATING_9_PLUS | Suportado para usuários com idade 9 e acima.| | AGE_RATING_13_PLUS | Suportado para usuários com idade 13 e acima.| | AGE_RATING_17_PLUS | Suportado para usuários com idade 17 e acima. |. Valores possíveis:

privateServerPriceRobuxnumber

Representa o preço em Robux de servidores privados.

Se desmarcado, servidores privados não são suportados para esse universo.

Só pode ser desativado ao usar uma máscara de campo.

Definir para nulo desabilitará todos os servidores privados ativos.

Alterar o preço cancelará todas as assinaturas de servidor privado.

desktopEnabledboolean

Se os jogadores podem ou não se juntar à Experiência via Desktop.

mobileEnabledboolean

Se os jogadores podem ou não se juntar à Experiência via Mobile.

tabletEnabledboolean

Se os jogadores podem ou não se juntar à Experiência via Tablet.

consoleEnabledboolean

Se os jogadores podem ou não se juntar à Experiência via Console.

vrEnabledboolean

Se os jogadores podem ou não se juntar à Experiência via VR.

URL base

https://apis.roblox.com

O recurso Universe

{
  "path": "universes/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

Get Universe

GET /cloud/v2/universes/{universe_id}

Obtém o universo especificado.

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

RespostaUniverse

GET /cloud/v2/universes/{universe_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}' \
  -H 'x-api-key: {your-api-key}'

Resposta

{
  "path": "universes/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

Update Universe

PATCH /cloud/v2/universes/{universe_id}

Atualiza o universo especificado.

Este método é garantido para retornar todos os campos atualizados. Este método também pode retornar a totalidade do recurso.

Escopos

universe:write

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

Parâmetros da consulta

updateMaskstring

A lista de campos para atualização. Esta cadeia de caracteres está formatada como um FieldMask.

Requisitar corpoUniverse

RespostaUniverse

PATCH /cloud/v2/universes/{universe_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}?updateMask={string}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}'

Resposta

{
  "path": "universes/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

Publish Universe Message
Beta

POST /cloud/v2/universes/{universe_id}:publishMessage

Publica uma mensagem nos servidores ativos do universo.

Os servidores podem consumir mensagens via Serviço de Mensageria.

Escopos

universe-messaging-service:publish

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

Requisitar corpo

topicstring

O tópico em que publicar a mensagem.

messagestring

A mensagem para publicar.

POST /cloud/v2/universes/{universe_id}:publishMessage

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "topic": "my-topic",
  "message": "Hello, world!"
}'

Universe

Restart Universe Servers

POST /cloud/v2/universes/{universe_id}:restartServers

Reinicia todos os servidores ativos para um universo específico se e somente se uma nova versão da experiência foi publicada.Usado para liberar atualizações de experiência.

Escopos

universe:write

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

Requisitar corpo

Resposta

POST /cloud/v2/universes/{universe_id}:restartServers

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:restartServers' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{}'

Resposta

{}

Universe

Atributos

Universe

Get Universe

Universe

Update Universe

Universe

Publish Universe MessageBeta

Universe

Restart Universe Servers

Publish Universe Message
Beta