*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

Universe

Representa una experiencia de Roblox.

Atributos

pathstring

El camino de recursos del universo.

Formato: universes/{universe_id}.

createTimestring

Solo salida

La fecha y hora en que se creó el universo. Esta cadena está formateada como Timestamp.

updateTimestring

Solo salida

La fecha y hora en que se actualizó por última vez el universo. Esta cadena está formateada como Timestamp.

displayNamestring

Solo salida

El nombre del universo.

Este campo se puede actualizar actualizando el nombre del lugar raíz.

descriptionstring

Solo salida

La descripción del universo.

Este campo se puede actualizar actualizando la descripción del lugar raíz.

Uno de los siguientes para owner:

userstring

Solo salida

El universo es de propiedad del usuario.

groupstring

Solo salida

El universo es propiedad de un grupo.

visibilityEnum<string>

Solo salida

Si el universo es o no accesible públicamente.

Posibles valores:

| Valor | Descripción | | --- | --- | | VISIBILIDAD_NO_ESPECIFICADA | Las actualizaciones que usen este valor lanzarán un error en el backend.| | PÚBLICO | El universo es público.| | PRIVADO | El universo es servidor privado.Si la visibilidad de un universo está configurada como PRIVADA, todos los jugadores activos se eliminarán inmediatamente de todos los servidores en ejecución. |. Valores posibles:

facebookSocialLinkobject

El enlazarsocial de Facebook.

twitterSocialLinkobject

El enlazarsocial de Twitter.

youtubeSocialLinkobject

El enlazarsocial de YouTube.

twitchSocialLinkobject

El enlazarsocial de Twitch.

discordSocialLinkobject

El enlazarsocial de Discord.

robloxGroupSocialLinkobject

El enlazarsocial del grupo de Roblox.

guildedSocialLinkobject

El enlazarsocial de Guilded.

voiceChatEnabledboolean

Si el chat de voz está habilitado o no para los usuarios en la experiencia.

Actualizar este valor no afectará a los servidores activos.

ageRatingEnum<string>

Solo salida

La calificación de edad de este universo.

Posibles valores:

| Valor | Descripción | | --- | --- | | AGE_RATING_UNSPECIFIED | La calificación de edad no se establecer.| | AGE_RATING_ALL | Soportado para todos los usuarios.| | AGE_RATING_9_PLUS | Soportado para usuarios de 9 años o más.| | AGE_RATING_13_PLUS | Soportado para usuarios de 13 años o más.| | AGE_RATING_17_PLUS | Soportado para usuarios de 17 años o más. |. Valores posibles:

privateServerPriceRobuxnumber

Representa el precio en Robux de servidores privados.

Si no está desactivado, los servidores privados no se admiten para este universo.

Solo se puede desactivar cuando se usa una máscara de campo.

Establecer a nulo desactivará todos los servidores privados activos.

Cambiar el precio cancelará todas las suscripciones de servidor privado.

desktopEnabledboolean

Si los jugadores pueden o no unirse a la experiencia a través del escritorio.

mobileEnabledboolean

Si los jugadores pueden o no unirse a la experiencia a través del móvil.

tabletEnabledboolean

Si los jugadores pueden o no unirse a la experiencia a través de la tableta.

consoleEnabledboolean

Si los jugadores pueden unirse a la experiencia a través de la consola o no.

vrEnabledboolean

Si los jugadores pueden o no unirse a la experiencia a través de VR.

URL base

https://apis.roblox.com

El 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}

Obtiene el universo especificado.

SolicitudParámetros de ruta

universe_idstring

Obligatorio

La identificación del universo.

RespuestaUniverse

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}'

Respuesta

{
  "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}

Actualiza el universo especificado.

Este método está garantizado para devolver todos los campos actualizados. Este método también puede devolver la totalidad de la recursos.

Ámbitos

universe:write

SolicitudParámetros de ruta

universe_idstring

Obligatorio

La identificación del universo.

Parámetros de consulta

updateMaskstring

La lista de campos para actualización. Esta cadena está formateada como Timestamp.

Solicitar cuerpoUniverse

RespuestaUniverse

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
}'

Respuesta

{
  "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 un mensaje a los servidores en vivo del universo.

Los servidores pueden consumir mensajes a través de Servicio de mensajería.

Ámbitos

universe-messaging-service:publish

SolicitudParámetros de ruta

universe_idstring

Obligatorio

La identificación del universo.

Solicitar cuerpo

topicstring

El tema en el que publicar el mensaje.

messagestring

El mensaje 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 los servidores activos para un universo específico si y solo si se ha publicado una nueva versión de la experiencia.Se utiliza para publicar actualizaciones de experiencia.

Ámbitos

universe:write

SolicitudParámetros de ruta

universe_idstring

Obligatorio

La identificación del universo.

Solicitar cuerpo

Respuesta

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 '{}'

Respuesta

{}

Universe

Atributos

Universe

Get Universe

Universe

Update Universe

Universe

Publish Universe MessageBeta

Universe

Restart Universe Servers

Publish Universe Message
Beta