Atributos de item
Atributos são características de um item que pode fornecer informações adicionais sobre o item.
Um atributo pode ser a cor e o tamanho de um item, o nível de usuário no qual o item se torna disponível, ou um evento em um jogo.
Recursos principais:
- Filtragem de itens na loja
- Definição de variantes de itens (ex.: capacete vermelho, capacete azul) e a exibição deles no cartão do item
- Atribuição de características adicionais a um item
Exemplos de atributos de itens e seus valores:
Tipo de item | Nome do atributo do item | Valor do atributo do item |
---|---|---|
Chaves de jogo | Tipo de jogo | Novo, Acesso antecipado, Em breve, Especial |
Chaves de jogo | Gênero | Ação, Aventura, Casual, Simulador, Estratégia, RPG |
Itens virtuais | Qualidade | Épica, Lendária, Comum |
Itens virtuais | Classe | Guerreiro, Paladino, Caçador, Xamã, Druida |
Moedas virtuais | Evento | Ano-novo |
Moedas virtuais | Missão | Concluindo a missão 1, Concluindo a missão 2 |
Como funciona
- Você cria atributos de itens e seus valores e os vincula com o item:
- através da Conta de Distribuidor ou API especificando o
External ID dos atributos de itens eExternal ID de valores de atributos. - através da Conta de Distribuidor especificando os atributos e seus valores no formato JSON.
- Você usa métodos da subseção Catálogo do grupo de métodos Itens virtuais & moeda ou Chaves do jogo para solicitar o item do catálogo. Os dados de atributo são retornados:
- Na matriz atributos, se houver atributos criados pela Conta de Distribuidor ou via métodos API especificando o
External ID dos atributos do item e oExternal ID dos valores dos atributos. - Na matriz custom_attributes, se os atributos e seus valores forem adicionados via JSON. Para fazer isso, você precisa incluir o parâmetro additional_fields com o valor
custom_attributes
na solicitação de recuperação do catálogo.
- O usuário faz uma compra. Se os atributos e os valores forem adicionados via JSON, os dados sobre os atributos de itens são passados nos webhooks Successful payment of the order e Order cancellation na matriz custom_attributes.
Fluxo de integração
Você pode criar atributos de itens e seus valores do seu lado e adicioná-los ao item no formato JSON na Conta de Distribuidor.
Você pode criar atributos e seus valores no lado da Xsolla e adicioná-los aos itens. Para fazer isso:
Ao adicionar atributos de itens e seus valores do JSON, haverá um limite de 500 caracteres. Não há limites na quantidade de atributos e valores.
Ao criar atributos e seus valores na Conta de Distribuidor ou através de métodos API, as seguintes limitações se aplicam:
- Nada mais do que 20 valores podem ser especificados para um atributo de item
- Nada mais do que 20 atributos podem ser configurados para cada item
- Um item pode ter diversos valores de um atributo, mas não mais de 6
Criação e configuração de atributos de itens e seus valores
Cada atributo de item possui os seguintes parâmetros:
External ID — é um ID de atributo único que é passado no parâmetro external_id no corpo solicitado. Forneça o ID de atributo no seu sistema ou crie um novo.- Nome (especificado para cada idioma configurado no projeto).
Lista de valores.
External ID do atributo de item pai.External ID do valor — um ID exclusivo do valor passado no parâmetro external_id nos parâmetros de caminho. Especifique o ID do valor em seu sistema ou crie um novo.Nome (especificado para cada idioma configurado no projeto).
Criação de atributos e seus valores na Conta de Distribuidor
- Abra seu projeto na Conta de Distribuidor.
- Vá para Store > Catalog management.
- Clique em Configure na seção Item attributes.
- Clique em Create item attribute.
- Especifique o
External ID e o nome do atributo de item. - Clique em Save and continue.
- Especifique todos os valores necessários para o atributo de item criado. Para cada valor, especifique o
External ID . Para adicionar mais valores, clique em +. - Clique em Save and continue.
A quantidade de atributos de itens no projeto é ilimitada.
Porém, há um limite de 20 valores por atributo.
Criação de atributos e seus valores via métodos API
Para criar e gerenciar atributos de itens e seus valores, use os métodos na subseção Admin do grupo de métodos Item attributes.
Métodos para criar e gerenciar atributos:
Métodos para criar valores de atributos e gerenciá-los:Se você excluir um atributo de item, seus valores e conexões com o item serão perdidos.
Se você excluir um valor, suas conexões com o item serão perdidas.
Não é possível restaurar atributos e valores de itens excluídos ou seus dados relacionados.
Adicionando atributos a um item
Adicione os atributos e valores criados nos itens:
Adicione os atributos existentes via Conta de Distribuidor
Para adicionar atributos a um item:- Abra seu projeto na Conta de Distribuidor.
- No menu lateral, clique na Store.
- Abra uma seção com o tipo de item necessário:
- Itens virtuais
- Moedas virtuais
- Chaves de jogo
- Conjuntos
- Crie um novo item ou edite o existente.
- Na seção Item attributes, defina a opção Select existing attributes or create new como On.
- No campo Item attribute que surgir, selecione o ID correspondente ao atributo de item desejado.
- No campo Value, selecione o ID que corresponde ao valor do atributo do item.
Não é possível configurar mais de 20 atributos por item.
Não é possível especificar mais de 6 valores do mesmo atributo por um item.
Adicione atributos existentes via métodos de API
No método Obter pedido ou Atualizar item virtual, passe uma matriz de objetos com o
Exemplo de uma matriz com atributos e os valores deles:
- http
"attributes": [
{
"external_id": "craft-materials",
"name": {
"en": "Craft materials"
},
"values": [
{
"external_id": "steel",
"value": {
"en-US": "5"
}
},
{
"external_id": "leather",
"value": {
"en-US": "1"
}
}
]
}
],
Não é possível configurar mais de 20 atributos por item.
Não é possível especificar mais de 6 valores do mesmo atributo por um item.
Adição de atributos a partir do JSON via Conta de Distribuidor
Você pode adicionar atributos e seus valores no formato JSON ao criar ou editar todos os tipos de itens, tais como:
Para fazer isso:
- Abra seu projeto na Conta de Distribuidor.
- No menu lateral, clique na Store.
- Abra uma seção com o tipo de item necessário:
- Itens virtuais
- Moedas virtuais
- Chaves de jogo
- Conjuntos
- Crie um novo item ou edite um já existente.
- Na seção atributos de itens, defina a opção Use JSON to add attributes como On.
- Na área de texto exibida, adicione uma lista de atributos e seus valores no formato JSON.
Ao adicionar atributos no formato JSON, não há limite nas quantidades ou nos valores.
Há um limite de caracteres no JSON: 500 caracteres.
Encontrou um erro de texto ou digitação? Selecione o texto e pressione Ctrl+Enter.