Attributs de bien

Les attributs sont des caractéristiques d’un bien qui peuvent fournir des informations supplémentaires sur celui-ci.

Un attribut peut représenter la couleur et la taille d’un objet, le niveau d’utilisateur auquel l’objet devient disponible, ou un événement dans un jeu.

Fonctionnalités principales :

  • Filtre des biens dans le magasin ;
  • Définition des variantes du bien (casque rouge, casque bleu, etc.) et leur affichage sur la carte de bien ;
  • Attribution de caractéristiques supplémentaires à un bien.

Exemples d’attributs de bien et de leurs valeurs :

Type d’objetNom de l’attribut de bienValeur de l’attribut de bien
Game keysType de jeuNouveau, Accès en avant-première, Prochainement, Spécial
Game keysGenreAction, Aventures, Casual, Simulateur, Stratégie, RPG
Objets virtuelsQualitéÉpique, Légendaire, Commun
Objets virtuelsClasseGuerrier, Paladin, Chasseur, Chaman, Druide
Monnaie virtuelleÉvénementNouvel An
Monnaie virtuelleQuêteTerminer la quête 1, Terminer la quête 2

Comment ça marche

  1. Vous créez des attributs de bien et leurs valeurs, et vous les liez à un bien :
  • dans le Compte éditeur ou via API en spécifiant les External ID des attributs de bien et les External ID des valeurs d’attribut.
  • dans le Compte éditeur en spécifiant les attributs et leurs valeurs au format JSON.
  1. Vous utilisez les méthodes de la sous-section Catalog du groupe de méthodes Virtual Items & Currency ou Game Keys pour récupérer le catalogue des objets. Les données d’attribut sont renvoyées :
  • Dans un tableau d’attributs si les attributs sont créés dans le Compte éditeur ou via méthodes API en spécifiant les External ID des attributs de bien et les External ID des valeurs d’attribut.
  • Dans le tableau custom_attributes si les attributs et leurs valeurs sont ajoutés à partir de JSON. Pour ce faire, vous devez inclure le paramètre additional_fields avec la valeur custom_attributes dans la requête de récupération du catalogue.
  1. L’utilisateur effectue un achat. Si les attributs et leurs valeurs sont ajoutés à partir de JSON, les données sur les attributs du bien sont passées dans les webhooks Paiement de commande réussi et Annulation de la commande dans le tableau custom_attributes.

Flux d'intégration

Vous pouvez créer des attributs de bien et leurs valeurs de votre côté et les ajoutez aux biens au format JSON dans le Compte éditeur.

Vous pouvez également créer des attributs et leurs valeurs côté Xsolla et les ajouter aux biens. Pour ce faire :

  1. Créez les attributs et leurs valeurs.
  2. Configurez le lien entre les attributs et les biens.
Note

Lors de l’ajout d’attributs de bien et de leurs valeurs à partir de JSON, il y a une limite de 500 caractères. Le nombre d’attributs et de valeurs n’est pas limité.

Lors de la création d’attributs et de leurs valeurs dans le Compte éditeur ou via méthodes API, les limites suivantes s’appliquent :

  • Pas plus de 20 valeurs ne peuvent être spécifiées par attribut de bien.
  • Pas plus de 20 attributs ne peuvent être configurés pour chaque bien.
  • Un bien ne peut pas avoir plus de 6 valeurs pour un attribut.

Créer et configurer des attributs de bien et leurs valeurs

Chaque attribut de bien possède les paramètres suivants :

  • External ID — ID unique d’attribut qui est passé dans le paramètre external_id dans le corps de la requête. Spécifiez l’ID de l’attribut dans votre système ou créez-en un nouveau.
  • Nom (spécifié pour chaque langue configurée dans le projet).
  • Liste de valeurs.

Chaque valeur d’attribut de bien possède les paramètres suivants :
  • External ID de l’attribut du bien parent.
  • External ID de la valeur — ID unique de la valeur passé dans le paramètre external_id dans les paramètres de chemin. Spécifiez l’ID de la valeur dans votre système ou créez-en un nouveau.
  • Nom (spécifié pour chaque langue configurée dans le projet).

Vous pouvez créer des attributs et leurs valeurs :

Créer des attributs et leurs valeurs dans le Compte éditeur

  1. Ouvrez votre projet dans le Compte éditeur.
  2. Accédez à Store > Catalog management.
  1. Dans la section Item attributes, cliquez sur Configure.
  2. Cliquez sur Create item attribute.
  3. Spécifiez External ID et le nom de l'attribut de bien.
  4. Cliquez sur Save and continue.
  5. Spécifiez toutes les valeurs nécessaires pour l'attribut de bien créé. Pour chaque valeur, spécifiez External ID. Pour ajouter plus de valeurs, cliquez sur +.
  6. Cliquez sur Save and continue.
Note

Le nombre d’attributs de bien dans le projet est illimité.

Cependant, il y a une limite de 20 valeurs par attribut.

Après avoir créé les attributs et leurs valeurs, ajoutez-les aux biens via API ou dans le Compte éditeur.

Créer des attributs et leurs valeurs via méthodes API

Pour créer et gérer les attributs de bien et leurs valeurs, utilisez les méthodes de la sous-section Admin du groupe de méthodes Item attributes.

Méthodes de création et de gestion des attributs :

Méthodes de création et de gestion des valeurs d’attribut :
Avis

Si vous supprimez un attribut de bien, ses valeurs et ses liens avec le bien se perdent.

Si vous supprimez une valeur, ses liens avec le bien se perdent.

Il est impossible de restaurer des attributs de bien supprimés, leurs valeurs ou les données.

Après avoir créé les attributs et leurs valeurs, ajoutez-les aux biens via API ou dans le Compte éditeur.

Ajouter des attributs à un bien

Ajoutez les attributs créés et leurs valeurs aux biens :

Ajouter des attributs existants dans le Compte éditeur

Pour ajouter des attributs à un bien :
  1. Ouvrez votre projet dans le Compte éditeur.
  2. Dans le menu latéral, cliquez sur Store.
  3. Ouvrez une section avec le type de bien requis :
    • Objets virtuels ;
    • Monnaie virtuelle ;
    • Clés de jeu ;
    • Lots.
  4. Créez un nouveau bien ou modifiez un bien existant.
  5. Dans la section Item attributes, réglez la bascule Select existing attributes or create new sur On.
  6. Dans le champ Item attribute qui apparaît, sélectionnez l’ID correspondant à l’attribut de bien requis.
  7. Dans le champ Value, sélectionnez l’ID qui correspond à la valeur de l’attribut de bien.
Note

Vous ne pouvez pas définir plus de 20 attributs pour un bien.

Vous ne pouvez pas spécifier plus de 6 valeurs du même attribut pour un bien.

Ajouter des attributs existants via les méthodes API

Dans la méthode Create virtual item ou Update virtual item, passez un tableau d’objets avec les External ID des attributs de bien et les External ID de leurs valeurs associées.

Exemple de tableau avec des attributs et leurs valeurs :

Copy
Full screen
Small screen
  "attributes": [
    {
      "external_id": "craft-materials",
      "name": {
        "en": "Craft materials"
      },
      "values": [
        {
          "external_id": "steel",
          "value": {
            "en-US": "5"
          }
        },
        {
          "external_id": "leather",
          "value": {
            "en-US": "1"
          }
        }
      ]
    }
  ],
Note
Lors de la demande récupération du catalogue des objets à l’aide des méthodes de la sous-section Catalog des groupes de méthodes Virtual Items & Currency ou Game Keys, la réponse inclut également une liste d’attributs correspondants et leurs valeurs associées dans le tableau d’attributs.
Note

Vous ne pouvez pas définir plus de 20 attributs pour un bien.

Vous ne pouvez pas spécifier plus de 6 valeurs du même attribut pour un bien.

Ajouter des attributs à partir de JSON dans le Compte éditeur

Vous pouvez inclure des attributs et leurs valeurs au format JSON lors de la création ou de la modification de tous les types de biens :

Pour ce faire :

  1. Ouvrez votre projet dans le Compte éditeur.
  2. Dans le menu latéral, cliquez sur Store.
  3. Ouvrez une section avec le type de bien requis :
    • Objets virtuels ;
    • Monnaie virtuelle ;
    • Clés de jeu ;
    • Lots.
  4. Créez un nouveau bien ou modifiez un bien existant.
  5. Dans la section Item attributes, réglez la bascule Use JSON to add attributes sur On.
  1. Dans la zone de texte affichée, ajoutez une liste d'attributs et leurs valeurs au format JSON.
Note

Lors de l’ajout d’attributs au format JSON, il n’y a pas de limite en ce qui concerne le nombre d’attributs ou de leurs valeurs.

Il n’y a de limite que pour la longueur maximale du JSON, qui est de 500 caractères.

Cet article vous a été utile ?
Merci !
Que pouvons-nous améliorer ? Message
Nous sommes désolés de l'apprendre
Dites-nous pourquoi vous n'avez pas trouvé cet article utile. Message
Merci pour votre commentaire !
Nous examinerons votre message et l'utiliserons pour améliorer votre expérience.
Évaluer cette page
Évaluer cette page
Que pouvons-nous améliorer ?

Préfère ne pas répondre

Merci pour votre commentaire !
Dernière mise à jour: 10 Octobre 2023

Faute de frappe ou autre erreur dans le texte ? Sélectionnez le texte concerné et appuyez sur Ctrl+Entée.

Signaler un problème
Nous améliorons continuellement notre contenu grâce à vos commentaires.
Indiquez votre adresse e-mail pour un suivi
Merci pour votre commentaire !