Assinaturas do Economy v2

As assinaturas permitem conceder acesso por tempo limitado a bens duráveis. Os itens de uma assinatura são desempacotados no inventário do jogador após a chamada de GetInventoryItems.

Este artigo aborda as assinaturas virtuais, ou seja, as assinaturas que existem dentro do seu jogo.

Criar uma assinatura

Para criar uma assinatura, primeiro você deve garantir que publicou itens do catálogo, moedas ou conteúdo gerado pelo usuário (UGC) que deseja tornar acessíveis/compráveis no seu jogo. Para configurar seu catálogo antes de criar uma assinatura, consulte Início rápido do Economy V2

GameManager

Navegue até Economy > Catalog (V2).
Na guia Subscriptions, selecione New Subscription.

API

Você pode usar a API CreateDraftItem para criar uma assinatura. Um exemplo de solicitação da API CreateDraftItem para criar uma assinatura:

{
  "Item": {
   "Type": "subscription",
    "Title": {
      "NEUTRAL": "Holiday Skins Pass"
    },
    "StartDate": "2023-03-07T00:01:00.0000000Z",
    "ItemReferences":[
      {
        "Id":"{{GlowingGlovesItemID}}",
        "Amount": 1
      }, 
      {
        "Id":"{{ShinyShoesItemID}}", 
        "Amount": 1
      }
    ],
        "PriceOptions": {
          "Prices": [
        {
            "UnitDurationInSeconds":604800,
              "Amounts": [
                {
                    "ItemId": "{{DiamondItemID}}",
                    "Amount": 5
                },
                {
                    "ItemId": "{{GoldItemID}}",
                    "Amount": 10
                }
                ]
        },      
        {
            "UnitDurationInSeconds":2628000,
              "Amounts": [
                {
                    "ItemId": "{{DiamondItemID}}",
                    "Amount": 7
                },
                {
                    "ItemId": "{{GoldItemID}}",
                    "Amount": 12
                }
                ]
        } ]
          }
        },
  "Publish": true
}

A assinatura Holiday Skins Pass acima concede dois itens, Glowing Gloves e Shiny Shoes, com dois preços para dois períodos de validade diferentes. O primeiro conjunto de preços, de 5 diamantes e 10 de ouro, garante que a assinatura seja válida por uma semana, enquanto o segundo conjunto de preços, de 7 diamantes e 12 de ouro, garante que a assinatura seja válida por um mês. Observe que a duração precisa ser definida em segundos. Isso deve retornar uma resposta indicando que a assinatura foi criada e publicada:

{
  "code": 200,
    "status": "OK",
    "data": {
        "Item": {
            "Id": "{{NewlyCreatedSubscriptionItemID}}",
            "Type": "subscription",
            "AlternateIds": [],
            "Title": {
                "NEUTRAL": "Holiday Skins Pass"
            },
    ...
}

Assinaturas no inventário

As assinaturas estarão presentes na coleção de inventário do jogador com um ID, StackId, data de expiração e propriedades de exibição. Tudo em uma assinatura pode ser modificado como qualquer outro item usando Add, Subtract, Update etc. Você pode usar GetInventoryItems com um filtro de Type para recuperar todas as assinaturas que um jogador possui atualmente.

{ 
    "Entity": {
        "Type": "title_player_account", 
        "Id": "ID" 
    }, 
    "CollectionId": "default", 
    "Filter": "type eq 'subscription'"
}

**Sample Response**

{
    "code": 200,
    "status": "OK",
    "data": {
        "Items": [
            {
                "Id": "{{SubscriptionID}}",
                "StackId": "default",
                "DisplayProperties": {},
                "Type": "subscription",
                "ExpirationDate": "2023-08-27T23:59:59Z"
            }
        ],
        "ETag": "1/Mw=="
    }
}

Uma assinatura não expirada é desempacotada no momento da leitura. Os itens desempacotados têm o ID esperado e um StackId composto exclusivo formado pelo ID da assinatura e pelo StackId da assinatura. A quantidade é definida como a quantidade configurada na referência de item da assinatura. Esses itens desempacotados são imutáveis e não podem ser modificados usando Add, Subtract, Update etc.

{ 
    "Entity": {
        "Type": "title_player_account", 
        "Id": "ID" 
    }, 
    "CollectionId": "default", 
    "Filter": "StackId eq 'SubscriptionItemID:default'"
}

**Sample Response**

{
    "code": 200,
    "status": "OK",
    "data": {
        "Items": [
            {
                "Id": "{{GlowingGlovesItemID}}",
                "StackId": "{{SubscriptionID:default}}",
                "DisplayProperties": {},
                "Amount": 1,
                "Type": "catalogItem"
            },
            {
                "Id": "{{ShinyShoesItemID}}",
                "StackId": "{{SubscriptionID:default}}",
                "DisplayProperties": {},
                "Amount": 1,
                "Type": "catalogItem"
            }
        ],
        "ETag": "1/NQ=="
    }
}

O desempacotamento da assinatura ocorre antes da filtragem e da paginação, de modo que os itens da assinatura possam ser filtrados e paginados de forma confiável como qualquer outro item de uma coleção. Você pode usar UpdateInventoryItems, AddInventoryItems e SubtractIventoryItems para atualizar a data de expiração de uma assinatura de um jogador. A chamada da API UpdateInventoryItems aqui está atualizando a data de expiração da assinatura.

{
   "Entity": { 
      "Type": "title_player_account", 
      "Id": "{{ID}}" 
    }, 
  "CollectionId": "default", 
   "Item": { 
        "Id": "{{SubscriptionID}}", 
        "StackId": "default",
        "DisplayProperties": {},
        "Type": "subscription",
        "ExpirationDate": "2023-03-27T23:59:59Z" 
    } 
} 

A chamada da API AddInventoryItems aqui está estendendo a data de expiração ao aumentar o parâmetro DurationInSeconds.

{
    "Entity": { 
        "Type": "title_player_account", 
        "Id": "{{ID}}" 
    }, 
    "CollectionId": "default", 
    "Item": { 
        "Id": "{{SubscriptionID}}" 
    }, 
    "DurationInSeconds":2628000 
} 

A chamada da API SubtractInventoryItems aqui está reduzindo a data de expiração ao diminuir o parâmetro DurationInSeconds.

{
    "Entity": { 
        "Type": "title_player_account", 
        "Id": "{{ID}}" 
    }, 
    "CollectionId": "default", 
    "Item": { 
        "Id": "{{SubscriptionID}}" 
    }, 
    "DurationInSeconds":60 
} 

XBOX Services

PlayFab

Criar uma assinatura

GameManager

API

Assinaturas no inventário

​Criar uma assinatura

​GameManager

​API

​Assinaturas no inventário

Criar uma assinatura

GameManager

API

Assinaturas no inventário