> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ferramenta de direitos de desenvolvimento da Store (DevEntitlementTool.exe)

> Ferramenta de linha de comando DevEntitlementTool.exe que consulta, adiciona e remove direitos da Microsoft Store de contas de teste XBOX em sandboxes de desenvolvimento.

Ferramenta de linha de comando para consultar, adicionar e remover direitos da Microsoft Store de contas de teste XBOX em sandbox.

## Uso

`deventitlementtool <command> /e <testaccountemail> /s <sandboxid> [/p <productid>] [...]`

| Comando | Descrição |
| - | - |
| [query](#query) | Pesquisa os direitos de propriedade de uma conta |
| [add](#add) | Adiciona um ou mais direitos especificados à conta |
| [delete](#delete) | Exclui um ou mais direitos especificados da conta |
| [catalog](#catalog) | Mostra os produtos disponíveis que podem ser vendidos pelo produto pai especificado |

Todos os comandos exigem os parâmetros /e (e-mail) e /s (sandbox).
A entrada inicial com uma conta abre uma caixa de diálogo interativa para inserção de senha.
Depois de entrar com êxito, as operações seguintes com a mesma conta/sandbox no dispositivo não exigem mais a inserção da senha.

## query

`deventitlementtool query /e <testaccountemail> /s <sandboxid> [/d]`

Lista todos os direitos de propriedade direta associados a essa conta na sandbox.

### Saída do query

```text theme={null}
Entitlements found: {Number of entitlements}
{ProductID}: {Last Updated Date (UTC)} {Status}
...
```

### Exemplo de query

```text theme={null}
> DevEntitlementTool.exe query /e xdks-testaccount00000@xboxtest.com /s XDKS.1
Entitlements found: 2
9MT5TGW893HV: 4/18/2023 5:05:19 PM  Active
9N30KZZF4BR9: 7/24/2024 2:34:08 AM  Active
```

Use /d para mostrar mais detalhes de cada direito:

```text theme={null}
> DevEntitlementTool.exe query /e xdks-testaccount00000@xboxtest.com /s XDKS.1 /d
Entitlements found: 2
9MT5TGW893HV: 4/18/2023 5:05:19 PM  Active Consumable   ATG Sample Consumable 3
9N30KZZF4BR9: 7/24/2024 2:34:08 AM  Active Durable      ATG Sample Durable 1
```

## add

`deventitlementtool add /e <testaccountemail> /s <sandboxid> /p <productid1> [<productid2> <productid3> ...] [/q <quantity>] [/d]`

Adiciona à conta um direito para um ou mais produtos especificados.
Esse comando equivale a comprar o produto na Store ou por meio da API de compra.

A operação `add` com um jogo, durável, pacote ou consumível gerenciado pelo desenvolvedor do qual a conta já tem direito não adiciona outro direito, e a ferramenta informa o direito existente.

Para produtos consumíveis gerenciados pela Store, uma quantidade padrão de `1` é adicionada ao saldo do consumível em cada comando add.
Um valor de quantidade opcional pode ser especificado para alterar esse valor padrão, mas o campo de quantidade só pode ser usado se um único productID for passado com /p.
Essa opção é útil para consumíveis que concedem uma quantidade maior que `1` na compra.

Há suporte para /d para mais detalhes.

\[!NOTE] A quantidade não pode ser verificada com esta ferramenta.
Para determinar a quantidade atual de um item, examine a struct [XStoreCollectionData](https://docs.xbox.com/pt-BR/reference/system/xstore/structs/xstorecollectiondata.md).

A operação `add` com um produto de pacote concede todos os produtos incluídos nele.
Se uma quantidade for especificada e o pacote incluir consumíveis gerenciados pela Store, a mesma quantidade será atribuída a cada consumível.

> [!NOTE]
>
> Não há suporte para produtos de assinatura.

### Saída do add

```console theme={null}
Entitlements added: {Number of entitlements}
{ProductID}: {Last Updated Date (UTC)} {Status}
...
```

### Exemplos de add

Um único direito adicionado

```console theme={null}
> DevEntitlementTool.exe add /e xdks-test00000@xboxtest.com /s XDKS.1 /p 9MT5TGW893HV
Entitlements added: 1
9MT5TGW893HV: 2/20/2024 12:21:25 AM Active
```

Vários direitos adicionados

```console theme={null}
> DevEntitlementTool.exe add /e xdks-test00000@xboxtest.com /s XDKS.1 /p 9P23V43P0XZZ 9N30KZZF4BR9 9NCX1H100M18
Entitlements added: 4
9P23V43P0XZZ: 2/20/2024 12:33:20 AM Active
9N30KZZF4BR9: 2/20/2024 12:33:20 AM Active
9NCX1H100M18: 2/20/2024 12:33:20 AM Active
```

Adicionar consumível com quantidade

```console theme={null}
> DevEntitlementTool.exe add /e xdks-test00000@xboxtest.com /s XDKS.1 /p 9MT5TGW893HV /q 4321
Entitlements added: 1
9MT5TGW893HV: 2/20/2024 12:34:35 AM Active
```

## delete

`deventitlementtool delete /e <testaccountemail> /s <sandboxid> /p <productid1> [<productid2> <productid3> ...] [/all] [/d]`

Exclui um ou mais direitos especificados da conta.

Se `/all` for especificado, a ferramenta tentará excluir todos os direitos associados à conta e à sandbox.

O status Revoked é exibido ao excluir direitos concedidos por esta ferramenta.

O status Refunded é exibido ao excluir direitos que foram comprados da forma convencional por meio do cliente da Store ou da API no jogo.

Há suporte para /d para mais detalhes.

### Saída do delete

```console theme={null}
Entitlements deleted: {Number of entitlements}
{ProductID}: {Last Updated Date (UTC)} {Status}
...
```

### Exemplos de delete

```console theme={null}
> DevEntitlementTool.exe delete /e xdks-test00000@xboxtest.com /s XDKS.1 /p 9P23V43P0XZZ 9N30KZZF4BR9 9NCX1H100M18
Entitlements deleted: 3
9P23V43P0XZZ: 2/20/2024 2:26:13 AM Revoked
9N30KZZF4BR9: 2/20/2024 2:26:13 AM Revoked
9NCX1H100M18: 2/20/2024 2:26:13 AM Revoked
```

```console theme={null}
> DevEntitlementTool.exe delete /e xdks-test00000@xboxtest.com /s XDKS.1 /p 9PLRFWZWWF91
Entitlements deleted: 1
9PLRFWZWWF91: 1/1/0001 12:00:00 AM Refunded
```

## catalog

`deventitlementtool catalog /e <testaccountemail> /s <sandboxid> /p <productid1> [/m]`

Mostra o conjunto de produtos que podem ser vendidos pelo ID de produto fornecido; ou seja, produtos de complemento filhos e produtos com uma relação *can use and sell* com o productID no Partner Center.
Esse comando equivale ao retornado por [XStoreQueryAssociatedProductsAsync](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstorequeryassociatedproductsasync.md).
Os produtos não são retornados quando configurados no Partner Center como *disponíveis, mas não detectáveis na Microsoft Store*.
Opcionalmente, um mercado pode ser especificado para recuperar os preços desse mercado específico.
O parâmetro precisa ser um código de região ISO de dois caracteres, por exemplo, GB, CA, JP, ES etc.

### Saída do catalog

```console theme={null}
Parent product: {ProductID} ({Parent Product Name})
can sell {Number of products} products:
1. {ProductID} {Product Name} {Product Type} {Price}
2. {ProductID} {Product Name} {Product Type} {Price}
...
```

### Exemplo de catalog

```console theme={null}
> DevEntitlementTool.exe catalog /e xdks-test00000@xboxtest.com /s XDKS.1 /p 9NTL0QDWZ4FS /m SG
Parent product: 9NTL0QDWZ4FS (ATG In-Game Store)
can sell 16 products:
 1. 9PHPTTDP88F7: ATG Season Pass 1                        Durable      23.25 SGD
 2. 9NMDDZC7ZWRM: ATG Sample Year 1 Pass                   Durable      2850 SGD
 3. 9PGLXLWS7319: ATG Consumable Only Bundle               Durable      7.2 SGD
 4. 9P23V43P0XZZ: ATG Sample Durable 2                     Durable      0 SGD
 5. 9MZ0MGGFPLTP: ATG Sample Subscription 1                Durable      0 SGD
 6. 9MT5TGW893HV: ATG Sample Consumable 3                  Consumable   4.35 SGD
 7. 9N30KZZF4BR9: ATG Sample Durable 1                     Durable      0 SGD
 8. 9PLRFWZWWF91: ATG Sample Durable 4                     Durable      0 SGD
 9. 9PLNMXRKNM4C: ATG Sample Durable 1 (with package)      Durable      0 SGD
10. 9P8S15PJTB0P: ATG Sample Durable 3                     Durable      48.75 SGD
11. 9NCX1H100M18: ATG Sample Consumable 2                  Consumable   2.85 SGD
12. 9N0297GK108W: ATG Dev managed consumable 1             Consumable   2.1 SGD
13. 9NQWJKKNHF1L: ATG Downloadable Content Sample          Game         0 SGD
14. 9NRGW2QG5PCW: ATG Sample Pre-Order 1                   Durable      0 SGD
15. 9PHHWZ12RR23: ATG In-Game Store Deluxe Add-on          Durable      0 SGD
16. 9PFL4RQTB1P6: ATG Sample Consumable 1                  Consumable   1.5 SGD
```

## Comentários

Esta ferramenta é estritamente para uso com contas de teste XBOX e com produtos de sandbox.
O uso com contas e cenários de varejo é bloqueado.

Há um limite de operações add e delete por conta por dia.
Esse limite é ajustado com base no uso observado.
Para solicitar limites maiores ou enviar outros comentários, entre em contato com seu representante de conta da Microsoft.

## Documentação de referência da API

* [XStore (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xstore/xstore_members.md)
  * Funções
    * [XStoreQueryAssociatedProductsAsync](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstorequeryassociatedproductsasync.md)
  * Estruturas
    * [XStoreCollectionData](https://docs.xbox.com/pt-BR/reference/system/xstore/structs/xstorecollectiondata.md)


## Related topics

- [XStoreCollectionData](https://docs.xbox.com/pt-BR/reference/system/xstore/structs/xstorecollectiondata.md)
- [Ferramentas de desenvolvimento para serviços XBOX](https://docs.xbox.com/pt-BR/tools/tools-services/live-tools.md)
- [Ferramentas para serviços XBOX](https://docs.xbox.com/pt-BR/tools/tools-services/live-tools-nav.md)
- [XStoreQueryAssociatedProductsAsync](https://docs.xbox.com/pt-BR/reference/system/xstore/functions/xstorequeryassociatedproductsasync.md)
- [Habilitar testes de licenciamento](https://docs.xbox.com/pt-BR/publishing/xstore-commerce/xstore-licensing-setup.md)
