> ## 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.

# Store 開發權利工具 (DevEntitlementTool.exe)

> 命令列 DevEntitlementTool.exe，可查詢、新增與移除開發沙箱中 XBOX 測試帳戶的 Microsoft Store 權利。

用於查詢、新增與移除沙箱中 XBOX 測試帳戶之 Microsoft Store 權利的命令列工具。

## 使用方式

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

| 命令 | 描述 |
| - | - |
| [query](#query) | 查詢帳戶所擁有的權利 |
| [add](#add) | 將一或多個指定的權利新增至帳戶 |
| [delete](#delete) | 從帳戶刪除一或多個指定的權利 |
| [catalog](#catalog) | 顯示指定的父產品可銷售的可用產品 |

所有命令都需要 /e (電子郵件) 與 /s (沙箱) 參數。
首次以帳戶登入時，會叫用互動式密碼輸入對話方塊。
成功登入後，在該裝置上以相同帳戶/沙箱進行的後續作業就不再需要輸入密碼。

## query

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

列出此帳戶在沙箱中直接擁有的所有權利。

### query 輸出

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

### 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
```

使用 /d 顯示每項權利的更多詳細資料：

```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]`

將一或多個指定產品的權利新增至帳戶。
此命令等同於從 Store 或透過購買 API 購買產品。

對已具備權利的遊戲、耐久性商品、組合包或開發人員管理的消耗性商品執行 `add` 作業時，不會新增另一項權利，此工具會回報現有的權利。

對於 Store 管理的消耗性產品，每次執行 add 命令都會在消耗性商品餘額中新增預設數量 `1`。
您可以指定選用的數量值來變更此預設值，但只有在以 /p 傳遞單一 productID 時才能使用數量欄位。
此選項適用於購買時授與大於 `1` 之數量的消耗性商品。

支援使用 /d 顯示更多詳細資料。

\[!NOTE] 此工具無法驗證數量。
若要判斷項目的目前數量，請檢查 [XStoreCollectionData](https://docs.xbox.com/zh-TW/reference/system/xstore/structs/xstorecollectiondata.md) 結構。

對組合包產品執行 `add` 作業會授與其包含的所有產品。
如果指定了數量且組合包包含 Store 管理的消耗性商品，則會為每個消耗性商品指派相同的數量。

> [!NOTE]
>
> 不支援訂閱產品。

### add 輸出

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

### add 範例

新增單一權利

```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
```

新增多項權利

```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
```

以指定數量新增消耗性商品

```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]`

從帳戶刪除一或多個指定的權利。

如果指定 `/all`，則會嘗試刪除與該帳戶及沙箱相關聯的所有權利。

刪除由此工具授與的權利時，會顯示 Revoked 狀態。

刪除透過 Store 用戶端或遊戲內 API 以一般方式購買的權利時，會顯示 Refunded 狀態。

支援使用 /d 顯示更多詳細資料。

### delete 輸出

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

### 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]`

顯示所提供之產品 ID 可銷售的產品集合；也就是子附加元件產品，以及在 Partner Center 中與該 productID 具有 *can use and sell* 關聯性的產品。
此命令的結果等同於 [XStoreQueryAssociatedProductsAsync](https://docs.xbox.com/zh-TW/reference/system/xstore/functions/xstorequeryassociatedproductsasync.md) 所傳回的內容。
在 Partner Center 中設定為 *available but not discoverable in the Microsoft Store* 的產品不會傳回。
您可以選擇性地指定市場，以擷取該特定市場的價格。
此參數必須是 ISO 雙字元區域代碼，例如 GB、CA、JP、ES 等。

### 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}
...
```

### 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
```

## 備註

此工具僅限用於 XBOX 測試帳戶與沙箱產品。
已封鎖用於零售帳戶與情境。

每個帳戶每天的 add 與 delete 作業次數有上限。
此上限會根據觀察到的使用情形進行調整。
若要要求提高上限或提供其他意見反應，請透過您的 Microsoft 帳戶代表聯絡。

## 參考 API 文件

* [XStore (API 內容)](https://docs.xbox.com/zh-TW/reference/system/xstore/xstore_members.md)
  * 函式
    * [XStoreQueryAssociatedProductsAsync](https://docs.xbox.com/zh-TW/reference/system/xstore/functions/xstorequeryassociatedproductsasync.md)
  * 結構
    * [XStoreCollectionData](https://docs.xbox.com/zh-TW/reference/system/xstore/structs/xstorecollectiondata.md)


## Related topics

- [XStoreCollectionData](https://docs.xbox.com/zh-TW/reference/system/xstore/structs/xstorecollectiondata.md)
- [XBOX 服務的開發工具](https://docs.xbox.com/zh-TW/tools/tools-services/live-tools.md)
- [XBOX 服務的工具](https://docs.xbox.com/zh-TW/tools/tools-services/live-tools-nav.md)
- [XStoreQueryAssociatedProductsAsync](https://docs.xbox.com/zh-TW/reference/system/xstore/functions/xstorequeryassociatedproductsasync.md)
- [XBOX 與 PlayFab 的線上服務工具](https://docs.xbox.com/zh-TW/tools/tools-services/index.md)
