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 :

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.

2. Vous utilisez les méthodes de la sous-section Catalogue du groupe de méthodes Objets et monnaie virtuels ou Clés de jeu 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.

3. 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.

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.

• 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).

• dans le Compte éditeur ;
• via méthodes API.

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.

3. Dans la section Item attributes, cliquez sur Configure.
4. Cliquez sur Create item attribute.
5. Spécifiez External ID et le nom de l'attribut de bien.
6. Cliquez sur Save and continue.
7. 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 +.
8. Cliquez sur Save and continue.

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 Administrateur du groupe de méthodes Item attributes.

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

• Créer un attribut
• Mettre à jour un attribut
• Lire un attribut spécifique
• Supprimer un attribut

• Lire la liste des attributs pour administratio

• Créer une valeur d’attribut
• Lire un attribut spécifique
• Mettre à jour une valeur d’attribut
• Supprimer un attribut

Ajouter des attributs à un bien

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

• dans le Compte éditeur ;
• via méthodes API.

Ajouter des attributs existants dans le Compte éditeur

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.

Ajouter des attributs existants via les méthodes API

Dans la méthode Créer un objet virtuel ou Mettre à jour un objet virtuel, 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 :

  "attributes": [
    {
      "external_id": "craft-materials",
      "name": {
        "en": "Craft materials"
      },
      "values": [
        {
          "external_id": "steel",
          "value": {
            "en-US": "5"
          }
        },
        {
          "external_id": "leather",
          "value": {
            "en-US": "1"
          }
        }
      ]
    }
  ],

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 :

• packages de monnaie virtuelle ;
• objets virtuels (y compris les objets à durée limitée) ;
• clés de jeu ;
• lots.

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.

6. Dans la zone de texte affichée, ajoutez une liste d'attributs et leurs valeurs au format JSON.