Cupons

Como funciona

As promoções de cupons são uma ferramenta de marketing para conseguir novos usuários e aumentar as vendas. Um jogador que usa um cupom recebe uma recompensa vinculada a ele. A recompensa pode incluir:

• pacote de moedas virtuais
• chaves de jogo
• itens virtuais

Cada cupom tem um código. Para usar um cupom, o usuário insere seu código no jogo, no site ou no aplicativo móvel.

Principais características:

• Decida a quantidade geral de resgates de cupons para uma campanha.
• Determine o número de resgates de cupons por cada usuário em uma campanha.
• Gere códigos para os cupons várias vezes.
• Aplique restrições de venda regionais nas promoções e itens vinculados a um cupom.

Restrições:

• Se você vincular chaves de jogo a um cupom, uma delas será enviada por e-mail para o jogador que resgatar o cupom. Se não houver chaves restantes na campanha, a solicitação do jogador para resgatar o cupom será recusada.
• Se o cupom incluir uma promoção com restrições regionais, usuários de uma região restrita não poderão resgatá-lo.
• Se o cupom incluir um item com restrições de venda regionais, usuários de uma região restrita não poderão obter os itens vinculados a este cupom.

Fluxo do usuário:

1. Um usuário resgata um cupom.
2. A recompensa vinculada ao cupom é entregue ao usuário de uma das seguintes maneiras:
   • diretamente para o inventário (item virtual ou um pacote de moedas virtuais)
   • via e-mail (uma chave de jogo)
   • diretamente para a plataforma (uma chave de jogo)

Como obtê-lo

Pré-requisitos

1. Crie sua Conta de Distribuidor Xsolla.
2. Conecte a Loja a seu projeto.

Fluxo de integração

1. Configure uma campanha promocional com cupons.
2. Use os métodos de obter uma recompensa de cupom.
3. Use os métodos de resgate de cupom por código.

Configurar campanha com cupons

1. Abra seu projeto na Conta de Distribuidor, acesse a seção LiveOps > Promotions e crie uma promoção.
2. Especifique os parâmetros necessários:
   1. Digite o título da promoção.
   2. Escolha Cupons como tipo de promoção.
3. Escolha o item bônus que o usuário recebe ao resgatar um cupom:
   1. Pacote de moedas virtuais.
   2. Chave de jogo.
   3. Item virtual (um ou vários, incluindo pacotes e itens de tempo limitado).
4. Especifique a quantidade total de resgates e a quantidade de resgates por usuário.
5. Defina as datas de início e término da campanha.
6. Verifique as configurações e salve a promoção.
7. Vá para o menu de edição da promoção.
8. No menu Codes, escolha o método de geração de cupons.
9. Gere o código do cupom ou insira-o manualmente.
10. Salve as alterações.
11. Ative a promoção.

Cupom com pacote de moeda virtual

1. Vá para as configurações do módulo Moeda virtual e especifique os seguintes parâmetros:
   • Imagem
   • SKU
   • Nome da moeda
   • Preço de uma unidade da moeda virtual
   • Moeda padrão
2. Crie um número necessário de pacotes de moeda e especifique os seguintes parâmetros para cada um deles:
   • Imagem
   • SKU
   • Nome
   • Descrição
   • Moeda utilizada
   • Quantia em um pacote
   • Preço
   • Moeda padrão
3. Habilite os pacotes de moeda exibidos na Loja.

Cupom com chave de jogo

• Gerar cupons para o DRM já definido. O parâmetro é definido ao gerar cupons.
• Escolha um DRM ao usar um cupom.

Cupom com itens virtuais

Geração de cupons

1. Caracteres inseridos manualmente — Adequada para campanhas com apenas um cupom que pode ser usado muitas vezes (máximo de 128 caracteres).
2. Caracteres gerados — Linha de numerais e símbolos latinos (10 caracteres). Adequada para campanhas com muitos cupons.

Restrições regionais

Obter recompensas de cupom

Implemente a chamada do método Obter recompensas de cupom para obter a lista de itens que o usuário recebe após resgatar um cupom. Dependendo do valor do parâmetro is_selectable na resposta, há 2 fluxos possíveis:

1. Se o valor for is_selectable=true, você deve mostrar o formulário para escolher elementos do objeto unit_items para cada item com o elemento type=unit. Neste formulário, o usuário escolhe apenas um elemento para cada tipo de unit.

 1{
 2  "bonus": [
 3    {
 4      "item": {
 5        "sku": "xsollus_gold_edition",
 6        "name": "Xsollus: Gold Edition",
 7        "type": "unit",
 8        "description": null,
 9        "image_url": "https://cdn3.xsolla.com/img/misc/images/9541470622d96a821a9a11ea7763ea4c.png",
10        "unit_items": [
11          {
12            "sku": "xsollus_gold_edition_steam",
13            "name": "Xsollus: Gold Edition (steam)",
14            "type": "game_key",
15            "drm_name": "Steam",
16            "drm_sku": "steam"
17          },
18          {
19            "sku": "xsollus_gold_edition_playstation",
20            "name": "Xsollus: Gold Edition (playstation)",
21            "type": "game_key",
22            "drm_name": "Playstation",
23            "drm_sku": "playstation"
24          },
25          {
26            "sku": "xsollus_gold_edition_xbox",
27            "name": "Xsollus: Gold Edition (xbox)",
28            "type": "game_key",
29            "drm_name": "XBox",
30            "drm_sku": "xbox"
31          },
32          {
33            "sku": "xsollus_gold_edition_rockstar",
34            "name": "Xsollus: Gold Edition (rockstar)",
35            "type": "game_key",
36            "drm_name": "Rockstar Games Launcher",
37            "drm_sku": "rockstar"
38          }
39        ]
40      },
41      "quantity": 1
42    },
43    {
44      "item": {
45        "sku": "xsollus_bonus_pack_edition",
46        "name": "Xsollus: Bonus Pack",
47        "type": "unit",
48        "description": null,
49        "image_url": "https://cdn3.xsolla.com/img/misc/images/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
50        "unit_items": [
51          {
52            "sku": "xsollus_bonus_pack_edition_steam",
53            "name": "Xsollus: Bonus Pack (steam)",
54            "type": "game_key",
55            "drm_name": "Steam",
56            "drm_sku": "steam"
57          },
58          {
59            "sku": "xsollus_bonus_pack_edition_playstation",
60            "name": "Xsollus: Bonus Pack (playstation)",
61            "type": "game_key",
62            "drm_name": "Playstation",
63            "drm_sku": "playstation"
64          },
65          {
66            "sku": "xsollus_bonus_pack_edition_xbox",
67            "name": "Xsollus: Bonus Pack (xbox)",
68            "type": "game_key",
69            "drm_name": "XBox",
70            "drm_sku": "xbox"
71          }
72        ]
73      },
74      "quantity": 3
75    }
76  ],
77  "is_selectable": true
78}

2. Se for is_selectable=false, você não deve passar parâmetros adicionais na solicitação.

Resgatar um cupom por código

Implemente a chamada do método Resgatar código de cupom para usar um cupom. Dependendo do valor do parâmetro is_selectable na resposta do método Obter recompensas de cupom, há 2 fluxos possíveis:

1. Se is_selectable=true, você deve passar o objeto selected_unit_items no seguinte formato ao chamar o método Resgatar código de cupom:

1"selected_unit_items": {
2  "unit_1_sku": "selected_unit_item_sku",
3  "unit_2_sku": "selected_unit_item_sku"
4}

Exemplo de resposta:

 1{
 2  "items": [
 3    {
 4      "sku": "xsollus_gold_edition_steam",
 5      "name": "Xsollus: Gold Edition (steam)",
 6      "type": "game_key",
 7      "description": null,
 8      "image_url": "https://cdn3.xsolla.com/img/misc/images/9541470622d96a821a9a11ea7763ea4c.png",
 9      "attributes": [],
10      "is_free": true,
11      "groups": [],
12      "price": null,
13      "virtual_prices": [],
14      "drm_name": "Steam",
15      "drm_sku": "steam",
16      "has_keys": false,
17      "is_pre_order": true,
18      "release_date": null,
19      "quantity": 1
20    },
21    {
22      "sku": "xsollus_bonus_pack_edition_origin",
23      "name": "Xsollus: Bonus Pack (origin)",
24      "type": "game_key",
25      "description": null,
26      "image_url": "https://cdn3.xsolla.com/img/misc/images/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
27      "attributes": [],
28      "is_free": true,
29      "groups": [],
30      "price": null,
31      "virtual_prices": [],
32      "drm_name": "Origin",
33      "drm_sku": "origin",
34      "has_keys": false,
35      "is_pre_order": true,
36      "release_date": null,
37      "quantity": 3
38    }
39  ]
40}

2. Se for is_selectable=false, você não deve passar parâmetros adicionais na solicitação.