取得應用程式下載數

  • 發行項

在 Microsoft Store 分析 API 中使用此方法，在特定日期範圍期間和其他選擇性篩選條件取得應用程式的 JSON 格式彙總獲取資料。 此資訊也可在合作夥伴中心的獲取報告中取得。

必要條件

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

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

要求

要求語法

方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions

要求標頭

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

要求參數

參數 類型 描述 必要
applicationId 字串 您想要擷取獲取資料之應用程式的 Store ID。 是
startDate date 要擷取獲取資料之日期範圍的開始日期。 預設值是目前的日期。 否
endDate date 要擷取獲取資料之日期範圍的結束日期。 預設值是目前的日期。 否
熱門 int 要求中要傳回的資料列數。 如果未指定，則最大值和預設值為 10000。 如果查詢中有更多資料列，回應本文會包含下一個連結，您可以用來要求下一頁的資料。 否
skip int 要在查詢中忽略的列數。 使用此參數逐頁瀏覽大型資料集。 例如，top=10000 和 skip=0 會擷取前 10000 列資料，top=10000 和 skip=10000 會擷取接下來的 10000 列資料，依此類推。 否
篩選器 字串 篩選回應中的資料列的一或多個陳述式。 每個陳述式都包含回應本文的功能變數名稱，以及與 eq 或 ne 運算子相關聯的值，而且可以使用 and 或 or 結合陳述式。 字串值必須以 filter 參數中的單引號括住。 例如，filter=market eq 'US' and gender eq 'm'。

您可以從回應本文指定下列功能變數：

  • acquisitionType
  • ageGroup
  • storeClient
  • 性別
  • market
  • osVersion
  • deviceType
  • orderName
 否
aggregationLevel 字串 指定要擷取彙總資料的時間範圍。 可以是下列其中一個字串：day、week 或 month。 如果未指定，則預設值為 day。 否
orderby 字串 對每個取得的結果資料值進行排序的陳述式。 語法為 orderby=field [order],field [order],...。field 參數可以是下列其中一個字串：
  • date
  • acquisitionType
  • ageGroup
  • storeClient
  • 性別
  • market
  • osVersion
  • deviceType
  • orderName

order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。 預設為asc。

以下是範例 orderby 字串：orderby=date,market

 否
groupby 字串 僅將資料彙總套用至指定欄位的陳述式。 您可以指定下列功能變數：
  • date
  • applicationName
  • acquisitionType
  • ageGroup
  • storeClient
  • 性別
  • market
  • osVersion
  • deviceType
  • orderName

傳回的資料列將包含 groupby 參數中指定的欄位，以及下列項目：

  • date
  • applicationId
  • acquisitionQuantity

groupby 參數可以搭配 aggregationLevel 參數使用。 例如：&groupby=ageGroup,market&aggregationLevel=week

 否

要求範例

下列範例示範數個取得應用程式獲取資料的要求。 以您應用程式的 Store ID 取代 applicationId 值。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

回應

回應本文

值 類型 描述
值 陣列 物件的陣列，其中包含應用程式的彙總獲取資料。 如需關於每個物件中的資料的詳細資訊，請參閱下方的獲取值一節。
@nextLink 字串 如果有額外的資料頁面，此字串會包含可用來要求下一頁資料的 URI。 例如，如果要求的 top 參數設定為 10000，但獲取資料超過 10000 個資料列，則會傳回此值。
TotalCount int 查詢的資料結果中的總列數。

獲取值

Value 陣列中的元素包含下列值。

值 類型 描述
date 字串 獲取資料之日期範圍中的第一個日期。 如果要求指定了單天，這個值就是該日期。 如果要求指定了一週、月或其他日期範圍，這個值就是該日期範圍中的第一個日期。
applicationId 字串 您正在擷取獲取資料之應用程式的 Store ID。
applicationName 字串 應用程式的顯示名稱。
deviceType 字串 下列其中一個字串，指定發生獲取的裝置類型：
  • PC
  • 手機
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Unknown
orderName 字串 順序的名稱。
storeClient 字串 下列其中一個字串，指出發生獲取的市集版本：
  • Windows Phone Store (client)
  • Microsoft Store (client) (或 Windows Store (client)，若是在 2018 年 3 月 23 日之前查詢資料)
  • Microsoft Store (web) (或 Windows Store (web)，若是在 2018 年 3 月 23 日之前查詢資料)
  • Volume purchase by organizations
  • 其他
osVersion 字串 下列其中一個字串，指定發生獲取的 OS 版本：
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
market 字串 發生獲取之市場的 ISO 3166 國家/地區代碼。
性別 字串 下列其中一個字串，指定進行獲取的使用者性別：
  • m
  • f
  • Unknown
ageGroup 字串 下列其中一個字串，指定進行獲取的使用者年齡群組：
  • 小於 13
  • 13 - 17
  • 18 - 24
  • 25 - 34
  • 35 - 44
  • 44 - 55
  • greater than 55
  • Unknown
acquisitionType 字串 下列其中一個字串，指出獲取的類型：
  • Free
  • Trial
  • Paid
  • Promotional code
  • Iap
  • Subscription Iap
  • 私人對象
  • Pre Order
  • Xbox Game Pass (或 Game Pass，若在 2018 年 3 月 23 日之前查詢)
  • 磁碟
  • Prepaid Code
acquisitionQuantity 值 指定彙總層級期間發生的獲取次數。

要求和回應範例

下列程式碼片段示範一些要求的範例要求和 JSON 回應本文。

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR  HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "date": "2022-07-29",
            "acquisitionQuantity": 7,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
  ],
  "TotalCount": 1,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
}

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType  HTTP/1.1
Authorization: Bearer <your access token>

範例回應

	{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "f",
            "market": "TW",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "Unknown",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
      ],  
  "TotalCount": 2,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
 }