取得應用程式的附加元件

  • 發行項

在 Microsoft Store 提交 API 中使用此方法，列出向合作夥伴中心帳戶註冊之應用程式的附加元件。

必要條件

要使用此方法，您需要先執行以下操作：

  • 如果您尚未執行此操作，請完成 Microsoft Store 提交 API 的所有必要條件。
  • 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後，您可以取得新的權杖。

要求

此方法具有下列語法。 如需標頭和要求本文的使用範例和描述，請參閱下列各節。

方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

要求標頭

標題 類型 描述
授權 字串 必要。 持有人<權杖>形式的 Azure AD 存取權杖。

要求參數

名稱 類型​​ 描述 必要
applicationId 字串 您想要擷取附加元件之應用程式的 Store ID。 如需 Store ID 的詳細資訊，請參閱檢視應用程式識別詳細資料。 是
熱門 int 要求中要傳回的項目數 (也就是要傳回的附加元件數目)。 如果應用程式擁有的附加元件多於您在查詢中指定的值，回應本文會包含相對 URI 路徑，讓您附加至方法 URI 以要求下一頁資料。 否
skip int 傳回其餘項目之前，查詢中要略過的項目數。 使用此參數逐頁瀏覽資料集。 例如，top=10 和 skip=0 會擷取項目 1 到 10，top=10 和 skip=10 會擷取項目 11 到 20，依此類推。 否

要求本文

請勿提供此方法的要求本文。

要求範例

下列範例示範如何列出應用程式的所有附加元件。

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts HTTP/1.1
Authorization: Bearer <your access token>

下列範例示範如何列出應用程式前 10 個附加元件。

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>

回應

下列範例示範向包含 53 個附加元件的應用程式成功要求前 10 個附加元件所傳回的 JSON 回應本文。 為了簡潔起見，此範例只顯示要求所傳回的前三個附加元件的資料。 如需回應本文中的值的詳細資訊，請參閱下一節。

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

回應本文

值 類型 描述
@nextLink 字串 如果有額外的資料頁，此字串會包含相對路徑，讓您附加至基底 https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI，以要求下一頁的資料。 例如，如果初始要求本文的 top 參數設定為 10，但應用程式有 50 個附加元件，回應本文會包含 applications/{applicationid}/listinappproducts/?skip=10&top=10 的 @nextLink 值，這表示您可以呼叫 https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 來要求接下來的 10 個附加元件。
值 陣列 物件的陣列，列出指定應用程式之每個附加元件的 Store ID。 如需每個物件中的資料的詳細資訊，請參閱附加元件資源。
totalCount int 查詢資料結果中的資料列總數 (也就是指定應用程式的附加元件總數)。

錯誤碼

如果要求無法成功完成，回應將會包含下列其中一個 HTTP 錯誤碼。

錯誤碼 描述
404 找不到附加元件。
409 附加元件使用 Microsoft Store 提交 API 目前不支援的合作夥伴中心功能。