*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Universe

Repräsentiert eine Erlebnis.

Attribute

pathstring

Der Ressourcenpfad des Universums.

Format: universes/{universe_id}.

createTimestring

Nur Ausgabe

Der Zeitpunkt, an dem das Universum erstellt wurde. Dieser String ist als Zeitstempel formatiert.

updateTimestring

Nur Ausgabe

Der Zeitpunkt, zu dem das Universum zuletzt aktualisiert wurde. Dieser String ist als Zeitstempel formatiert.

displayNamestring

Nur Ausgabe

Der Name des Universums.

Dieses Feld kann aktualisiert werden, indem der Name des Ortaktualisiert wird.

descriptionstring

Nur Ausgabe

Die Beschreibung des Universums.

Dieses Feld kann aktualisiert werden, indem die Beschreibung des Ortaktualisiert wird.

Eins der folgenden für owner:

userstring

Nur Ausgabe

Das Universum ist benutzereigen.

groupstring

Nur Ausgabe

Das Universum ist gruppeneigen.

visibilityEnum<string>

Nur Ausgabe

Ob das Universum öffentlich zugänglich ist oder nicht.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | VISIBILITY_UNSPECIFIED | Aktualisierungen mit diesem Wert werden auf dem Backend einen Fehler werfen.| | ÖFFENTLICH | Das Universum ist öffentlich.| | PRIVAT | Das Universum ist privater Server.Wenn die Sichtbarkeit eines Universums auf PRIVAT eingestellt ist, werden alle aktiven Spieler sofort von allen laufenden Servern entfernt. |. Mögliche Werte:

facebookSocialLinkobject

Der verlinken.

twitterSocialLinkobject

Der verlinken.

youtubeSocialLinkobject

Der verlinken.

twitchSocialLinkobject

Der verlinken.

discordSocialLinkobject

Der verlinken.

robloxGroupSocialLinkobject

Der verlinken.

guildedSocialLinkobject

Der verlinken.

voiceChatEnabledboolean

Ob Voice-Chat für Benutzer im Erlebnis aktiviert ist oder nicht.

Das Aktualisieren dieses Werts wirkt sich nicht auf aktive Server aus.

ageRatingEnum<string>

Nur Ausgabe

Die Altersbewertung dieses Universums.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | AGE_RATING_UNSPECIFIED | Das Alter wird nicht festlegen.| | AGE_RATING_ALL | Unterstützt für alle Benutzer.| | AGE_RATING_9_PLUS | Unterstützung für Benutzer im Alter von 9 und mehr.| | AGE_RATING_13_PLUS | Unterstützung für Benutzer im Alter von 13 Jahren und höher.| | AGE_RATING_17_PLUS | Unterstützung für Benutzer im Alter von 17 und mehr. |. Mögliche Werte:

privateServerPriceRobuxnumber

Repräsentiert den Preis in Robux für private Server.

Wenn nicht gesetzt, werden private Server für dieses Universum nicht unterstützt.

Kann nur deaktiviert werden, wenn ein Feldmask verwendet wird.

Die Einstellung auf null deaktiviert alle aktiven privaten Server.

Das Ändern des Preises wird alle privaten Server-Abonnements kündigen.

desktopEnabledboolean

Ob Spieler über den Desktop der Erfahrung beitreten können oder nicht.

mobileEnabledboolean

Ob Spieler über Mobilgeräte oder nicht der Erfahrung beitreten können.

tabletEnabledboolean

Ob Spieler oder nicht über Tablet der Erfahrung beitreten können.

consoleEnabledboolean

Ob Spieler über die Konsole der Erfahrung beitreten können oder nicht.

vrEnabledboolean

Ob Spieler oder nicht mit der Erfahrung über VR beitreten können.

Basis-URL

https://apis.roblox.com

Die Universe-Ressource

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

Holt das angegebene Universum.

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

RückmeldungUniverse

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ückmeldung

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

Aktualisiert das angegebene Universum.

Diese Methode garantiert, dass alle aktualisierten Felder zurückgegeben werden. Diese Methode kann zusätzlich die volle Ressource zurückgeben.

Bereiche

universe:write

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

Anfrageparameter

updateMaskstring

Die Liste der zu UpdateFelder. Dieser String ist als FieldMask formatiert.

Text anfordernUniverse

RückmeldungUniverse

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ückmeldung

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

Veröffentlicht eine Nachricht auf die lebenden Server des Universums.

Server können Nachrichten über MessagingService verbrauchen.

Bereiche

universe-messaging-service:publish

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

Text anfordern

topicstring

Das Thema, auf dem die Nachricht veröffentlicht werden soll.

messagestring

Die Nachricht zum veröffentlichen.

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

Starte alle aktiven Server für ein bestimmtes Universum neu, wenn und nur wenn eine neue Version des Erlebnisses veröffentlicht wurde.Wird verwendet, um Erfahrungsaktualisierungen zu veröffentlichen.

Bereiche

universe:write

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

Text anfordern

Rückmeldung

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ückmeldung

{}

Universe

Attribute

Universe

Get Universe

Universe

Update Universe

Universe

Publish Universe MessageBeta

Universe

Restart Universe Servers

Publish Universe Message
Beta