*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Universe

Reprezentuje doświadczenie Roblox.

Atrybuty

pathstring

Ścieżka zasobów wszechświata.

Format: universes/{universe_id}.

createTimestring

Tylko dane wyjściowe

Data stworzenia czasu, gdy wszechświat został stworzony. Ten ciąg jest sformatowany jako Timestamp.

updateTimestring

Tylko dane wyjściowe

Data czasu, kiedy wszechświat został po raz ostatni zaktualizowany. Ten ciąg jest sformatowany jako Timestamp.

displayNamestring

Tylko dane wyjściowe

Nazwa wszechścia.

Pole to można zaktualizować poprzez zaktualizowanie nazwy głównego miejsca.

descriptionstring

Tylko dane wyjściowe

Opis wszechświata.

Pole to można zaktualizować poprzez zaktualizowanie opisu korzennego miejsca.

Jedna z następujących dla owner:

userstring

Tylko dane wyjściowe

Wszechświat jest własnością użytkownika.

groupstring

Tylko dane wyjściowe

Wszechświat jest własnością grupy.

visibilityEnum<string>

Tylko dane wyjściowe

Czy wszechświat jest publicznie dostępny, czy nie.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | VISIBILITY_UNSPECIFIED | Aktualizacje za pomocą tej wartości spowodują błąd na tylnej stronie.| | PUBLICZNE | Wszechświat jest publiczny.| | PRYWATNY | Wszechświat jest prywatny.Jeśli widoczność wszechświata jest ustawiona na PRYWATNĄ, wszystkie aktywne gracze zostaną natychmiast usunięci ze wszystkich działających serwerów. |. Możliwe wartości:

facebookSocialLinkobject

Link społecznościowy Facebooka.

twitterSocialLinkobject

Link społecznościowy Twittera.

youtubeSocialLinkobject

Link społecznościowy na YouTube.

twitchSocialLinkobject

Społeczny link Twitch.

discordSocialLinkobject

Społeczny link Discord.

robloxGroupSocialLinkobject

Społeczny link grupy Roblox.

guildedSocialLinkobject

Społeczny link Guilded.

voiceChatEnabledboolean

Czy czat głosowy jest włączony dla użytkowników w doświadczeniu, czy nie.

Aktualizacja tej wartości nie wpłynie na aktywne serwery.

ageRatingEnum<string>

Tylko dane wyjściowe

Ocena wieku tego wszechświata.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | AGE_RATING_UNSPECIFIED | Ocena wieku nie jest ustawiona.| | Wiek_ocena_wszystkich | Wspierany dla wszystkich użytkowników| | AGE_RATING_9_PLUS | Wspierany dla użytkowników w wieku 9 lat i powyżej.| | AGE_RATING_13_PLUS | Wspierany dla użytkowników w wieku 13 lat i powyżej.| | AGE_RATING_17_PLUS | Wspierany dla użytkowników w wieku 17 lat i powyżej. |. Możliwe wartości:

privateServerPriceRobuxnumber

Reprezentuje cenę w Robux prywatnych serwerów.

Jeśli nie zaznaczono, prywatne serwery nie są wspierane dla tego wszechświata.

Można go wyłączyć tylko przy użyciu maski pola.

Ustawienie na null wyłączy wszystkie aktywne prywatne serwery.

Zmiana ceny anuluje wszystkie subskrypcje prywatnych serwerów.

desktopEnabledboolean

Czy gracze mogą dołączyć do doświadczenia za pośrednictwem komputera czy nie.

mobileEnabledboolean

Czy gracze mogą dołączyć do doświadczenia za pośrednictwem urządzenia mobilnego, czy nie.

tabletEnabledboolean

Czy gracze mogą dołączyć do doświadczenia za pośrednictwem tabletu, czy nie.

consoleEnabledboolean

Czy gracze mogą dołączyć do doświadczenia za pośrednictwem konsoli czy nie.

vrEnabledboolean

Czy gracze mogą dołączyć do doświadczenia za pośrednictwem VR, czy nie.

Podstawowy adres URL

https://apis.roblox.com

Zasób 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

Zdobądź wszechświat

GET /cloud/v2/universes/{universe_id}

Zdobywa określone wszechświaty.

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

Odpowiedź:Universe

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

Odpowiedź:

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

Aktualizacja wszechświata

PATCH /cloud/v2/universes/{universe_id}

Aktualizuje określony wszechświat.

Ta metoda jest gwarantowana do zwracania wszystkich zaktualizowanych pól. Ta metoda może również zwracać pełną zasób.

Zakresy

universe:write

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

Parametry zapytania

updateMaskstring

Lista pól do aktualizacji. Ten ciąg jest sformatowany jako FieldMask.

Treść żądaniaUniverse

Odpowiedź:Universe

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

Odpowiedź:

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

Opublikuj wiadomość wszechświata
Beta

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

Opublikuj wiadomość na żywych serwerach wszechświata.

Serwery mogą odbierać wiadomości za pośrednictwem Usługi wysyłania wiadomości.

Zakresy

universe-messaging-service:publish

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

Treść żądania

topicstring

Temat, na który ma być opublikowana wiadomość.

messagestring

Wiadomość do opublikowania.

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

Uruchom ponownie serwery wszechświata

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

Restartuje wszystkie aktywne serwery dla określonego wszechświata, jeśli i tylko jeśli opublikowano nową wersję doświadczenia.Używany do uwalniania aktualizacji doświadczenia.

Zakresy

universe:write

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

Treść żądania

Odpowiedź:

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

Odpowiedź:

{}

Universe

Atrybuty

Universe

Zdobądź wszechświat

Universe

Aktualizacja wszechświata

Universe

Opublikuj wiadomość wszechświataBeta

Universe

Uruchom ponownie serwery wszechświata

Opublikuj wiadomość wszechświata
Beta