Varlık Arayüzü API

*Bu içerik, yapay zekâ (beta) kullanılarak çevrildi ve hatalar içerebilir. Sayfayı İngilizce görüntülemek için buraya tıkla.

Roblox'ta varlıklar oluşturmak için aşağıdaki istek ve yanıt dosyalarını gönderebilir ve alabilirsiniz. API'nin kullanımı hakkında bilgi için Kullanım Rehberi bakın.

Assets

https://apis.roblox.com/assets

Liste Asset Versiyonları

GET /assets/v1/assets/{assetId}/versions

Seçili bir varlığın tüm versiyonlarını, seçenekli bir bölümlendirmeyle listeler.

Parametreler

assetId string

Varlığın benzersiz kimliği.

Path
Gerekli
maxPageSize number

Yanıtın içinde dahil olacak varsayılan varlık versiyonlarını belirtir. Geçerli değerler 1 ile 50 arasındadır (含). Standartlar 8 olmadan 8 olarak ayarlanır.

pageToken string

Pagination için bir jeton. Değer, daha önce bir istekten alınır ve varsayılan sayfayı kaynak versiyonlarından almak için izin verir.

Talep

List Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \

--header 'x-api-key: {apiKey}'

Yanıt

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Geriye Alma Varlık Sürümü

POST /assets/v1/assets/{assetId}/versions:rollback

Bir varlığı belirli bir önceki sürüme geri al.

Parametreler

assetId string

Varlığın benzersiz kimliği.

Path
Gerekli
assetVersion string

Kaynak biçimindeki varlık versiyonu yolunu assetId/versiyonlar/versionNumber .

FormData
Gerekli

Talep

Rollback Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions:rollback' \

--header 'x-api-key: {apiKey}' \

--header 'Content-Type: application/json' \

--data '{\"assetVersion\":\"assets/{assetId}/versions/{versionNumber}\"}'

Yanıt

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

  • Yaz

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

  • asset:write

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Erişim Alın

GET /v1/assets

Belirli varlık içeriğini ve metadını geri al.

Parametreler

assetId

Varlığın benzersiz kimliği.

Path
Gerekli
readMask string

Açıklama, görünen ad, simge, sosyal bağlantılar ve önizlemeler dahil olmak üzere varlık metadatası alanları alınır, içerik dahil. Örnekler: description%2CdisplayName , previews%2CtwitchSocialLink .

Talep

Get Asset without readMask
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \

--header 'x-api-key: {apiKey}'
Get Asset with readMask
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \

--header 'x-api-key: {apiKey}'

Yanıt

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Varlığı Oluştur

POST /v1/assets

Sunulan içerik ve metadatayla bir varlık oluşturur.

Bir varlığı oluştururken SosyalAğ nesneleri ekleyemezsiniz. Bunun yerine Varlığı Güncelle kullanın.

Parametreler

request

Yaratmak veya güncellemek için varlık özellikleri. Aşağıdaki örnek istek gibi biçimsel veriler olarak gönderin.

FormData
Gerekli
fileContent string

Eşdeğer varsayılan dosya yolunun ve içerik yazformatı. Biçim: fileContent=@"/filepath/{File}";type={ContentType} . Örnek: fileContent=@"/filepath/model.fbx";type=model/fbx . See İçerik Türleri .

FormData
Gerekli

Talep

Create Asset
curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \

--header 'x-api-key: {apiKey}' \

--form 'request="{ 

  \"assetType\": \"Model\",  

  \"displayName\": \"Name\", 

  \"description\": \"This is a description\", 

  \"creationContext\": { 

    \"creator\": { 

      \"userId\": \"${userId}\" 

    } 

  } 

}"' \

--form 'fileContent=@"/filepath/model.fbx";type=model/fbx'

Yanıt

200 - OK
Yaratma durumunu kontrol etmek için Operasyon ID'sini iade eder.
Şunu döndürür: object
done boolean

Eğer false , işlem hala devam ediyor. Eğer true , işlem tamamlanır.

error object

Hatayı açıklayan mantıksal bir hata modeli.

metadata object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

path string

Sunucu-ayırlanmış kaynak yoluyu.Varsayılan formatı operations/{operation_id} .

response object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

  • Yaz

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

  • asset:write

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Güncelleme Etkisi

PATCH /v1/assets/{assetId}

Açıklama, görünen ad, simge, sosyal bağlantılar ve önizlemeler dahil olmak üzere sağlanan içeriği ve metadateni günceller, bunlar ayrıca Modeller için içeriği günceller. İkonlar ve önizlemelerin Görüntü öğeleri olması gerekir. İkonların kare boyutları olmalıdır.

Parametreler

request

Aşağıdaki örnek istekler gibi form verileri olarak gönderin.

FormData
Gerekli
fileContent string

Eşdeğer varsayılan dosya yolunun ve içerik yazformatı. Biçim: fileContent=@"/filepath/{File}";type={ContentType} . Örnek: fileContent=@"/filepath/model.fbx";type=model/fbx . See İçerik Türleri .

FormData
updateMask string

Açıklama, açıklamaadı, simgeve önizlemeleri gibi varlık metadatası alanlarını güncellemeyi içerir. Örnekler: description%2CdisplayName , previews%2CtwitchSocialLink .

Talep

Update Content Only and Create a New Version
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}' \

--header 'x-api-key: {apiKey}' \

--form 'request="{\"assetId\": {assetId} }"' \

--form 'fileContent="@\"{file-path}\""'
Update Content and Metadata
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \

--header 'x-api-key: {apiKey}' \

--form 'request="{

    \"assetType\": \"{assetType}\",

    \"assetId\": {assetId},

    \"displayName\": \"{new display name}\",

    \"description\": \"{new description}\",    

    \"creationContext\": { 

        \"creator\": {

            \"userId\": {userId}

        },

        \"expectedPrice\":{expectedPrice}

    },

}"' \

--form 'fileContent=@\"{file-path}\"'
Update a List of Previews
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=previews' \

--header 'x-api-key: {apiKey}' \

--form 'request="{\"assetId\": \"{assetId}\", \"previews\": [{\"asset\": \"assets/123\", \"altText\": \"Your alt text.\"}]}"'
Update Social Links

Yanıt

200 - OK
Güncelleme durumunu kontrol etmek için Operasyon ID'sini iade eder / Güncellenmiş metadat alanlarını iade eder.
Şunu döndürür: object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean

Eğer false , işlem hala devam ediyor. Eğer true , işlem tamamlanır.

error object

Hatayı açıklayan mantıksal bir hata modeli.

metadata object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

path string

Sunucu-ayırlanmış kaynak yoluyu.Varsayılan formatı operations/{operation_id} .

response object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

  • Yaz

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

  • asset:write

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Kaynak Sürümünü Al

GET /v1/assets/{assetId}/versions/{versionNumber}

Özellik ID'si ve sürüm numarasına göre özellik versiyonunu al.

Parametreler

assetId string

Varlığın benzersiz kimliği.

Path
Gerekli
versionNumber string

Versiyon numarası.

Path
Gerekli

Talep

Get Asset Version
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \

--header 'x-api-key: {apiKey}'

Yanıt

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Operasyonu al

GET /v1/operations/{operationId}

Geri döndürülen Operasyon ID'sini kullanarak bir varlık oluşturma veya güncelleme sonucunu alın. API anahtarı izin için Oku gerekir ve OAuth 2.0 uygulamaları için Oku gerekir.

Talep

Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \

--header 'x-api-key: {apiKey}'

Yanıt

200 - OK
Şunu döndürür: object
done boolean

Eğer false , işlem hala devam ediyor. Eğer true , işlem tamamlanır.

error object

Hatayı açıklayan mantıksal bir hata modeli.

metadata object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

path string

Sunucu-ayırlanmış kaynak yoluyu.Varsayılan formatı operations/{operation_id} .

response object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

Gerekli İzinler

Bu uç noktasının çağrılması için aşağıdaki API anahtarı izinleri gerekir. Doğru anahtar üretimi hakkında daha fazla bilgi için API anahtarlarını yönet sayfasını incele.

  • Oku

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için Uygulama kaydı ve incelemesi sayfasını incele.

  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Nesneler

Şu nesneler kabul edilen veya döndürülen yükleri tanımlar. Bu nesnelerin ne zaman kullanıldığı hakkında daha fazla bilgi için tüm uç noktalara bak.

Any

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

Nitelikler

@type string

Seri mesajın türü.

Asset

Bir varlığı temsil eder.

Nitelikler

assetId number

Varlık kaynağının benzersiz kimliği. Varlık Güncelleme için gereklidir.

assetType string

Varlık yaz. Sadece Audio, Decal veya Model olabilir. 1>Kaynak Oluştur1> için gereklidir.

creationContext object

Metadatalar veya yaratıcı bilgileri gibi varlık içeriğinin parçası olmayan yaratma konumu. Hayvan Oluştur için gereklidir.

description string

Varlığın açıklaması. 1000 karaktere kadar sınırlı. Varlığı Oluştur için gereklidir.

displayName string

Yerleştirilen kaynağın adını gösterir. Required for Kaynak Oluşturma .

icon string

simgeiçin kaynak yolunu.

moderationResult object

Varlığın moderasyon sonucu.

path string

Yerleştirilen kaynağın yolu. Biçim: assets/{assetId} . Örnek: assets/2205400862 .

previews array<object>

Ön önizlemeler, her birinin bir varlık yoluyla ve alt metniyle. Ön önizlemeler Görüntüler varlıkları olmalıdır.

revisionCreateTime string

Mevcut sürümün oluşturulma zamanı.

revisionId string

Varlığın görüntülenmezliği. versionNumber ile eşdeğer. Herhangi bir değişikliğin otomatik olarak yeni bir versiyonu yapar. Biçim bir dizidizgesidir. Örnek: versionNumber .

socialLink object

Yüksek kaliteli bir görsel ile ilgili sosyal medya bağlantısı. Maksimum üç başına her yüksek kaliteli

CreationContext

Metadatalar veya yaratıcı bilgileri gibi varlık içeriğinin parçası olmayan yaratma konumu. Hayvan Oluştur için gereklidir.

Nitelikler

creator object

Bir yaratıcıyı temsil eder.

Gerekli
expectedPrice number

Robux'ta beklenen varlık yükleme ücreti. Gerçek fiyat beklediğinizden daha yüksekse, işlem 400 hata ile başarısız olur.

Creator

Bir yaratıcıyı temsil eder.

Nitelikler

groupId number

Varlık grubuna aittirse gerekir.

userId number

yaratıcıkullanıcı kimliği. Aset bireysel kullanıcıya aittirse gereklidir.

ModerationResult

Varlığın moderasyon sonucu.

Nitelikler

moderationState string

Varlığın moderasyon devleti. Olabilir MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED veya MODERATION_STATE_APPROVED .

Operation

Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.

Nitelikler

done boolean

Eğer false , işlem hala devam ediyor. Eğer true , işlem tamamlanır.

error object

Hatayı açıklayan mantıksal bir hata modeli.

metadata object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

path string

Sunucu-ayırlanmış kaynak yoluyu.Varsayılan formatı operations/{operation_id} .

response object

Seri mesajın türünü açıklayan bir @type ile bir rastgele seri mesajı içerir.

Preview

Bir varlık özneği.

Nitelikler

altText string

Önizleme kaynağı için alt metin.

asset string

Önizleme kaynağı yolu.

Yüksek kaliteli bir görsel ile ilgili sosyal medya bağlantısı. Maksimum üç başına her yüksek kaliteli

Nitelikler

title string

Sosyal medya bağlantısı için opzional bir başlık. Creator Hub'da kullanılmaz.

uri string

Sosyal medya bağlantısı için kullanılan URL. Bağlantının beklenen formatına uymalıdır. Örneğin, bir twitchSocialLink nesninin başlığı https://twitch.tv/your-channel olmalıdır.

Status

Hatayı açıklayan mantıksal bir hata modeli.

Nitelikler

code number

HTTP durum kodu.

details array<object>

Hataların ayrıntılarını içeren bir mesaj listesi.

message string

Hata mesajı.