在Microsoft市集分析 API 中使用此方法,以 JSON 格式取得應用程式在指定日期範圍和其他選擇性篩選期間匯總安裝數據。 此資訊也可在合作夥伴中心的 下載數報告中 取得。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未這麼做,請完成 Microsoft 市集分析API的所有 必要條件。
- 取得 Azure AD 存取令牌 ,以用於此方法的要求標頭中。 取得存取令牌之後,您必須在 60 分鐘内使用它,否則將會失效。 令牌到期之後,您可以取得新的令牌。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 持有人令牌<形式的> Azure AD 存取令牌。 |
要求參數
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您要擷取安裝資料之應用程式的 市集標識碼 。 | 是的 |
| 開始日期 | 日期 | 要擷取的安裝資料日期範圍中的開始日期。 預設值為目前的日期。 | 否 |
| 結束日期 | 日期 | 要擷取之安裝數據之日期範圍的結束日期。 預設值為目前的日期。 | 否 |
| 返回頁首 | 整數 (int) | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多資料列,回應內容會包含下一個連結,您可以使用該連結來請求下一頁的資料。 | 否 |
| 略過 | 整數 (int) | 查詢中要略過的行數目。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 否 |
| 篩選器 | 字符串 | 一或多個語句用於篩選回應中的數據列。 每個語句都包含回應本文中的欄位名稱,以及與 eq 或 ne 運算子相關聯的值,且語句可以使用 和 或 或 來結合。 字串值必須以 篩選 參數中的單引弧括住。 您可以從回應的主體中指定以下欄位:
|
否 |
| 聚合層級 | 字符串 | 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串: 日、 周或 月。 如果未指定,則預設值為 day。 | 否 |
| 排序 | 字符串 | 一項指令,用於排序每個安裝的結果數據值。 語法為 orderby=field [order],field [order],...。 field 參數可以是回應內容中的下列欄位之一:
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設值為 asc。 以下是 orderby 字串範例: orderby=date,market |
否 |
| 按群組分類 | 字符串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以從回應的主體中指定以下欄位:
傳回的數據列將包含 groupby 參數中指定的欄位,以及下列欄位:
groupby 參數可以搭配 aggregationLevel 參數使用。 例如: &groupby=ageGroup,market&aggregationLevel=week |
否 |
範例請求
下列範例示範取得應用程式安裝數據的數個要求。 以您應用程式的市集標識碼取代 applicationId 值。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?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/installs?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應主體
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 價值觀 | 陣列 | 包含匯總安裝數據的物件陣列。 如需每個物件中數據的詳細資訊,請參閱下表。 |
| @nextLink | 字符串 | 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求的 top 參數設定為 10000,但查詢的安裝數據列超過 10000 個數據列,則會傳回此值。 |
| 總計數 | 整數 (int) | 查詢的資料結果中的總列數。 |
Value 陣列中的元素包含下列值。
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 日期 | 字符串 | 安裝數據之日期範圍中的第一個日期。 如果要求指定了單一天,這個值就是該日期。 如果要求指定了一周、月或其他日期範圍,這個值就是該日期範圍中的第一個日期。 |
| 應用程式ID | 字符串 | 您要擷取安裝資料之應用程式的商店 ID。 |
| 應用程式名稱 | 字符串 | 應用程式的顯示名稱。 |
| 裝置類型 | 字符串 | 下列其中一個字串,指定完成安裝的裝置類型:
|
| 封包版本 | 字符串 | 已安裝的套件版本。 |
| 作業系統版本 | 字符串 | 下列其中一個字串,指定安裝所在的操作系統版本:
|
| 市場 | 字符串 | 安裝發生所在市場的 ISO 3166 國家/地區代碼。 |
| 成功安裝計數 | 數字 | 在指定的匯總層級期間發生的成功安裝次數。 |
要求和回應範例
下列程式碼片段示範了一些請求的範例,以及這些請求的 JSON 回應內容。
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9WZDNCRFJB4P
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"successfulInstallCount": 100053
}
],
"TotalCount": 1
}
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/installs?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=06/19/2022&endDate=07/21/2022&top=10&skip=0&groupby=applicationName,date,deviceType,market,osVersion,packageVersion&orderby=date desc
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "AR",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "AU",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BD",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BG",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BO",
"osVersion": "Windows 10",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BR",
"osVersion": "Windows 10",
"successfulInstallCount": 6
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "BR",
"osVersion": "Windows 11",
"successfulInstallCount": 3
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "CA",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "CN",
"osVersion": "Windows 11",
"successfulInstallCount": 1
},
{
"date": "2022-07-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"packageVersion": "2013.1206.10.2936",
"deviceType": "PC",
"market": "MX",
"osVersion": "Windows 10",
"successfulInstallCount": 1
}
],
"TotalCount": 10
}