Przewodnik użytkowania dotyczący publikacji miejsc

API publikacji miejsc oferuje funkcjonalność podobną do publikowania na Robloxie w Studio, z dodatkowymi kontrolami uprawnień i automatyzacją w ciągłym procesie wydania. Możesz użyć tego API do aktualizacji istniejących miejsc gry do nowej wersji, co czyni go przydatnym do automatyzacji przepływu publikacji. Na przykład możesz wywołać to API z akcji GitHub i automatycznie przesłać plik miejsca binarnego do Roblox po pomyślnym teście integracji.

Ograniczenia

• To API obsługuje tylko żądania HTTPS.
• API publikacji miejsc nie aktualizuje niektórych typów instancji. Jeśli twoja gra zawiera instancje EditableImage, EditableMesh, PartOperation, SurfaceAppearance lub BaseWrap, publikuj z poziomu Studio po ich modyfikacji.

Miejsca na Robloxie

Gry na Robloxie mogą mieć wiele miejsc, z jednym miejscem startowym jako punktem wejścia dla użytkownika do twojej gry oraz opcjonalnymi innymi miejscami, między którymi możesz teleportować użytkowników. Możesz użyć API do publikowania zarówno miejsca startowego, jak i innych miejsc w grze z kontrolą wersji.

Zanim będziesz mógł zaktualizować istniejące miejsce gry, potrzebujesz ID miejsca oraz ID uniwersum gry. ID miejsca identyfikuje miejsce, a ID uniwersum identyfikuje grę. Każde z nich jest unikalne, nawet jeśli twoja gra ma tylko jedno miejsce.

Publikowanie miejsca

Aby opublikować istniejące miejsce gry z użyciem API publikacji miejsc:

1. Utwórz klucz API na Panelu twórcy. Upewnij się, że wykonujesz następujące ustawienia:

   1. Dodaj universe-places do Uprawnień dostępu.
   2. Dodaj operację Zapis do wybranej gry.

2. Uzyskaj ID uniwersum gry, w której chcesz opublikować miejsce.

   1. Przejdź do Panelu twórcy.

   2. Znajdź grę z miejscem, które chcesz zaktualizować.

   3. Najedź kursorem na miniaturę gry, kliknij przycisk ⋯ i wybierz Kopiuj ID uniwersum.

      

3. Uzyskaj ID miejsca, które chcesz zaktualizować.

   1. Pozostań na stronie Tworzenie na Panelu twórcy i kliknij miniaturę docelowej gry.
   2. W lewym menu nawigacyjnym kliknij zakładkę Miejsca.
   3. Znajdź miejsce, które chcesz zaktualizować, i kliknij jego miniaturę.
   4. ID miejsca znajduje się w przekierowanym URL. Na przykład, w URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,, ID miejsca to 111111.

4. Dodaj klucz API w nagłówku x-api-key żądania POST do API. Poniższe dwa przykłady żądań odnoszą się do pliku miejsca w formacie XML (.rbxlx) oraz pliku miejsca binarnego (.rbxl).

   Żądanie pliku miejsca XML
   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <twój-klucz-api>' \
   --header 'Content-Type: application/xml' \
   --data-binary @/home/placefiles/place1.rbxlx

   Żądanie pliku miejsca binarnego
   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <twój-klucz-api>' \
   --header 'Content-Type: application/octet-stream' \
   --data-binary @/home/placefiles/place1.rbxl

   Aby uruchomić polecenia, zamień {universeId} i {placeId} na rzeczywiste ID uniwersum i ID miejsca gry, które chcesz opublikować.

5. Jeśli poprawnie wyślesz swoje żądanie, otrzymasz odpowiedź z ciałem sukcesu z numerem wersji miejsca w następującym formacie:

   Przykład ciała odpowiedzi
   { "versionNumber": 7 }

6. (Opcjonalnie) Zweryfikuj przesłanie w Studio lub na Panelu twórcy.