Die Platz-Veröffentlichungs-API bietet eine ähnliche Funktionalität wie Veröffentlichung auf Roblox in Studio, mit zusätzlicher Berechtigungskontrolle und Automatisierung im kontinuierlichen Freigabe-Workflow.Sie können diese API verwenden, um bestehende Orte eines Erlebnisses auf eine neue Version zu aktualisieren, wodurch sie für die Automatisierung Ihres Publikationsworkflows nützlich wird.Zum Beispiel können Sie diese API von einer GitHub-Aktion aus aufrufen und sie automatisch einen binären Platzdatei-Ordner auf Roblox pushen, nachdem die erfolgreiche Integrationstests abgeschlossen sind.
Beschränkungen
- Diese API unterstützt nur HTTPS-Anfragen.
- Die Platzveröffentlichungs-API aktualisiert bestimmte Instanztypen nicht.Wenn deine Erfahrung EditableImage, EditableMesh, PartOperation, SurfaceAppearance oder BaseWrap Beispiele enthält, veröffentliche sie nach ihrer Änderung aus Studio.
Orte auf Roblox
Erlebnisse auf Roblox können mehrere Orte haben, mit einem Startplatz als Benutzeingangspunkt deiner Erfahrung und optionalen anderen Orten, die du Benutzer zwischen teleportieren kannst.Du kannst die API verwenden, um entweder den Startplatz oder andere Orte deiner Erfahrung mit Versionskontrolle zu veröffentlichen.
Bevor du einen bestehenden Ort eines Erlebnisses aktualisieren kannst, benötigst du die Platz-ID des Ortes und die Universitäts-ID des Erlebnisses.Die Platz-ID identifiziert den Ort und die Universum-ID identifiziert das Erlebnis.Jede ist einzigartig, auch wenn deine Erfahrung nur einen Ort hat.
Veröffentliche einen Ort
Um einen bestehenden Ort eines Erlebnisses mit Platzveröffentlichungs-API zu veröffentlichen:
Erstelle einen API-Schlüssel auf dem Creator-Dashboard . Stelle sicher, dass du die folgenden Einstellungen durchführst:
- Füge Universum-Plätze zu Zugriffsberechtigungen hinzu.
- Füge Schreiben -Operation zu deiner ausgewählten Erlebnishinzu.
Holen Sie sich die Universitäts-ID des Erlebnisses, in dem Sie den Ort veröffentlichen möchten.
Navigiere zum Creator-Dashboard.
Finde das Erlebnis mit dem Ort, den du Updatemöchtest.
Bewegen Sie den Mauszeiger über die Miniaturansicht des Erlebnisses, klicken Sie auf die Schaltfläche ⋯ und wählen Sie Universum-ID kopieren .
Holen Sie sich die Platz-ID des Ortes, den Sie Updatemöchten.
- Bleiben Sie auf der Kreationen Seite auf Creator-Dashboard und klicken Sie auf das Vorschaubild der Erlebnis.
- Klicken Sie im linken Navigationsmenü auf die Registerkarte Orte .
- Finde den Ort, den du aktualisieren möchtest, und klicke auf sein Miniaturansicht.
- Die Platz-ID ist in der umgeleiteten URL. Zum Beispiel ist die Platz-ID in der URL .
Füge den API-Schlüssel in den x-api-key -Header einer POST an die API hinzu.Die folgenden zwei Beispielanfragen beziehen sich auf eine XML-Platzdatei ( .rbxlx ) und eine binäre Platzdatei ( .rbxl ).
XML-Platzierungsdateianfrage$ 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.rbxlxBinary-Platz-Dateianfrage$ 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.rbxlUm die Befehle auszuführen, ersetze {universeId} und {placeId} durch die tatsächliche Universitäts-ID und Platz-ID des Erlebnisses und platziere das, was du veröffentlichen möchtest.
Wenn du deine Anfrage korrekt sendest, erhältst du eine Erfolgantwort mit der Platzversionnummer im folgenden Format:
Beispiel-Antwortkörper{ "versionNumber": 7 }(Optional) Überprüfen Sie den Upload in Studio oder auf Creator-Dashboard.