Gebrauchsanleitung für das Veröffentlichen von Orten | Dokumentation

Die API zum Veröffentlichen von Orten bietet ähnliche Funktionen wie das Veröffentlichen in Roblox im Studio, mit zusätzlicher Berechtigungssteuerung und Automatisierung im kontinuierlichen Veröffentlichungsworkflow. Sie können diese API verwenden, um vorhandene Orte eines Spiels auf eine neue Version zu aktualisieren, was sie nützlich für die Automatisierung Ihres Veröffentlichungsworkflows macht. Zum Beispiel können Sie diese API aus einer GitHub-Aktion aufrufen und eine binäre Platzdatei automatisch nach erfolgreichem Integrationstest an Roblox übertragen.

Einschränkungen

Diese API unterstützt nur HTTPS-Anfragen.
Die API zum Veröffentlichen von Orten aktualisiert bestimmte Instanztypen nicht. Wenn Ihr Spiel EditableImage, EditableMesh, PartOperation, SurfaceAppearance oder BaseWrap-Instanzen enthält, veröffentlichen Sie nach der Modifikation über das Studio.

Orte auf Roblox

Spiele auf Roblox können mehrere Orte haben, mit einem Startort als Einstiegspunkt des Benutzers in Ihr Spiel und optionalen anderen Orten, zwischen denen Sie die Benutzer teleportieren können. Sie können die API verwenden, um entweder den Startort oder andere Orte Ihres Spiels mit Versionskontrolle zu veröffentlichen.

Bevor Sie einen bestehenden Ort eines Spiels aktualisieren können, benötigen Sie die Ort-ID und die Universum-ID des Spiels. Die Ort-ID identifiziert den Ort und die Universum-ID identifiziert das Spiel. Jede ist einzigartig, auch wenn Ihr Spiel nur einen Ort hat.

Einen Ort veröffentlichen

Um einen bestehenden Ort eines Spiels mit der Place Publishing API zu veröffentlichen:

Erstellen Sie einen API-Schlüssel im Creator Dashboard. Stellen Sie sicher, dass Sie die folgenden Einstellungen vornehmen:
1. Fügen Sie universe-places zu Zugriffsberechtigungen hinzu.
2. Fügen Sie die Write-Operation zu Ihrem ausgewählten Spiel hinzu.
Holen Sie sich die Universum-ID des Spiels, in dem Sie den Ort veröffentlichen möchten.
1. Navigieren Sie zum Creator Dashboard.
2. Suchen Sie das Spiel mit dem Ort, den Sie aktualisieren möchten.
3. Fahren Sie mit der Maus über das Thumbnail des Spiels, klicken Sie auf die ⋯-Schaltfläche und wählen Sie Universum-ID kopieren.
Holen Sie sich die Ort-ID des Ortes, den Sie aktualisieren möchten.
1. Bleiben Sie auf der Seite Erstellungen im Creator Dashboard und klicken Sie auf das Thumbnail des Zielspiels.
2. Klicken Sie im linken Navigationsmenü auf die Registerkarte Orte.
3. Suchen Sie den Ort, den Sie aktualisieren möchten, und klicken Sie auf sein Thumbnail.
4. Die Ort-ID befindet sich in der umgeleiteten URL. Zum Beispiel, in der URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,ist die **Ort-ID**111111`.

Fügen Sie den API-Schlüssel im x-api-key-Header einer POST-Anfrage an die API hinzu. Die folgenden beiden Beispielanfragen beziehen sich auf eine Roblox XML-Platzdatei (.rbxlx) und eine binäre Platzdatei (.rbxl).

XML Platzdatei Anfrage
$ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/xml' \
--data-binary @/home/placefiles/place1.rbxlx

Binäre Platzdatei Anfrage
$ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/octet-stream' \
--data-binary @/home/placefiles/place1.rbxl

Um die Befehle auszuführen, ersetzen Sie {universeId} und {placeId} durch die tatsächliche Universum-ID und Ort-ID des Spiels und des Ortes, den Sie veröffentlichen möchten.

Wenn Sie Ihre Anfrage korrekt senden, erhalten Sie einen Erfolgsantwortkörper mit der Versionsnummer des Ortes im folgenden Format:
```
Beispiel Antwortkörper
{ "versionNumber": 7 }
```
(Optional) Überprüfen Sie den Upload im Studio oder im Creator Dashboard.