API des ressources
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Vous pouvez envoyer et recevoir les charges utiles de requête et de réponse suivantes pour créer des ressources sur Roblox.Pour obtenir des informations sur l'utilisation de l'API, voir le guide d'utilisation.
Assets
Listez les versions des ressources
Listez toutes les versions d'un contenuspécifique, avec une pagination facultative.
Paramètres
L'identifiant unique de la contenu.
Spécifie le nombre de versions de ressources à inclure dans la réponse. Les valeurs valides vont de 1 à 50 (inclus). La valeur par défaut est de 8 lorsqu'elle n'est pas fournie.
Un jeton pour la pagination. La valeur est obtenue à partir d'une demande précédente et permet de récupérer la page suivante des versions de ressources.
Requête
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 100 demande toutes les 60 secondes par adresse IP
Version de la ressource de rétrogradation
Revenir une ressource à une version précédente spécifique.
Fournir le chemin de version des ressources dans les données de formulaire.
Paramètres
L'identifiant unique de la contenu.
Requête
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}\"}'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 100 demande toutes les 60 secondes par adresse IP
Créer une ressource
Crée une ressource avec le contenu et les métadonnées fournis.
Vous ne pouvez pas ajouter d'objets Lien social lorsque vous créez une contenu. Utilisez plutôt mettre à jour la ressource.
Fournir le Asset , le chemin du fichier de ressources binaires, et le type de contenu dans les données de formulaire.
Requête
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'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 60 demande toutes les 60 secondes par adresse IP
Obtenir une ressource
Récupérer le contenu et les métadonnées des ressources spécifiques.
Paramètres
L'identifiant unique de la contenu.
Champs de métadonnées de ressources à récupérer, y compris la description, le nom d'affichage, l'icône, les liens sociaux et les prévisualisations. Exemples : description%2CdisplayName , previews%2CtwitchSocialLink .
Requête
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}'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 60 demande toutes les 60 secondes par adresse IP
Mettre à jour la ressource
Mise à jour d'une ressource avec le contenu et les métadonnées fournis, y compris la description, le nom d'affichage, l'icône, les liens sociaux et les prévisualisations.Actuellement, vous ne pouvez mettre à jour le corps du contenu que pour modèles .Les icônes et les prévisualisations doivent être des ressources image .Les icônes doivent avoir des dimensions carrées.
Fournir le Asset , le chemin du fichier de ressources binaires, et le type de contenu dans les données de formulaire.
Paramètres
L'identifiant unique de la contenu.
Champs de métadonnées de ressources à mettre à mise à jour, y compris la description, le Nom d'affichaged'affichage, l'icône et les prévisualisations. Exemples : description%2CdisplayName , previews%2CtwitchSocialLink .
Requête
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\"}}"'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 60 demande toutes les 60 secondes par adresse IP
Obtenir la version des ressources
Récupérer une version spécifique de la ressource par l'ID de la ressource et le numéro de version.
Paramètres
L'identifiant unique de la contenu.
Le numéro de version.
Requête
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 100 demande toutes les 60 secondes par adresse IP
Ressource d'archive
Archivage de la contenu.Les ressources archivées disparaissent du site Web et ne sont plus utilisables ou visibles dans les expériences Roblox, mais vous pouvez les restaurer.
Paramètres
L'identifiant unique de la contenu.
Requête
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 100 demande toutes les 60 secondes par adresse IP
Récupérer la ressource
Restaure une ressource archivée.
Paramètres
L'identifiant unique de la contenu.
Requête
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 100 demande toutes les 60 secondes par adresse IP
Obtenir une opération
Obtenez le résultat d'une création ou d'une mise à jour d'une ressource en utilisant l'ID d'opération retourné.Nécessite lecture pour l'autorisation de clé API et lecture de ressources pour les applications OAuth 2.0.
Paramètres
L'identifiant unique de l'opération.
Requête
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'Réponse
Autorisations requises
Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).
Limitations
Par clé API : 100 demande toutes les 60 secondes par adresse IP
Objets
Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.
Any
Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.
Attributs
Le type du message sérialisé.
Asset
Représente une contenu.
Attributs
L'identifiant unique de la contenu. Nécessaire pour mettre à jour la ressource.
Le taperde ressource. Ne peut être que Audio , Decal ou Model . Requis pour Créer une ressource .
Le contexte de création qui n'est pas partie du contenu des ressources, comme les métadonnées et les informations sur le créateur. Nécessaire pour créer une ressource.
La description de la contenu. Limite à 1000 caractères. Nécessaire pour créer une ressource.
Nom d'affichage de la contenu. Nécessaire pour créer une ressource.
Le chemin de ressource pour l'icône.
Le résultat de modération de la contenu.
Le chemin de ressource retourné de la contenu. Format : assets/{assetId} . Exemple : assets/2205400862 .
Une liste d'aperçus, chacun avec un chemin de ressources et du texte alt. Les aperçus doivent être des ressources image .
L'heure de création de la révision actuelle.
ID de révision de la contenu.Équivalent à versionNumber.Chaque modification de la ressource engage automatiquement une nouvelle version.Le format est une chaîne entière.Exemple : 1 .
Un lien de média social pour la contenu.Maximum de trois par contenu.Le nom de l'objet peut être n'importe lequel de :
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Si la ressource est active ou archivée. Non spécifié n'est pas utilisé.
AssetVersion
Une version de ressource.
Attributs
Le contexte de création qui n'est pas partie du contenu des ressources, comme les métadonnées et les informations sur le créateur. Nécessaire pour créer une ressource.
Le résultat de modération de la contenu.
Le chemin de ressource retourné de la version de l'actif. Format : assets/{assetId}/versions/{version} . Exemple : assets/2205400862/versions/1 .
CreationContext
Le contexte de création qui n'est pas partie du contenu des ressources, comme les métadonnées et les informations sur le créateur. Nécessaire pour créer une ressource.
Attributs
Représente un créateur.
Taxe de téléchargement des ressources attendue en Robux. Lorsque le prix réel est supérieur à ce qui était prévu, l'opération échoue avec une erreur 400.
Creator
Représente un créateur.
Attributs
L'ID de groupe. Requis si la ressource appartient à un groupe.
L'ID utilisateur du créateur. Nécessaire si la ressource est détenue par un utilisateur individuel.
ModerationResult
Le résultat de modération de la contenu.
Attributs
L'état de modération de la contenu. Peut être Reviewing , Rejected ou Approved .
Operation
Cette ressource représente une opération de longue durée qui est le résultat d'un appel de réseau API.
Attributs
Si false , l'opération est toujours en cours. Si true , l'opération est terminée.
Le modèle d'erreur logique expliquant l'statutd'erreur.
Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.
Le chemin de ressource attribué par le serveur. Le format par défaut est operations/{operation_id} .
Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.
Preview
Aperçu d'une ressource.
Attributs
Texte alternatif pour la ressource en contenu.
Le chemin de prévisualisation des ressources.
SocialLink
Un lien de média social pour la contenu.Maximum de trois par contenu.Le nom de l'objet peut être n'importe lequel de :
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Attributs
Un titre facultatif pour le lien des médias sociaux. Ne pas l'utiliser sur le hub des créateurs.
L' URI pour le lierdes médias sociaux.Doit correspondre au format attendu pour le type de lier.Par exemple, le titre d'un objet twitchSocialLink doit être du format https://twitch.tv/your-channel.
State
Si la ressource est active ou archivée. Non spécifié n'est pas utilisé.
Attributs
Status
Le modèle d'erreur logique expliquant l'statutd'erreur.
Attributs
Le code d'état HTTP.
Une liste de messages portant des détails d'erreur.
Le message d'erreur.