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 payload di richiesta e risposta per creare risorse su Roblox.Per informazioni sull'uso dell'API, vedi la guida all'uso.
Assets
Elenca le versioni delle risorse
Elenca tutte le versioni di una risorsa specifica, con paginazione opzionale.
Parametri
L'identificatore univoco dell'risorsa.
Specifica il numero di versioni di risorse da includere nella risposta. I valori validi vanno da 1 a 50 (inclusi). Si presta a 8 quando non fornito.
Un token per la paginazione. 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.
Limiti
Per chiave API: 100 richieste ogni 60 secondi per indirizzo IP
Versione Asset di Rimborso
Rifare un'asset a una versione precedente specifica.
Fornisci il percorso della versione dell'asset nei dati della forma.
Parametri
L'identificatore univoco dell'risorsa.
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.
Limiti
Per chiave API: 100 richieste ogni 60 secondi per indirizzo IP
Crea risorsa
Crea una risorsa con contenuto e metadati forniti.
Non puoi aggiungere oggetti SocialLink quando crei una risorsa. Invece, usa Aggiorna risorsa.
Fornisci il Asset , il percorso del file di risorsa binaria e il tipo di contenuto nella forma dei dati.
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.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Ottieni risorsa
Recupera contenuto e metadati delle risorse specifiche.
Parametri
L'identificatore univoco dell'risorsa.
Campi di metadata delle risorse da Recuperare, inclusa la Descrizione, il nome di visualizzazione, l'Icona, i link sociali 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.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Aggiorna risorsa
Aggiorna una risorsa con contenuto e metadati forniti, inclusa la Descrizione, il nome di visualizzazione, l'Icona, i link sociali e le anteprime.Al momento è possibile aggiornare solo il corpo del contenuto per Modelli .Le icone e le anteprime devono essere immagini risorse.Le icone devono avere dimensioni quadrate.
Fornisci il Asset , il percorso del file di risorsa binaria e il tipo di contenuto nella forma dei dati.
Parametri
L'identificatore univoco dell'risorsa.
Campi di metadata delle risorse da Aggiornarmento, inclusa la Descrizione, il nome di visualizzazione, 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.
Limiti
Per chiave API: 60 richieste ogni 60 secondi per indirizzo IP
Ottieni la versione dell'asset
Recupera una versione specifica di una risorsa dall'ID della risorsa e dal numero di versione.
Parametri
L'identificatore univoco dell'risorsa.
Il numero della 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.
Limiti
Per chiave API: 100 richieste ogni 60 secondi per indirizzo IP
Risorsa archivio
Archivia l'risorsa.Le risorse archiviate scompaiono dal sito web e non sono più utilizzabili o visibili nelle esperienze di Roblox, ma puoi ripristinarle.
Parametri
L'identificatore univoco dell'risorsa.
Richiesta
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'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.
Limiti
Per chiave API: 100 richieste ogni 60 secondi per indirizzo IP
Ripristina risorsa
Ripristina una risorsa archiviata.
Parametri
L'identificatore univoco dell'risorsa.
Richiesta
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'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.
Limiti
Per chiave API: 100 richieste ogni 60 secondi per indirizzo IP
Ottieni operazione
Ottieni il risultato di una creazione o aggiornamento di una risorsa utilizzando l'ID operazione restituito.Richiede Leggi per l'autorizzazione della chiave API e asset:read per le app OAuth 2.0.
Parametri
L'identificatore univoco dell'operazione.
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.
Limiti
Per chiave API: 100 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 insieme a un @type che descrive il tipo del Messaggioserializzato.
Attributi
Il tipo del Messaggioserzializzato.
Asset
Rappresenta una risorsa.
Attributi
L'identificatore univoco della risorsa. Richiesto per Aggiorna risorsa.
Il inserisci / scrividi risorsa. Può essere solo Audio , Decal , o Model . Richiesto per Creare risorsa .
Il contesto di creazione che non fa parte del contenuto delle risorse, come le informazioni su metadata e creatore. Richiesto per Creare risorsa.
La descrizione della risorsa. Limite a 1000 caratteri. Richiesto per Creare risorsa .
Nome visualizzato dell'asset. Richiesto per Creare risorsa.
Il percorso risorsa per l'Icona.
Il risultato della moderazione della risorsa.
Il percorso di risorsa restituito dell'asset. Formato: assets/{assetId} . Esempio: assets/2205400862 .
Un elenco di anteprime, ognuna con un percorso di risorse e un testo alternativo. Le anteprime devono essere Immagine risorse.
L'timestamp di creazione della revisione attuale.
ID della revisione dell'risorsa.Equivalente a versionNumber .Ogni modifica dell'asset si impegna automaticamente una nuova versione.Il formato è una Stringaintera.Esempio: 1 .
Un link ai social media per la risorsa.Massimo di tre per risorsa.Il nome dell'oggetto può essere qualsiasi di:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Se l'asset è attivo o archiviato. Non specificato non viene utilizzato.
AssetVersion
Una versione di risorsa.
Attributi
Il contesto di creazione che non fa parte del contenuto delle risorse, come le informazioni su metadata e creatore. Richiesto per Creare risorsa.
Il risultato della moderazione della risorsa.
Il percorso di risorsa restituito della versione dell'asset. Formato: assets/{assetId}/versions/{version} . Esempio: assets/2205400862/versions/1 .
CreationContext
Il contesto di creazione che non fa parte del contenuto delle risorse, come le informazioni su metadata e creatore. Richiesto per Creare risorsa.
Attributi
Rappresenta un Creatore.
Attesa tariffa di caricamento delle risorse in Robux. Quando il prezzo effettivo è superiore alle previsioni, 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 del Creatore. Richiesto se la risorsa è di proprietà dell'utente individuale.
ModerationResult
Il risultato della moderazione della risorsa.
Attributi
Lo stato di moderazione della risorsa. Può essere Reviewing , Rejected , o Approved .
Operation
Questa risorsa rappresenta un'operazione in esecuzione a lungo termine 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 Statodell'errore.
Contiene un messaggio serializzato arbitrario insieme a un @type che descrive il tipo del Messaggioserializzato.
Il percorso di risorsa assegnato dal server. Il formato predefinito è operations/{operation_id} .
Contiene un messaggio serializzato arbitrario insieme a un @type che descrive il tipo del Messaggioserializzato.
Preview
Un'anteprima delle risorse.
Attributi
Testo alternativo per la risorsa di anteprima.
Il percorso di anteprima delle risorse.
SocialLink
Un link ai social media per la risorsa.Massimo di tre per risorsa.Il nome dell'oggetto può essere qualsiasi di:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Attributi
Un titolo opzionale per il Callegareai social media. Non utilizzato sul Hub Creatore.
L' URI 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 .
State
Se l'asset è attivo o archiviato. Non specificato non viene utilizzato.
Attributi
Status
Il modello di errore logico che spiega lo Statodell'errore.
Attributi
Il codice stato HTTP.
Un elenco di messaggi che contengono dettagli di errore.
Il Messaggiodi errore.