管理應用程式提交

Microsoft Store 提交 API 提供可用來管理應用程式提交的方法，包括漸進式套件推出。 如需 Microsoft Store 提交 API 的簡介，包括使用 API 的先決條件，請參閱使用 Microsoft Store 服務建立和管理提交。

重要

如果您使用 Microsoft Store 提交 API 建立應用程式的提交，請務必只使用 API 對提交進行進一步變更，而不是在合作夥伴中心進行變更。 如果您使用合作夥伴中心來變更您最初使用 API 建立的提交，您將無法再使用 API 變更或認可該提交。 在某些情況下，提交可能會處於錯誤狀態，而無法在提交程序中繼續。 如果發生這種情況，您必須刪除提交並建立新的提交。

重要

您無法使用此 API 針對透過商務用 Microsoft Store 和教育用 Microsoft Store 的大量購買發佈提交，或將 LOB 應用程式的提交直接發佈至企業。 在這兩個案例中，您必須使用合作夥伴中心來發佈提交。

管理應用程式提交的方法

使用下列方法來取得、建立、更新、認可或刪除應用程式提交。 使用這些方法之前，應用程式必須已存在於合作夥伴中心帳戶中，您必須先在合作夥伴中心為應用程式建立一個提交。 如需詳細資訊，請參閱先決條件。

方法	URI	描述
GET	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}	取得現有的應用程式提交
GET	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status	取得現有應用程式提交的狀態
POST	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions	建立新的應用程式提交
PUT	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}	更新現有的應用程式提交
POST	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit	認可新的或更新的應用程式提交
DELETE	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}	刪除應用程式提交

建立應用程式提交

若要建立應用程式提交，請遵循此流程。

1. 如果您尚未執行此操作，請完成 Microsoft Store 提交 API 的所有必要條件 。

   注意

   請確定應用程式已經至少完成一個提交，且已完成年齡分級資訊。

2. 取得 Azure AD 存取權杖。 您必須將此存取權杖傳遞至 Microsoft Store 提交 API 中的方法。 取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後，您可以取得新的權杖。

3. 通過在 Microsoft Store 提交 API 中執行以下方法建立應用程式提交。 此方法會建立新的進行中提交，這是您上次發佈的提交複本。

   POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions
   

   回應本文包含應用程式提交資源，其中包含新提交的識別碼、共用存取簽章 (SAS) URI，其用於上傳提交的任何相關檔案至 Azure Blob 儲存體 (例如應用程式套件、清單影像和預告片檔案)，以及新提交的所有資料 (例如清單和定價資訊)。

   注意

   SAS URI 可讓您存取 Azure 儲存體中的安全資源，而不需要帳戶金鑰。 如需 SAS URI 及其搭配 Azure Blob 儲存體使用的背景資訊，請參閱共用存取簽章，第 1 部分：瞭解 SAS 模型和共用存取簽章，第 2 部分：建立和使用具有 Blob 記憶體的 SAS。

4. 如果您要為提交新增套件、清單影像或預告片檔案，請準備應用程式套件，並準備應用程式螢幕擷取畫面、影像和預告片。 將這些檔案全部新增至 ZIP 封存。

5. 使用新提交的任何必要變更來更新應用程式提交資料，然後執行下列方法來更新應用程式提交。

   PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}
   

   注意

   如果您要為提交新增檔案，請務必更新提交資料，以參考 ZIP 封存中這些檔案的名稱和相對路徑。

6. 如果您要新增提交的套件、清單影像或預告片檔案，請使用您稍早呼叫的 POST 方法回應本文中提供的 SAS URI，將 ZIP 封存上傳至 Azure Blob 儲存體。 您可以使用不同的 Azure 程式庫在各種平台上執行這項操作，包括：

   • 適用於 .NET 的 Azure 儲存體用戶端程式庫
   • 適用於 Java 的 Azure 儲存體 SDK
   • 適用於 Python 的 Azure 儲存體 SDK

   下列 C# 程式碼範例示範如何使用適用於 .NET 的 Azure 儲存體用戶端程式庫中的 CloudBlockBlob 類別，將 ZIP 封存上傳至 Azure Blob 儲存體。 此範例假設 ZIP 封存已經寫入串流物件。

   string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl";
   Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob =
       new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl));
   await blockBob.UploadFromStreamAsync(stream);
   

7. 執行下列方法認可應用程式提交。 這會提醒合作夥伴中心您已完成提交，而且您的更新現在應該套用至您的帳戶。

   POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit
   

8. 執行下列方法來取得應用程式提交的狀態，以檢查認可狀態。

   GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status
   

   若要確認提交狀態，請檢閱回應本文中的狀態 值。 如果要求成功，此值應該從 CommitStarted 變更為 PreProcessing，如果要求中有錯誤，則變更為 CommitFailed。 如果發生錯誤，statusDetails 欄位會包含有關錯誤的進一步詳細資料。

9. 認可成功完成之後，提交會傳送至 Store 進行擷取。 您可以使用先前的方法，或造訪合作夥伴中心，繼續監視提交進度。

管理漸進式套件推出的方法

您可以依照 Windows 10 和 Windows 11 上應用程式客戶的百分比逐漸推出應用程式提交的更新套件。 如此您就能監視特定套件的意見反應和分析資料，以確保更新沒有問題後再擴大推出。 您可以變更已發佈提交的推出百分比 (或停止更新)，而不需要建立新的提交。 如需詳細資訊，包括如何在合作夥伴中心啟用和管理漸進式套件推出的相關指示，請參閱這篇文章。

若要以程式設計方式啟用應用程式提交的漸進式套件推出，請使用 Microsoft Store 提交 API 中的方法遵循此流程：

1. 建立應用程式提交或取得現有的應用程式提交。
2. 在回應資料中，找到 packageRollout 資源，將 [isPackageRollout] 欄位設定為 true，然後將 [packageRolloutPercentage] 欄位設定為應該取得更新套件的應用程式客戶百分比。
3. 將更新的應用程式提交資料傳遞至更新應用程式提交方法。

在應用程式提交啟用漸進式套件推出之後，您可以使用下列方法，以程式設計方式取得、更新、停止或完成漸進式推出。

方法	URI	描述
GET	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout	取得應用程式提交的漸進式推出資訊
POST	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage	更新應用程式提交的漸進式推出百分比
POST	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout	停止應用程式提交的漸進式推出
POST	https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout	完成應用程式提交的漸進式推出

管理應用程式提交的程式碼範例

下列文章提供詳細的程式碼範例，示範如何以數種不同的程式設計語言建立應用程式提交：

• C# 範例：提交應用程式、附加元件與正式發行前小眾測試版
• C# 範例：提交含遊戲選項與預告片的應用程式
• Java 範例：提交應用程式、附加元件與正式發行前小眾測試版
• Java 範例：提交含遊戲選項與預告片的應用程式
• Python 範例：提交應用程式、附加元件與正式發行前小眾測試版
• Python 範例：提交含遊戲選項與預告片的應用程式

StoreBroker PowerShell 模組

作為直接呼叫 Microsoft Store 提交 API 的替代方案，我們也提供開放原始碼 PowerShell 模組，以在 API 之上實作命令列介面。 此模組稱為 StoreBroker。 您可以使用此模組，從命令列管理應用程式、發行小眾測試版和附加元件提交，而不是直接呼叫 Microsoft Store 提交 API，您也可以直接瀏覽來源來查看更多如何呼叫此 API 的範例。 Microsoft 內會主動使用 StoreBroker 模組，作為許多第一方應用程式提交至市集的主要方式。

如需詳細資訊，請參閱 GitHub 上的 StoreBroker 頁面。

資料資源

管理應用程式提交的 Microsoft Store 提交 API 方法會使用下列 JSON 資料資源。

應用程式提交資源

此資源描述應用程式提交。

{
  "id": "1152921504621243540",
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2",
    "isAdvancedPricingModel": true
  },
  "visibility": "Public",
  "targetPublishMode": "Manual",
  "targetPublishDate": "1601-01-01T00:00:00Z",
  "listings": {
    "en-us": {
      "baseListing": {
        "copyrightAndTrademarkInfo": "",
        "keywords": [
          "epub"
        ],
        "licenseTerms": "",
        "privacyPolicy": "",
        "supportContact": "",
        "websiteUrl": "",
        "description": "Description",
        "features": [
          "Free ebook reader"
        ],
        "releaseNotes": "",
        "images": [
          {
            "fileName": "contoso.png",
            "fileStatus": "Uploaded",
            "id": "1152921504672272757",
            "description": "Main page",
            "imageType": "Screenshot"
          }
        ],
        "recommendedHardware": [],
        "title": "Contoso ebook reader"
      },
      "platformOverrides": {
        "Windows81": {
          "description": "Ebook reader for Windows 8.1"
        }
      }
    }
  },
  "hardwarePreferences": [
    "Touch"
  ],
  "automaticBackupEnabled": false,
  "canInstallOnRemovableMedia": true,
  "isGameDvrEnabled": false,
  "gamingOptions": [],
  "hasExternalInAppProducts": false,
  "meetAccessibilityGuidelines": true,
  "notesForCertification": "",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "enterpriseLicensing": "Online",
  "allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
  "allowTargetFutureDeviceFamilies": {
    "Desktop": false,
    "Mobile": true,
    "Holographic": true,
    "Xbox": false,
    "Team": true
  },
  "friendlyName": "Submission 2",
  "trailers": []
}

此資源有下列值。

值	類型	描述
id	字串	提交的識別碼。 此識別碼可在回應資料中取得，用於要求建立應用成提交、取得所有應用程式，以及取得應用程式。 針對在合作夥伴中心建立的提交，此識別碼也可以在合作夥伴中心提交頁面的 URL 中取得。
applicationCategory	字串	為您的應用程式指定類別和/或子類別的字串 。 類別和子類別會用底線「_」字元結合成單一字串，例如：BooksAndReference_EReader。
價格	object	包含應用程式定價資訊的定價資源。
可視性	字串	應用程式的可見度。 這可以是下列其中一值： Hidden 公開 私人 NotSet
targetPublishMode	字串	提交的發佈模式。 這可以是下列其中一值： 立即 手動 SpecificDate
targetPublishDate	字串	如果 targetPublishMode 設定為 SpecificDate，則會以 ISO 8601 格式顯示提交的發行日期。
listings	object	索引鍵和值組的字典，其中每個索引鍵都是國家代碼，每個值都是清單資源，包含應用程式的清單資訊。
hardwarePreferences	陣列	為應用程式定義硬體偏好設定的字串陣列。 這可以是下列其中一值： 觸控 鍵盤 滑鼠 相機 NfcHce Nfc BluetoothLE 電話通信
automaticBackupEnabled	boolean	指出 Windows 是否可以在自動備份至 OneDrive 時納入您應用程式的資料。 如需詳細資訊，請參閱應用程式宣告。
canInstallOnRemovableMedia	boolean	指出客戶是否可以把您的應用程式安裝到卸除式儲存裝置。 如需詳細資訊，請參閱應用程式宣告。
isGameDvrEnabled	boolean	指示是否為應用程式啟用了遊戲 DVR。
gamingOptions	陣列	包含一個遊戲選項資源的陣列，可為應用程式定義遊戲相關設定。
hasExternalInAppProducts	boolean	指出您的應用程式是否允許使用者在 Microsoft Store 商務系統外購買。 如需詳細資訊，請參閱應用程式宣告。
meetAccessibilityGuidelines	boolean	指出您的應用程式是否已經過測試，符合協助工具指南。 如需詳細資訊，請參閱應用程式宣告。
notesForCertification	字串	包含您應用程式的認證注意事項。
status	字串	提交的狀態。 這可以是下列其中一值： 無 已取消 PendingCommit CommitStarted CommitFailed PendingPublication 發佈 已發行 PublishFailed PreProcessing PreProcessingFailed 認證 CertificationFailed 版本 ReleaseFailed
statusDetails	object	狀態詳細資料資源，其中包含提交狀態的其他詳細資料，包括任何錯誤的相關資訊。
fileUploadUrl	字串	用於上傳提交任何套件的共用存取簽章 (SAS) URI。 如果您要為提交新增套件、清單影像或預告片檔案，請將包含套件和影像的 ZIP 封存上傳到此 URI。 如需詳細資訊，請參閱建立應用程式提交。
applicationPackages	陣列	應用程式套件資源的陣列，提供提交中每個套件的詳細資訊。
packageDeliveryOptions	object	套件傳遞選項資源，其中包含提交的漸進式套件推出和強制更新設定。
enterpriseLicensing	字串	其中一個企業授權值指出應用程式的企業授權行為。
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies	boolean	指出是否允許 Microsoft 把應用程式提供給未來的 Windows 10 和 Windows 11 裝置系列使用。
allowTargetFutureDeviceFamilies	object	索引鍵和值組的字典，其中每個索引鍵都是 Windows 10 和 Windows 11 裝置系列，而每個值都是布林值用以指出您的應用程式是否允許以指定的裝置系列為目標。
friendlyName	字串	提交的易記名稱，如合作夥伴中心所示。 當您建立提交時，會產生此值。
預告片	陣列	一個包含多達 15 個預告片資源的陣列，代表應用程式清單的影片。

定價資源

此資源包含應用程式的定價資訊。 此資源有下列值。

值	類型	描述
trialPeriod	字串	指定應用程式的試用期的字串。 這可以是下列其中一值： NoFreeTrial OneDay TrialNeverExpires SevenDays FifteenDays ThirtyDays
marketSpecificPricings	object	索引鍵和值組的字典，其中每個索引鍵都是雙字母 ISO 3166-1 alpha-2 國家/地區代碼，而每個值都是定價層。 這些項目代表特定市場中應用程式的自訂價格。 此字典中的任何項目都會覆寫指定市場中 priceId 值所指定的基本價格。
sales	陣列	已取代。 銷售資源陣列，其中包含應用程式的銷售資訊。
priceId	字串	定價層指定應用程式的基本價格。
isAdvancedPricingModel	boolean	如果為 true，您的開發人員帳戶就能夠存取從 0.99 美元到 1999.99 美元擴充的定價層。 如果為 false，您的開發人員帳戶就能夠存取從 0.99 美元到 999.99 美元原本的定價層。 如需不同層級的詳細資訊，請參閱定價層。 注意：此欄位是唯讀欄位。

銷售資源

此資源包含應用程式的銷售資訊。

重要

不再支援銷售資源，目前您無法使用 Microsoft Store 提交 API 取得或修改應用程式提交的銷售資料。 未來，我們將更新 Microsoft Store 提交 API，推出以程式設計方式存取應用程式提交的銷售資訊新方法。

• 呼叫 GET 方法以取得應用程式提交之後，銷售值會是空的。 您可以繼續使用合作夥伴中心來取得應用程式提交的銷售資料。
• 呼叫 PUT 方法來更新應用程式提交時，會忽略銷售值中的資訊。 您可以繼續使用合作夥伴中心來變更應用程式提交的銷售資料。

此資源有下列值。

值	類型	Description
NAME	字串	銷售的名稱。
basePriceId	字串	要用於銷售基本價格的定價層 。
startDate	字串	以 ISO 8601 格式顯示銷售開始日期。
endDate	字串	以 ISO 8601 格式顯示銷售結束日期。
marketSpecificPricings	object	索引鍵和值組的字典，其中每個索引鍵都是雙字母 ISO 3166-1 alpha-2 國家/地區代碼，而每個值都是定價層。 這些項目代表特定市場中應用程式的自訂價格。 此字典中的任何項目都會覆寫指定市場中 basePriceId 值所指定的基本價格。

清單資源

此資源包含應用程式的清單資訊。 此資源有下列值。

值	類型	描述
baseListing	object	應用程式的基底清單資訊，定義所有平台的預設清單資訊。
platformOverrides	object	索引鍵和值組的字典，其中每個索引鍵都是識別要覆寫清單資訊的平台字串，而每個值都是基底清單資源 (僅包含描述到標題的值)，可指定要覆寫指定平台的清單資訊。 這個索引鍵可以包含下列值： Unknown Windows80 Windows81 WindowsPhone71 WindowsPhone80 WindowsPhone81

基底清單資源

此資源包含應用程式的基底清單資訊。 此資源有下列值。

值	類型	描述
copyrightAndTrademarkInfo	字串	選擇性的著作權和/或商標資訊。
關鍵字	陣列	關鍵字陣列，可協助您的應用程式出現在搜尋結果中。
licenseTerms	字串	您應用程式的選擇性授權條款。
privacyPolicy	字串	這個值已經過時。 若要設定或變更您應用程式的隱私權原則 URL，您必須在合作夥伴中心的 [屬性] 頁面上執行此動作。 您可以從對提交 API 的呼叫中省略此值。 如果您設定此值，則會忽略此值。
supportContact	字串	這個值已經過時。 若要設定或變更您應用程式支援的連絡人 URL 或電子郵件位址，您必須在合作夥伴中心的 [屬性] 頁面上執行此動作。 您可以從對提交 API 的呼叫中省略此值。 如果您設定此值，則會忽略此值。
websiteUrl	字串	這個值已經過時。 若要設定或變更您應用程式的網頁 URL，您必須在合作夥伴中心的 [屬性] 頁面上執行此動作。 您可以從對提交 API 的呼叫中省略此值。 如果您設定此值，則會忽略此值。
description	字串	應用程式清單的描述。
features	陣列	最多 20 個字串的陣列，列出應用程式的功能。
releaseNotes	字串	應用程式的版本資訊。
images	陣列	應用程式清單的影像和圖示資源陣列。
recommendedHardware	陣列	最多 11 個字串的陣列，會列出您應用程式的建議硬體設定。
minimumHardware	字串	最多 11 個字串的陣列，會列出您應用程式的最低硬體設定。
title	字串	應用程式清單的標題。
shortDescription	字串	僅用於遊戲。 此描述會出現在 Xbox One 遊戲中心的資訊區段中，並協助客戶深入瞭解您的遊戲。
shortTitle	字串	您產品名稱的較短版本。 如果提供這個較短的名稱，其可能會出現在 Xbox One 的各種位置 (安裝期間、成就等之中)，以取代產品的完整標題。
sortTitle	字串	如果您的產品可以由不同方式依字母順序排列，您可以在這裡輸入另一個版本。 這可協助客戶在搜尋時更快找到產品。
voiceTitle	字串	當您使用 Kinect 或頭戴式裝置時，可能會將產品替代名稱 (如有提供) 用於 Xbox One 上的音訊體驗。
devStudio	字串	如果您想要在清單中包含 [開發者] 欄位，請指定此值。 ([發行者] 欄位會列出與您帳戶相關聯的發行者顯示名稱，不論您是否提供 devStudio 值。

影像資源

此資源包含應用程式清單的影像和圖示資料。 如需應用程式清單影像和圖示的詳細資訊，請參閱應用程式螢幕擷取畫面和影像。 此資源有下列值。

值	類型	描述
fileName	字串	您為提交上傳的 ZIP 封存中影像檔案的名稱。
fileStatus	字串	影像檔案的狀態。 這可以是下列其中一值： 無 PendingUpload 已上傳 PendingDelete
id	字串	影像的 ID。 此值是由合作夥伴中心提供。
description	字串	影像的描述。
imageType	字串	表示影像的類型。 目前支援下列字串。 螢幕擷取畫面： 螢幕擷取畫面 (針對桌面螢幕擷取畫面使用此值) MobileScreenshot XboxScreenshot SurfaceHubScreenshot HoloLensScreenshot Store 標誌： StoreLogo9x16 StoreLogoSquare 圖示 (針對 1:1 300 x 300 像素標誌使用此值) 宣傳影像： PromotionalArt16x9 PromotionalArtwork2400X1200 Xbox 影像： XboxBrandedKeyArt XboxTitledHeroArt XboxFeaturedPromotionalArt 選用性促銷影像： SquareIcon358X358 BackgroundImage1000X800 PromotionalArtwork414X180

遊戲選項資源

此資源包含應用程式的遊戲相關設定。 此資源中的值會對應至合作夥伴中心提交的遊戲設定。

{
  "gamingOptions": [
    {
      "genres": [
        "Games_ActionAndAdventure",
        "Games_Casino"
      ],
      "isLocalMultiplayer": true,
      "isLocalCooperative": true,
      "isOnlineMultiplayer": false,
      "isOnlineCooperative": false,
      "localMultiplayerMinPlayers": 2,
      "localMultiplayerMaxPlayers": 12,
      "localCooperativeMinPlayers": 2,
      "localCooperativeMaxPlayers": 12,
      "isBroadcastingPrivilegeGranted": true,
      "isCrossPlayEnabled": false,
      "kinectDataForExternal": "Enabled"
    }
  ],
}

此資源有下列值。

值	類型	描述
內容類型	陣列	描述遊戲內容類型的下列一或多個字串陣列： Games_ActionAndAdventure Games_CardAndBoard Games_Casino Games_Educational Games_FamilyAndKids Games_Fighting Games_Music Games_Platformer Games_PuzzleAndTrivia Games_RacingAndFlying Games_RolePlaying Games_Shooter Games_Simulation Games_Sports Games_Strategy Games_Word
isLocalMultiplayer	boolean	指出遊戲是否支援本機多人遊戲模式。
isLocalCooperative	boolean	指出遊戲是否支援本機合作遊戲模式。
isOnlineMultiplayer	boolean	指出遊戲是否支援線上多人遊戲模式。
isOnlineCooperative	boolean	指出遊戲是否支援線上合作遊戲模式。
localMultiplayerMinPlayers	int	指定遊戲支援本機多人遊戲的最低玩家人數。
localMultiplayerMaxPlayers	int	指定遊戲支援本機多人遊戲的最高玩家人數。
localCooperativeMinPlayers	int	指定遊戲支援本機合作遊戲的最低玩家人數。
localCooperativeMaxPlayers	int	指定遊戲支援本機合作遊戲的最高玩家人數。
isBroadcastingPrivilegeGranted	boolean	指出遊戲是否支援廣播。
isCrossPlayEnabled	boolean	指出遊戲是否支援 Windows 10 和 Windows 11 電腦與 Xbox 玩家之間的多人遊戲工作階段。
kinectDataForExternal	字串	下列其中一個字串值，指出遊戲是否可以收集 Kinect 資料，並將其傳送至外部服務： NotSet Unknown 啟用 停用

注意

在 Microsoft Store 提交 API 首次發行給開發人員之後，2017 年 5 月新增 gamingOptions 資源。 如果您在引進此資源之前透過提交 API 為應用程式建立提交，而且此提交仍在進行中，則應用程式提交的此資源會是 Null，直到您成功認可提交或將其刪除為止。 如果應用程式的提交無法使用 gamingOptions 資源，則使用取得應用程式方法傳回的應用程式資源 hasAdvancedListingPermission 欄位為 false。

狀態詳細資料資源

此資源包含提交狀態的其他詳細資料。 此資源有下列值。

值	類型	描述
錯誤	object	狀態詳細資料資源的陣列，其中包含提交的錯誤詳細資料。
warnings	object	狀態詳細資料資源的陣列，其中包含提交的警告詳細資料。
certificationReports	object	認證報告資源的陣列，可提供存取至提交的認證報告資料。 如果認證失敗，您可以檢查這些報告以取得詳細資訊。

狀態詳細資料資源

此資源包含有關提交的任何錯誤或警告的其他資訊。 此資源有下列值。

值	類型	描述
code	字串	描述錯誤或警告類型的提交狀態代碼。
詳細資料	字串	包含有關問題的詳細資料訊息。

應用程式套件資源

此資源包含提交之應用程式套件的詳細資訊。

{
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "Uploaded",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
}

此資源有下列值。

注意

呼叫更新應用程式提交方法時，只需要回應本文中此物件的 fileName、fileStatus、minimumDirectXVersion 和 minimumSystemRam 值。 合作夥伴中心會填入其他值。

值	類型	描述
fileName	字串	封裝的名稱。
fileStatus	字串	套件的狀態。 這可以是下列其中一值： 無 PendingUpload 已上傳 PendingDelete
id	字串	可唯一識別套件的識別碼。 此值是由合作夥伴中心提供。
version	字串	應用程式套件的版本。 如需詳細資訊，請參閱套件版本編號方法。
架構	字串	套件的架構 (例如 ARM)。
語言	陣列	應用程式支援語言的語言代碼陣列。 如需詳細資訊，請參閱支援的語言。
能力	陣列	套件所需的功能陣列。 如需功能的詳細資訊，請參閱應用程式功能宣告。
minimumDirectXVersion	字串	應用程式套件所支援的最低 DirectX 版本。 這僅適用針對以 Windows 8.x 為目標的應用程式設定。 針對以其他 OS 版本為目標的應用程式，呼叫更新應用程式提交方法時，必須有此值，但會忽略您指定的值。 這可以是下列其中一值： 無 DirectX93 DirectX100
minimumSystemRam	字串	應用程式套件所需的最低 RAM。 這僅適用針對以 Windows 8.x 為目標的應用程式設定。 針對以其他 OS 版本為目標的應用程式，呼叫更新應用程式提交方法時，必須有此值，但會忽略您指定的值。 這可以是下列其中一值： 無 Memory2GB
targetDeviceFamilies	陣列	代表套件目標裝置系列的字串陣列。 此值僅適用於以 Windows 10 為目標的套件，針對以舊版為目標的套件，這個值具有 None 值。 Windows 10 和 Windows 11 套件目前支援下列裝置系列字串，其中 {0} 是 Windows 10 或 Windows 11 版本字串，例如 10.0.10240.0、10.0.10586.0 或 10.0.14393.0： Windows.Universal min 版本 {0} Windows.Desktop min 版本 {0} Windows.Mobile min 版本 {0} Windows.Xbox min 版本 {0} Windows.Holographic min 版本 {0}

id="certification-report-resource"

認證報告資源

此資源可讓您存取提交的認證報告資料。 此資源有下列值。

值	類型	描述
date	字串	以 ISO 8601 格式產生報表的日期和時間。
reportUrl	字串	您可以存取報表的 URL。

套件傳遞選項資源

此資源包含提交的漸進式套件推出和強制更新設定。

{
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
}

此資源有下列值。

值	類型	描述
packageRollout	object	套件推出資源，其中包含提交的漸進式套件推出設定。
isMandatoryUpdate	boolean	指出您是否要將此提交中的套件視為自我安裝應用程式更新的必要項目。 如需自我安裝應用程式更新的必要套件詳細資訊，請參閱下載並安裝應用程式的套件更新。
mandatoryUpdateEffectiveDate	date	此提交中的套件日期和時間變成必要，要以 ISO 8601 格式和 UTC 時區顯示。

套件推出資源

此資源包含提交的漸進式套件推出設定 。 此資源有下列值。

值	類型	描述
isPackageRollout	boolean	指出是否針對提交啟用漸進式套件推出。
packageRolloutPercentage	float	在漸進式推出中接收到套件的使用者百分比。
packageRolloutStatus	字串	下列其中一個字串，指出漸進式套件推出的狀態： PackageRolloutNotStarted PackageRolloutInProgress PackageRolloutComplete PackageRolloutStopped
fallbackSubmissionId	字串	不會取得漸進式推出套件的客戶所收到的提交識別碼。

注意

packageRolloutStatus 和 fallbackSubmissionId 值是由合作夥伴中心指派，並非預計由開發人員設定。 如果您在要求本文中包含這些值，則會忽略這些值。

預告片資源

此資源代表應用程式清單的影片預告片。 此資源中的值會對應至合作夥伴中心提交的預告片選項。

您可以在應用程式提交資源中將最多 15 個預告片資源增加至預告片陣列。 若要上傳提交的預告片影片檔案和縮圖影像，請將這些檔案新增至包含提交的套件和清單影像的相同 ZIP 封存，然後將此 ZIP 封存上傳至提交的共用存取簽章 (SAS) URI。 如需將 ZIP 封存上傳至 SAS URI 的詳細資訊，請參閱建立應用程式提交。

{
  "trailers": [
    {
      "id": "1158943556954955699",
      "videoFileName": "Trailers\\ContosoGameTrailer.mp4",
      "videoFileId": "1159761554639123258",
      "trailerAssets": {
        "en-us": {
          "title": "Contoso Game",
          "imageList": [
            {
              "fileName": "Images\\ContosoGame-Thumbnail.png",
              "id": "1155546904097346923",
              "description": "This is a still image from the video."
            }
          ]
        }
      }
    }
  ]
}

此資源有下列值。

值	類型	描述
id	字串	預告片的識別碼。 此值是由合作夥伴中心提供。
videoFileName	字串	ZIP 封存中預告片影片檔案的名稱，其中包含提交的檔案。
videoFileId	字串	預告片影片檔案的識別碼。 此值是由合作夥伴中心提供。
trailerAssets	object	索引鍵和值組的字典，其中每個索引鍵都是語言代碼，而每個值都是預告片資產資源，其中包含預告片的其他地區設定特定資產。 有關支援的語言代碼詳細資訊，請參閱支援的語言。

注意

在 Microsoft Store 提交 API 首次發行給開發人員之後，2017 年 5 月新增 trailers資源。 如果您在引進此資源之前透過提交 API 為應用程式建立提交，而且此提交仍在進行中，則應用程式提交的此資源會是 Null，直到您成功認可提交或將其刪除為止。 如果應用程式的提交無法使用預告片資源，則使用取得應用程式方法傳回的應用程式資源 hasAdvancedListingPermission 欄位為 false。

預告片資產資源

此資源包含預告片資源中所定義的預告片其他地區設定特定資產。 此資源有下列值。

值	類型	描述
標題	字串	預告片的當地語系化標題。 當使用者以全螢幕模式播放預告片時，就會顯示標題。
imageList	陣列	其中包含一個影像資源的陣列，提供預告片的縮圖影像。 您只能在此陣列中包含一個影像資源。

影像資源 (適用於預告片)

此資源描述預告片的縮圖影像。 此資源有下列值。

值	類型	描述
fileName	字串	您為提交上傳 ZIP 封存中縮圖影像檔案的名稱。
id	字串	縮圖影像的識別碼。 此值是由合作夥伴中心提供。
description	字串	縮圖影像的描述。 這個值只是中繼資料，而且不會向使用者顯示。

列舉

這些方法會使用下列列舉。

定價層

下列值代表應用程式提交的定價資源中可用的定價層。

值	Description
基本	定價層未設定，使用應用程式的基本價格。
NotAvailable	應用程式無法在指定的區域中使用。
免費	這個應用程式是免費的。
Tierxxx	指定應用程式的定價層字串，格式為 Tierxxxx。 目前支援下列定價層的範圍： 如果定價資源的值 isAdvancedPricingModel 為 true，則您帳戶的可用定價層值為 Tier1012 - Tier1424。 如果定價資源的值 isAdvancedPricingModel 為 false，則您帳戶的可用定價層值為 Tier2 - Tier96。 若要查看開發人員帳戶可用的定價層完整資料表，包括與每一層相關聯的市場特定價格，請前往 [定價和可用性] 查看合作夥伴中心中任何應用程式提交，然後在市場和自訂價格區段上按一下 [檢視資料表] 連結 (對於部分開發人員帳戶，此連結位於定價區段)。

企業授權值

下列值代表應用程式的組織授權行為。 如需這些選項的詳細資訊，請參閱組織授權選項。

注意

雖然您可以透過提交 API 設定應用程式提交的組織授權選項，但您無法使用此 API 針對透過商務用 Microsoft Store 和教育用 Microsoft Store 的大量購買發佈提交。 若要將提交發佈至商務用 Microsoft Store 和教育用 Microsoft Store，您必須使用合作夥伴中心。

值	描述
None	請勿將您的應用程式提供給具有 Store 管理 (線上) 大量授權的企業使用。
線上存取	請將您的應用程式提供給具有 Store 管理 (線上) 大量授權的企業使用。
OnlineAndOffline	將應用程式提供給具有 Store 管理 (線上) 大量授權的企業，並透過中斷連線的 (離線) 授權，讓您的應用程式可供企業使用。

提交狀態代碼

下列值代表提交的狀態代碼。

值	描述
None	未指定任何程式碼。
InvalidArchive	包含套件的 ZIP 封存無效，或具有無法辨識的封存格式。
MissingFiles	ZIP 封存沒有提交資料中列出的所有檔案，或檔案位於封存中的錯誤位置。
PackageValidationFailed	提交中的一或多個套件無法驗證。
InvalidParameterValue	要求主文中的其中一個參數無效。
InvalidOperation	您嘗試的作業無效。
InvalidState	您嘗試的作業對套件發行前小眾測試版的目前狀態無效。
ResourceNotFound	找不到指定的套件發行小眾測試版。
ServiceError	內部服務錯誤導致要求無法成功。 請再次嘗試要求。
ListingOptOutWarning	開發人員已從先前提交中移除清單，或不包含套件所支援的清單資訊。
ListingOptInWarning	開發人員已新增清單。
UpdateOnlyWarning	開發人員正嘗試插入只有更新支援的項目。
其他	提交處於無法辨識或未分類的狀態。
PackageValidationWarning	套件驗證程式會產生警告。

相關主題

• 使用 Microsoft Store 服務建立及管理提交
• 使用 Microsoft Store 提交 API 取得應用程式資料
• 合作夥伴中心的應用程式提交