API delle risorse
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
Puoi inviare e ricevere i seguenti requisiti e risposte per creare risorse su Roblox. Per informazioni sull'uso dell'API, vedi il Guida all'uso.
Assets
Elenca le versioni delle risorse
Elenca tutte le versioni di una risorsa specifica, con paginazione opzionale.
Parametri
L'identificatore unico della risorsa.
Specifica il numero di versioni dell'asset da includere nella risposta. I valori validi vanno da 1 a 50 (inclusi). Gli errori predefiniti sono 8 quando non sono forniti.
Un token per la pagination. Il valore viene ottenuto da una richiesta precedente e consente di recuperare la prossima pagina delle versioni delle risorse.
Richiesta
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Versione della risorsa di ripristino
Ripristina una risorsa a una versione precedente specifica.
Parametri
L'identificatore unico della risorsa.
La strada della versione dell'asset in formato assets/{assetId}/versions/{versionNumber} .
Richiesta
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}\"}'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Ottieni risorsa
Recupera contenuto e metadati dell'asset specifici.
Parametri
L'identificatore unico della risorsa.
Campi dei metadati delle risorse da Recuperare, tra cui la Descrizione, il Nome Visualizzato, l'Icona, i link social e le anteprime. Esempi: description%2CdisplayName , previews%2CtwitchSocialLink .
Richiesta
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Crea risorsa
Crea una risorsa con il contenuto e i metadati forniti.
Non puoi aggiungere oggetti SocialLink quando crei una risorsa. Invece, usa Aggiorna risorsa .
Parametri
Attributi delle risorse per creare o Aggiornarmento. Invia come dati di forma come mostra l'esempio seguente.
Il file di contenuto binario e il percorso del file inserisci / scrivi. Formato: fileContent=@"/filepath/{File}";type={ContentType} ; tipo = contenuto del modello . Esempio: fileContent=@"/filepath/model.fbx";type=model/fbx . Vedi Tipi di contenuto .
Richiesta
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'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Aggiorna risorsa
Aggiorna una risorsa con contenuto e metadati forniti, tra cui la Descrizione, il Nome Visualizzato, l'Icona, i link social e le anteprime. Può aggiornare solo il corpo del contenuto per Modelli . Le icone e le anteprime devono essere risorse immagine . Le icone devono avere dimensioni quadrate.
Parametri
Invia come dati di forma come le seguenti richieste di esempio.
Il file di contenuto binario e il percorso del file inserisci / scrivi. Formato: fileContent=@"/filepath/{File}";type={ContentType} ; tipo = contenuto del modello . Esempio: fileContent=@"/filepath/model.fbx";type=model/fbx . Vedi Tipi di contenuto .
Campi dei metadati dell'asset per l'Aggiornarmento, tra cui la Descrizione, il Nome Visualizzato, l'Iconae le anteprime. Esempi: description%2CdisplayName , previews%2CtwitchSocialLink .
Richiesta
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}\""'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}\"'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.\"}]}"'curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Ottieni la versione dell'asset
Recupera una versione specifica delle risorse tramite l'ID della risorsa e il numero di versione.
Parametri
L'identificatore unico della risorsa.
Il numero di versione.
Richiesta
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Ottieni Operazione
Ottieni il risultato di una creazione o di un aggiornamento delle risorse utilizzando l'ID di operazione restituito. Richiede Leggi per il permesso chiave API e risorsa:read per gli app OAuth 2.0.
Richiesta
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'Risposta
Permessi Necessari
Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.
I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi Registrazione e revisione dell'app.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Oggetti
Gli oggetti seguenti descrivono i payloads accettati o restituiti. Per maggiori informazioni su quando vengono utilizzati questi oggetti, consultare ogni singolo endpoint.
Any
Contiene un messaggio serializzato arbitrario, nonché un @type che descrive il tipo del Messaggioserializzato.
Attributi
Il tipo del Messaggioserializzato.
Asset
Rappresenta una risorsa.
Attributi
L'identificatore unico della risorsa. Richiesto per Aggiorna risorsa .
Il inserisci / scrividi risorsa. Può essere solo Audio , Decal , o Model . Richiesto per 1> Crea risorsa1> .
Il contesto di creazione che non fa parte del contenuto dell'asset, come i metadati e le informazioni del creatore. Richiesto per Crea risorsa .
La descrizione della risorsa. Limite di 1000 caratteri. Richiesto per Crea risorsa .
Nome visualizzato della risorsa. Richiesto per Crea risorsa .
La risorsa per l'Icona.
Il risultato della moderazione dell'risorsa.
Il percorso risorsa restituito dall'asset. Formato: assets/{assetId} . Esempio: assets/2205400862 .
Una lista di anteprima, ognuna con un percorso risorsa e un testo alternativo. Le anteprime devono essere risorse immagine .
Il timestamp della creazione della revisione attuale.
ID della revisione dell'risorsa. Equivalente a versionNumber . Ogni cambiamento dell'asset invia automaticamente una nuova versione. Il formato è una Stringaintera. Esempio: 1 .
Un link sui social media per la risorsa. Massimo di tre per risorsa. Il nome dell'oggetto può essere qualsiasi di: <
CreationContext
Il contesto di creazione che non fa parte del contenuto dell'asset, come i metadati e le informazioni del creatore. Richiesto per Crea risorsa .
Attributi
Rappresenta un Creatore.
Tassa di caricamento risorse prevista in Robux. Quando il prezzo reale è più del previsto, l'operazione fallisce con un errore 400.
Creator
Rappresenta un Creatore.
Attributi
L'ID del gruppo. Richiesto se la risorsa è di proprietà del gruppo.
L'ID utente il Creatore. Richiesto se la risorsa è di proprietà dell'utente individuale.
ModerationResult
Il risultato della moderazione dell'risorsa.
Attributi
Lo stato di moderazione delle risorsa. Può essere MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED, o MODERATION_STATE_APPROVED .
Operation
Questa risorsa rappresenta un'operazione in esecuzione a lungo che è il risultato di una chiamata API di rete.
Attributi
Se false , l'operazione è ancora in corso. Se true , l'operazione è completata.
Il modello di errore logico che spiega lo stato di Stato.
Contiene un messaggio serializzato arbitrario, nonché un @type che descrive il tipo del Messaggioserializzato.
Il percorso risorsa assegnato dal server. Il formato predefinito è operations/{operation_id} .
Contiene un messaggio serializzato arbitrario, nonché un @type che descrive il tipo del Messaggioserializzato.
Preview
Un'anteprima delle risorse.
Attributi
Testo alternativo per la risorsa di anteprima.
La strada di risorsa della preview.
SocialLink
Un link sui social media per la risorsa. Massimo di tre per risorsa. Il nome dell'oggetto può essere qualsiasi di: <
Attributi
Un titolo opzionale per il Callegaredei social media. Non usato nella Hub Creatore.
L'URL per il Callegaredei social media. Deve corrispondere al formato previsto per il tipo di Callegare. Ad esempio, il titolo per un oggetto twitchSocialLink deve essere del formato https://twitch.tv/your-channel .
Status
Il modello di errore logico che spiega lo stato di Stato.
Attributi
Il codice di stato HTTP.
Una lista di messaggi che contengono dettagli di errore.
Il Messaggiodi errore.