*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Universe

Représente une expérience Roblox.

Attributs

pathstring

Le chemin de ressource de l'univers.

Format : universes/{universe_id}.

createTimestring

Sortie seule

La date et l'heure de création de l'univers. Ce string est formatée en tant que Timestamp.

updateTimestring

Sortie seule

La date et l'heure de la dernière mise à jour de l'univers. Ce string est formatée en tant que Timestamp.

displayNamestring

Sortie seule

Le nom de l'univers.

Ce champ peut être mis à jour en mettant à jour le nom du lieu racine.

descriptionstring

Sortie seule

La description de l'univers.

Ce champ peut être mis à jour en mettant à jour la description du lieu racine.

Un des éléments suivants pour owner:

userstring

Sortie seule

L'univers est possédé par l'utilisateur.

groupstring

Sortie seule

L'univers est détenu par un groupe.

visibilityEnum<string>

Sortie seule

Si l'univers est ou non accessible publiquement.

Valeurs possibles :

| Valeur | Description | | --- | --- | | VISIBILITY_UNSPECIFIED | Les mises à jour utilisant cette valeur provoqueront une erreur sur le backend.| | PUBLIC | L'univers est public.| | PRIVÉ | L'univers est privé.Si la visibilité d'un univers est réglée sur PRIVÉ, tous les joueurs actifs seront immédiatement retirés de tous les serveurs en cours d'exécution. |. Valeurs possibles :

facebookSocialLinkobject

Le lien social Facebook.

twitterSocialLinkobject

Le lien social Twitter.

youtubeSocialLinkobject

Le lien social YouTube.

twitchSocialLinkobject

Le lien social Twitch.

discordSocialLinkobject

Le lien social Discord.

robloxGroupSocialLinkobject

Le lien social du groupe Roblox.

guildedSocialLinkobject

Le lien social Guilded.

voiceChatEnabledboolean

Si oui ou non le chat vocal est activé pour les utilisateurs dans l'expérience.

Mettre à jour cette valeur n'affectera pas les serveurs actifs.

ageRatingEnum<string>

Sortie seule

Le classement par âge de cet univers.

Valeurs possibles :

| Valeur | Description | | --- | --- | | AGE_RATING_UNSPECIFIED | Le classement d'âge n'est pas défini.| | AGE_RATING_ALL | Soutenu pour tous les utilisateurs.| | AGE_RATING_9_PLUS | Soutenu pour les utilisateurs âgés de 9 ans et plus.| | AGE_RATING_13_PLUS | Soutenu pour les utilisateurs âgés de 13 ans et plus.| | AGE_RATING_17_PLUS | Soutenu pour les utilisateurs âgés de 17 ans et plus. |. Valeurs possibles :

privateServerPriceRobuxnumber

Représente le prix en Robux des serveurs privés.

Si désactivé, les serveurs privés ne sont pas pris en charge pour cet univers.

Ne peut être désactivé qu'en utilisant un masque de champ.

La définition à null désactivera tous les serveurs privés actifs.

Changer le prix annulera tous les abonnements de serveur privé.

desktopEnabledboolean

Si les joueurs peuvent ou non rejoindre l'expérience via le bureau.

mobileEnabledboolean

Si les joueurs peuvent ou non rejoindre l'expérience via mobile.

tabletEnabledboolean

Si les joueurs peuvent ou non rejoindre l'expérience via une tablette.

consoleEnabledboolean

Si les joueurs peuvent ou non rejoindre l'expérience via la console.

vrEnabledboolean

Si les joueurs peuvent ou non rejoindre l'expérience via VR.

URL de base

https://apis.roblox.com

La ressource 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

Obtenir l'univers

GET /cloud/v2/universes/{universe_id}

Obtient l'univers spécifié.

Limitations

Clés API: 100 requêtes par minute pour toutes les clés API pour un utilisateur ou un groupe
OAuth 2.0: 100 requêtes par minute par utilisateur de l'application

Remarque : les limites de débit peuvent être plus basses pendant les périodes de fort trafic. Certains points d'extrémité ont des limites de débit supplémentaires. En savoir plus sur les limites de taux.

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

RéponseUniverse

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

Réponse

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

Mise à jour de l'univers

PATCH /cloud/v2/universes/{universe_id}

Mise à jour de l'univers spécifié.

Cette méthode est garantie pour retourner tous les champs mis à jour. Cette méthode peut également retourner la ressource entière.

Périmètres d'application

universe:write

Limitations

Clés API: 100 requêtes par minute pour toutes les clés API pour un utilisateur ou un groupe
OAuth 2.0: 100 requêtes par minute par utilisateur de l'application

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

Paramètres de requête

updateMaskstring

La liste des champs à mettre à jour. Cette chaîne est formatée comme un FieldMask.

Corps de la requêteUniverse

RéponseUniverse

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

Réponse

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

Publier le message de l'univers
Bêta

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

Publie un message sur les serveurs en direct de l'univers.

Les serveurs peuvent consommer des messages via MessagingService.

Périmètres d'application

universe-messaging-service:publish

Limitations

Clés API: 5000 requêtes par minute pour toutes les clés API pour un utilisateur ou un groupe
OAuth 2.0: 5000 requêtes par minute par utilisateur de l'application

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

Corps de la requête

topicstring

Le sujet sur lequel publier le message.

messagestring

Le message à publier.

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

Redémarrer les serveurs d'univers

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

Redémarre tous les serveurs actifs pour un univers spécifique si et seulement si une nouvelle version de l'expérience a été publiée.Utilisé pour publier des mises à jour d'expérience.

Périmètres d'application

universe:write

Limitations

Clés API: 30 requêtes par minute pour toutes les clés API pour un utilisateur ou un groupe
OAuth 2.0: 30 requêtes par minute par utilisateur de l'application

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

Corps de la requête

Réponse

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

Réponse

{}

Universe

Attributs

Universe

Obtenir l'univers

Universe

Mise à jour de l'univers

Universe

Publier le message de l'universBêta

Universe

Redémarrer les serveurs d'univers

Publier le message de l'univers
Bêta