管理附加元件

在 Microsoft Store 提交 API 中使用下列方法來管理應用程式的附加元件。 如需 Microsoft Store 提交 API 的簡介,包括使用 API 的先決條件,請參閱使用 Microsoft Store 服務建立和管理提交

這些方法只能用來取得、建立或刪除附加元件。 若要為附加元件建立提交,請參閱管理附加元件提交中的方法。

方法 URI 描述
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts 取得應用程式的所有附加元件
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} 取得特定附加元件
POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts 建立附加元件
DELETE https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId} 刪除附加元件

必要條件

如果您尚未這麼做,請先完成 Microsoft Store 提交 API 的所有必要條件後,再嘗試使用這些方法。

資料資源

管理附加元件的 Microsoft Store 提交 API 方法會使用下列 JSON 資料資源。

附加元件資源

此資源描述附加元件。

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
  "id": "9NBLGGH4TNMP",
  "productId": "TestAddOn",
  "productType": "Durable",
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
  "lastPublishedInAppProductSubmission": {
    "id": "1152921504621243705",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
  }
}

此資源有下列值。

類型 描述
應用程式 陣列 包含一個應用程式資源的陣列,代表此附加元件相關聯的應用程式。 此陣列中僅支援一個項目。
id string 附加元件的 Store ID。 這個值是由市集所提供。 Store 識別碼範例為 9NBLGGH4TNMP。
productId 字串 附加元件的產品識別碼。 這是建立附加元件時開發人員所提供的識別碼。 如需詳細資訊,請參閱設定您的產品類型和產品識別碼
productType string 附加元件的產品類型。 支援下列值:DurableConsumable
lastPublishedInAppProductSubmission object 提交資源提供附加元件上次發佈提交的相關資訊。
pendingInAppProductSubmission object 提交資源提供附加元件目前擱置的提交相關資訊。

應用程式資源

此資源會描述附加元件相關聯的應用程式。 以下範例示範了此資源的格式。

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
}

此資源有下列值。

類型 描述
value object 包含下列值的物件:
  • id。應用程式的 Store 識別碼。 如需 Store 識別碼的詳細資訊,請參閱檢視應用程式識別詳細資料
  • resourceLocation. 您可以附加至基底 https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI 的相對路徑,以擷取應用程式的完整資料。
totalCount int 回應本文的 applications 陣列中的應用程式物件數目。

提交資源

此資源提供附加元件提交的相關資訊。 以下範例示範了此資源的格式。

{
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
}

此資源有下列值。

類型 描述
id string 提交的識別碼。
resourceLocation string 您可以附加至基底 https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI 的相對路徑,以擷取提交的完整資料。