*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

CreatorStoreProduct

Représente un produit dans la boutique des créateurs. Cette ressource est utilisée pour gérer la distribution et le prix des ressources sur la boutique des créateurs.

Attributs

pathstring

Le chemin de ressource du produit de la boutique du créateur.

Format : creator-store-products/{creator_store_product_id}.

basePriceobject

Le prix de base du produit.Pour plus d'informations, voir argent.Chaque type de produit (comme pluginAssetId ) supporte un ensemble de prix spécifiques.Actuellement, seul le réglage d'un prix de base en USD est pris en charge.

Selon le type, chaque produit de la boutique des créateurs a un ensemble fixe de prix soutenus ; voir l'attribut productType pour la liste complète.Par exemple, pour définir le prix d'un plugin à 4,99 $, utilisez le prix de base suivant :


"basePrice": {
"currencyCode": "USD",
"quantity": {
"significand": 4990000000,
"exponent": -9
}
}

Remarque : l'exposant doit être -9, et le signe doit être dans ce format. Le format correspondant décimal est ».

Si vous voulez définir le prix d'un plugin à 0 $ (c'est-à-dire gratuit), utilisez le suivant base_price


"basePrice": {
"currencyCode": "USD",
"quantity": {
"significand": 0,
"exponent": 0
}
}

Remarque : vous devez toujours définir le currencyCode en USD, même pour les produits gratuits.

Le prix d'achat réel est basé sur ce prix de base, mais il diffère souvent légèrement en raison de considérations locales spécifiques.

Définissez ceci à zéro pour rendre le produit gratuit.

purchasePriceobject

Le prix d'achat effectif pour l'utilisateur, après avoir tenu compte des considérations spécifiques à la localité.

publishedboolean

Si le vendeur a l'intention de distribuer le produit de la boutique des créateurs sur la boutique des créateurs.Un vendeur peut avoir l'intention de distribuer un produit, mais en raison de certaines restrictions sur le vendeur ou le produit du magasin de créateur sous-jacent, le produit peut ne pas être disponible à l'achat.Voir restrictions et purchasable pour plus de détails.

restrictionsarray<enum>
Sortie seule

Restrictions appliquées au produit. Un produit peut avoir plusieurs restrictions actives en même temps.

Valeurs possibles :

| Valeur | Description | | --- | --- | | RESTRICTION_UNSPECIFIED | Restriction non spécifiée.| | SOLD_ITEM_RESTRICTED | L'article vendu a été restreint par Roblox Les détails peuvent être disponibles en cherchant cet article directement.| | SELLER_TEMPORARILY_RESTRICTED | Le produit est restreint car le compte du vendeur est temporairement restreint par Roblox.| | SELLER_PERMANENTLY_RESTRICTED | Le produit est restreint car le compte du vendeur est restreint de manière permanente par Roblox.| | SELLER_NO_LONGER_ACTIVE | Le produit est restreint car le compte du vendeur a été supprimé ou est autrement désactivé. |. Valeurs possibles :

purchasableboolean
Sortie seule

Si le produit est achetable.

Pour que cette valeur soit vraie, published doit être vrai et restrictions doit être vide.Si cette valeur est fausse, le produit ne peut pas être acquis par n'importe quel utilisateur.

Un des éléments suivants pour seller:

userSellerstring
Sortie seule

L'utilisateur Roblox qui vend le produit.

groupSellerstring
Sortie seule

Le groupe Roblox qui vend le produit.

Un des éléments suivants pour productType:

modelAssetIdstring
Immuable

Le produit de la boutique des créateurs est un modèle avec cet ID de ressource.

pluginAssetIdstring
Immuable

Le produit de la boutique des créateurs est un plugin avec cet ID de ressource.

Prix de base soutenus en USD : $0, $4.99, $5.99, $6.99, $7.99, $8.99, $9.99, $10.99, $11.99, $12.99, $13.99, $14.99, $15.99, $16.99, $17.99, $18.99, $19.99, $24.99, $29.99, $34.99, $39.99, $44.99, $49.99, $59.99, $69.99, $79.99, $89.99, $99.99, $149.99, $199.99, $249.99.

audioAssetIdstring
Immuable

Le produit de la boutique des créateurs est un fichier audio avec cet ID de ressource.

decalAssetIdstring
Immuable

Le produit de la boutique des créateurs est une décalcomanie avec cet ID de ressource.

meshPartAssetIdstring
Immuable

Le produit de la boutique des créateurs est une partie en maillage avec cet ID de ressource.

videoAssetIdstring
Immuable

Le produit de la boutique des créateurs est une vidéo avec cet ID de ressource.

fontFamilyAssetIdstring
Immuable

Le produit de la boutique des créateurs est une famille de police avec cet ID de ressource.

URL de base

https://apis.roblox.com
La ressource CreatorStoreProduct

{
"path": "creator-store-products/123",
"basePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"purchasePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"published": true,
"restrictions": [
"RESTRICTION_UNSPECIFIED"
],
"purchasable": true,
"userSeller": "string",
"modelAssetId": "string"
}

CreatorStoreProduct

Créer un produit de la boutique des créateurs
Bêta

POST /cloud/v2/creator-store-products

Ajoutez un produit de la boutique des créateurs.Ne utilisez cette méthode que si votre produit n'a jamais été distribué sur la boutique des créateurs ; sinon, utilisez la méthode PATCH pour mettre à jour le produit.

Périmètres d'application
creator-store-product:write
RequêteCorps de la requêteCreatorStoreProduct
POST /cloud/v2/creator-store-products

curl -L -X POST 'https://apis.roblox.com/cloud/v2/creator-store-products' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"basePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"purchasePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"published": true
}'
Réponse

{
"path": "creator-store-products/123",
"basePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"purchasePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"published": true,
"restrictions": [
"RESTRICTION_UNSPECIFIED"
],
"purchasable": true,
"userSeller": "string",
"modelAssetId": "string"
}

CreatorStoreProduct

Obtenir le produit de la boutique des créateurs
Bêta

GET /cloud/v2/creator-store-products/{creator_store_product_id}

Obtenez un produit de la boutique des créateurs.

Périmètres d'application
creator-store-product:read
RequêteParamètres du chemin
creator_store_product_idstring
Requis

L'ID du produit créateur-magasin.

GET /cloud/v2/creator-store-products/{creator_store_product_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/creator-store-products/{creator_store_product_id}' \
-H 'x-api-key: {your-api-key}'
Réponse

{
"path": "creator-store-products/123",
"basePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"purchasePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"published": true,
"restrictions": [
"RESTRICTION_UNSPECIFIED"
],
"purchasable": true,
"userSeller": "string",
"modelAssetId": "string"
}

CreatorStoreProduct

Mettre à jour le produit de la boutique des créateurs
Bêta

PATCH /cloud/v2/creator-store-products/{creator_store_product_id}

Mettre à jour un produit de la boutique des créateurs.

Périmètres d'application
creator-store-product:write
RequêteParamètres du chemin
creator_store_product_idstring
Requis

L'ID du produit créateur-magasin.

Paramètres de requête
updateMaskstring

La liste des champs à mettre à jour. Cette chaîne est formatée comme un FieldMask.

allowMissingboolean

Si la valeur est définie sur vrai et que le produit du magasin de créateur n'est pas trouvé, un produit du magasin de créateur est créé. Dans cette situation, update_mask est ignoré.

Corps de la requêteCreatorStoreProduct
PATCH /cloud/v2/creator-store-products/{creator_store_product_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/creator-store-products/{creator_store_product_id}?updateMask={string}&allowMissing={boolean}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"basePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"purchasePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"published": true
}'
Réponse

{
"path": "creator-store-products/123",
"basePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"purchasePrice": {
"currencyCode": "string",
"quantity": {
"significand": "integer",
"exponent": "integer"
}
},
"published": true,
"restrictions": [
"RESTRICTION_UNSPECIFIED"
],
"purchasable": true,
"userSeller": "string",
"modelAssetId": "string"
}