Configure campanhas promocionais

Depois de integrar a loja ao jogo, você pode configurar cupons, códigos promocionais, bônus ou promoções de desconto para atrair novos usuários e aumentar as vendas.

Você também pode executar promoções personalizadas, ou seja, configurar campanhas para usuários específicos. Você pode definir o número de itens disponíveis ao usuário na promoção. Isso só é possível para campanhas promocionais com descontos e campanhas promocionais com bônus.

Se você já tiver sido integrado ao produto Login, faça isso antes de configurar promoções personalizadas para usuários:

1. Configure atributos de usuário para seu projeto.
2. Defina o esquema de atributos do usuário na seção Login.

Atributos são recursos do usuário que são armazenados como pares de chave-valor. Com a ajuda dos atributos, você pode:

• segmentar usuários
• preparar vitrines pessoais para cada grupo de usuários em sua Web Shop.

Para garantir a integridade dos dados transmitidos, você pode definir regras de validação de atributo no formato JSON Schema na Conta de Distribuidor e gerenciar atributos de usuário usando métodos da Login API ou webhooks. Você também pode editar os valores de atributos em sua Conta de Distribuidor. Para obter mais informações, consulte Como configurar atributos de usuário.

Os cupons têm códigos que concedem itens gratuitos sem qualquer compra ou carrinho de compras. Para usar um cupom, o usuário deve inserir o código no jogo, site ou aplicativo móvel. A recompensa vinculada é então entregue ao inventário do usuário. As recompensas podem incluir:

• pacote de moedas virtuais
• item virtual

Os códigos promocionais aplicam um desconto ao carrinho de compras ou adicionam itens gratuitos ao carrinho durante o checkout. Depois de ativar o código promocional e pagar pelos itens no carrinho, o usuário pode receber uma das seguintes recompensas:

• um desconto que se aplica ao carrinho do usuário
• itens de bônus:
• pacote de moedas virtuais
• item virtual incluindo um conjunto ou itens de tempo limitado

Os usuários também podem receber um bônus ao comprar itens promocionais. Os bônus podem incluir:

• pacote de moedas virtuais
• item virtual, incluindo um pacote ou itens de tempo limitado

Uma promoção de desconto permite que você configure um desconto em um ou mais produtos. Um número ilimitado de promoções pode ser aplicado a um produto. Os descontos não são cumulativos, mas são aplicados ao custo de cada item. Os descontos podem ser aplicados a um ou vários dos seguintes itens:

• pacote de moedas virtuais
• item virtual, incluindo itens de tempo limitado

Campanha promocional com cupons

Para iniciar uma campanha promocional com cupons:

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

Configure uma campanha promocional com cupons

1. Abra seu projeto na Conta de Distribuidor.
2. Clique em Store no menu lateral e vá para Promotions.
3. Clique em Create promotion.
4. Especifique os seguintes parâmetros:
   1. Insira o título da promoção.
   2. Escolha Coupons como o tipo de promoção.
5. Escolha a recompensa que o usuário recebe ao resgatar um cupom. Opções disponíveis:
   • Pacote de moedas virtuais
   • Item virtual (um ou vários, incluindo conjuntos e itens de tempo limitado).
6. Adicione:
   1. Identificador promocional em External ID.
   2. Itens bônus que o usuário recebe quando resgata um cupom.
   3. Tipo e quantidade do item.
7. Clique em Next.
8. Especifique o número total de resgates e o número de resgates por usuário.
9. Defina as datas de início e término da campanha.
10. Clique em Next.
11. Verifique as configurações e clique em Save and exit.

12. Clique em Store no menu lateral e vá para Promotions.
13. Selecione a promoção, clique no botão de menu ••• para abrir um menu e clique em Edit plan.
14. Vá para a aba Codes.
15. Especifique como os cupons são gerados.
16. Gere o código do cupom ou insira-o manualmente.
17. Ative a promoção.

Resgatar um cupom por código

Implemente a chamada do método Redeem coupon code para usar um cupom. Dependendo do valor do parâmetro is_selectable na resposta do método Redeem coupon code, 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 Get coupon rewards:

selected_unit_items:{
      unit_1_sku: "selected_unit_item_sku",
      unit_2_sku: "selected_unit_item_sku"
}

Exemplo de resposta:

{
  {
    "items": [
    {
      "sku": "xsollus_gold_edition_steam",
      "name": "Xsollus: Gold Edition (steam)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Steam",
      "drm_sku": "steam",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 1
    },
    {
      "sku": "xsollus_bonus_pack_edition_origin",
      "name": "Xsollus: Bonus Pack (origin)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Origin",
      "drm_sku": "origin",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 3
  }
  ]
}

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

Obter recompensas de cupom

Implemente a chamada do método Get coupon rewards 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.

{
	"bonus": [{
		"item": {
			"sku": "xsollus_gold_edition",
			"name": "Xsollus: Gold Edition",
			"type": "unit",
			"description": null,
			"image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
			"unit_items": [{
				"sku": "xsollus_gold_edition_steam",
				"name": "Xsollus: Gold Edition (steam)",
				"type": "game_key",
				"drm_name": "Steam",
				"drm_sku": "steam"
			}, {
				"sku": "xsollus_gold_edition_playstation",
				"name": "Xsollus: Gold Edition (playstation)",
				"type": "game_key",
				"drm_name": "Playstation",
				"drm_sku": "playstation"
			}, {
				"sku": "xsollus_gold_edition_xbox",
				"name": "Xsollus: Gold Edition (xbox)",
				"type": "game_key",
				"drm_name": "XBox",
				"drm_sku": "xbox"
			}, {
				"sku": "xsollus_gold_edition_rockstar",
				"name": "Xsollus: Gold Edition (rockstar)",
				"type": "game_key",
				"drm_name": "Rockstar Games Launcher",
				"drm_sku": "rockstar"
			}]
		},
		"quantity": 1
	}, {
		"item": {
			"sku": "xsollus_bonus_pack_edition",
			"name": "Xsollus: Bonus Pack",
			"type": "unit",
			"description": null,
			"image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
			"unit_items": [{
				"sku": "xsollus_bonus_pack_edition_steam",
				"name": "Xsollus: Bonus Pack (steam)",
				"type": "game_key",
				"drm_name": "Steam",
				"drm_sku": "steam"
			}, {
				"sku": "xsollus_bonus_pack_edition_playstation",
				"name": "Xsollus: Bonus Pack (playstation)",
				"type": "game_key",
				"drm_name": "Playstation",
				"drm_sku": "playstation"
			}, {
				"sku": "xsollus_bonus_pack_edition_xbox",
				"name": "Xsollus: Bonus Pack (xbox)",
				"type": "game_key",
				"drm_name": "XBox",
				"drm_sku": "xbox"

			}]
		},
		"quantity": 3
	}],
	"is_selectable": true

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

Campanha promocional com códigos promocionais

Para iniciar uma campanha promocional com códigos promocionais:

1. Configure uma campanha promocional com códigos promocionais.
2. Implemente os métodos de resgate de códigos promocionais.
3. Implemente o método de obter uma recompensa com um código promocional.

Configure uma campanha promocional com códigos promocionais

1. Abra seu projeto na Conta de Distribuidor.
2. Clique em Store no menu lateral e vá para Promotions.
3. Clique em Create promotion.
4. Especifique os seguintes parâmetros:
   1. Insira o título da promoção.
   2. Escolha Promo code como o tipo de promoção.
5. Escolha o que o usuário recebe ao resgatar um código promocional: sem recompensa, desconto em todos os itens do carrinho, desconto em itens específicos, itens bônus ou uma combinação entre eles.
6. Defina o valor do desconto.
7. Clique em Next.
8. Especifique o número total de resgates e o número de resgates por usuário.
9. Clique em Next.
10. Defina as datas de início e término da campanha.
11. Clique em Next.
12. Verifique as configurações e clique em Save and exit.

13. Clique em Store no menu lateral e vá para Promotions.
14. Selecione a promoção, clique no botão de menu ••• para abrir um menu e clique em Edit plan.
15. Vá para a aba Codes.
16. Especifique como os cupons promocionais são gerados.
17. Gere o código promocional ou insira-o manualmente.
18. Ative a promoção.

Resgate de um código promocional

Implemente a chamada do método Redeem promo code para usar um código promocional. Dependendo do valor do parâmetro is_selectable, há 2 fluxos possíveis na resposta do método Get promo code rewards:

1. Se is_selectable=true, você deve passar o objeto selected_unit_items no seguinte formato ao chamar o método Redeem promo code:

selected_unit_items:{
      unit_1_sku: "selected_unit_item_sku",
      unit_2_sku: "selected_unit_item_sku"
}

Exemplo de resposta:

{
  {
    "items": [
    {
      "sku": "xsollus_gold_edition_steam",
      "name": "Xsollus: Gold Edition (steam)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Steam",
      "drm_sku": "steam",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 1
    },
    {
      "sku": "xsollus_bonus_pack_edition_origin",
      "name": "Xsollus: Bonus Pack (origin)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Origin",
      "drm_sku": "origin",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 3
    }
    ]
}

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

Recebimento de recompensas com códigos promocionais

Implemente a chamada do método Get promo code rewards para obter a lista de itens que o usuário recebe após resgatar um código promocional. 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.

{
	"bonus": [{
		"item": {
			"sku": "xsollus_gold_edition",
			"name": "Xsollus: Gold Edition",
			"type": "unit",
			"description": null,
			"image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
			"unit_items": [{
				"sku": "xsollus_gold_edition_steam",
				"name": "Xsollus: Gold Edition (steam)",
				"type": "game_key",
				"drm_name": "Steam",
				"drm_sku": "steam"
			}, {
				"sku": "xsollus_gold_edition_playstation",
				"name": "Xsollus: Gold Edition (playstation)",
				"type": "game_key",
				"drm_name": "Playstation",
				"drm_sku": "playstation"
			}, {
				"sku": "xsollus_gold_edition_xbox",
				"name": "Xsollus: Gold Edition (xbox)",
				"type": "game_key",
				"drm_name": "XBox",
				"drm_sku": "xbox"
			}, {
				"sku": "xsollus_gold_edition_nintendo_eshop",
				"name": "Xsollus: Gold Edition (nintendo_eshop)",
				"type": "game_key",
				"drm_name": "Nintendo Switch eShop",
				"drm_sku": "nintendo_eshop"
			}]
		},
		"quantity": 1
	}, {
		"item": {
			"sku": "xsollus_bonus_pack_edition",
			"name": "Xsollus: Bonus Pack",
			"type": "unit",
			"description": null,
			"image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
			"unit_items": [{
				"sku": "xsollus_bonus_pack_edition_steam",
				"name": "Xsollus: Bonus Pack (steam)",
				"type": "game_key",
				"drm_name": "Steam",
				"drm_sku": "steam"
			}, {
				"sku": "xsollus_bonus_pack_edition_origin",
				"name": "Xsollus: Bonus Pack (origin)",
				"type": "game_key",
				"drm_name": "Origin",
				"drm_sku": "origin"
			}, {
				"sku": "xsollus_bonus_pack_edition_drmfree",
				"name": "Xsollus: Bonus Pack (drmfree)",
				"type": "game_key",
				"drm_name": "DRM Free",
				"drm_sku": "drmfree"
			}, {
				"sku": "xsollus_bonus_pack_edition_gog",
				"name": "Xsollus: Bonus Pack (gog)",
				"type": "game_key",
				"drm_name": "GOG",
				"drm_sku": "gog"
			}, {
				"sku": "xsollus_bonus_pack_edition_rockstar",
				"name": "Xsollus: Bonus Pack (rockstar)",
				"type": "game_key",
				"drm_name": "Rockstar Games Launcher",
				"drm_sku": "rockstar"
			}]
		},
		"quantity": 3
	}],
	"discount": {
		"percent": null
	},
	"is_selectable": true

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

Campanha promocional com bônus

Para iniciar uma campanha promocional com bônus:

1. Abra seu projeto em Conta de Distribuidor.
2. Clique em Store no menu lateral e vá até Promotions.
3. Clique em Create promotion.
4. Especifique os seguintes parâmetros:
   1. Insira o título da promoção.
   2. Escolha Bonus como tipo de promoção.
5. Choose promotional items.
6. Escolha itens concedidos aos usuários ao comprarem itens promocionais.
7. Clique em Next.
8. Se quiser que a promoção se aplique apenas aos usuários que fizerem a primeira compra, marque a opção Trigger promotion only for first-time buyers como On. As opções Limit the number of times one user can use promotion e Promotion for only specific users serão ativadas automaticamente e um conjunto de condições para acionar a promoção será criado. Adicione mais condições, se necessário.
9. Caso deseje configurar uma promoção para usuários específicos, marque a opção Trigger promotion only for specific users como On e especifique as condições.
10. Se quiser limitar a disponibilidade de uma promoção a usuários específicos, marque a opção Limit number of times one user can use promotion como On e especifique o número de vezes.
11. Clique em Next.
12. Defina as datas de início e de término da campanha.
13. Clique em Next.
14. Verifique as configurações e clique em Save and Exit.

15. Clique em Store no menu lateral e vá para Promotions.
16. Selecione a promoção, clique no botão de menu ••• para abrir um menu e clique em Edit plan.
17. Ative a promoção.

Campanha promocional com descontos

Configure uma campanha promocional com descontos através da Conta de Distribuidor

1. Abra seu projeto em Conta de Distribuidor.
2. Na barra lateral, clique em Store.
3. Clique em Promotions > Create promotion.
4. Especifique os seguintes parâmetros:
   1. Insira o título da promoção.
   2. Escolha Discount como tipo de promoção.
5. Configure descontos que se aplicam a um ou vários itens.
6. Defina o valor do desconto.
7. Clique em Next.
8. Se quiser que a promoção se aplique apenas aos usuários que fizerem a primeira compra, marque a opção Trigger promotion only for first-time buyers como On. As opções Limit number of times one user can use promotion e Promotion for only specific users serão ativadas automaticamente e um conjunto de condições para acionar a promoção será criado. Adicione mais condições, se necessário.
9. Se quiser configurar uma promoção para usuários específicos, marque a opção Trigger promotion only for specific users como On e especifique as condições.
10. Caso deseje limitar a disponibilidade de uma promoção a usuários específicos, marque a opção Limit number of times one user can use promotion como On e especifique o número de vezes.
11. Clique em Next.
12. Defina as datas de início e de término da campanha.
13. Clique em Next.
14. Verifique as configurações e clique em Save and Exit.

15. Clique em Store no menu lateral e vá para Promotions.
16. Selecione a promoção, clique no botão de menu ••• para abrir um menu e clique em Edit plan.
17. Ative a promoção.

Configure uma campanha promocional com descontos via API

Para trabalhar com promoções de desconto, você pode usar os métodos da subseção Discount do grupo de métodos Promotions.

Para criar a promoção por meio dos métodos de API:

1. Chame o método Create discount promotion for item com os parâmetros necessários.
2. Chame o método Update item promotion com o parâmetro “is_enabled”:true para ativar a promoção.

Para editar a promoção por meio de um API, chame o método Update item promotion com novos parâmetros de promoção. Você também pode editar promoções que tenham o status Active.

Ao criar ou editar uma promoção de desconto por meio de métodos de API, você também pode:

• Configurar um desconto para todos os itens do projeto. Passe o parâmetro “items”:null para os métodos Create discount promotion for item ou Update item promotion.

• Configure um desconto para bens físicos. Passe uma matriz com SKUs de bens físicos para os métodos Create discount promotion for item ou Update item promotion.

• Configure um desconto com o valor percentual da fração. Passe o parâmetro discount.percent com um desconto de fração para os métodos Create discount promotion for item ou Update item promotion.

• Configure um desconto para itens de tipos diferentes. Passe uma matriz com SKUs dos itens necessários para os métodos Create discount promotion for item ou Update item promotion.

• Configure um desconto para DRMs definitivos do jogo. Passe uma matriz com SKUs dos DRMs necessários para os métodos Create discount promotion for item ou Update item promotion.

• Configure uma promoção de desconto que não tem um período especificado. Passe o parâmetro “date_end”:null para os métodos Create discount promotion for item ou Update item promotion.