取得應用程式評等
在 Microsoft Store 分析 API 中使用此方法，取得特定日期範圍和其他選擇性篩選條件的 JSON 格式彙總評等資料。 此資訊也可在合作夥伴中心的評論報告中取得。
必要條件
要使用此方法，您需要先執行以下操作：
- 如果您尚未執行此操作，請完成 Microsoft Store 分析 API 的所有必要條件。
- 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後，您可以取得新的權杖。
要求
要求語法
| 方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings |
要求標頭
| 標題 | 類型 | 描述 |
|---|---|---|
| 授權 | 字串 | 必要。 持有人<權杖>形式的 Azure AD 存取權杖。 |
要求參數
| 參數 | 類型 | 描述 | 必要 |
|---|---|---|---|
| applicationId | 字串 | 您想要擷取評等資料之應用程式的 Store ID。 | 是 |
| startDate | date | 要擷取評等資料之日期範圍的開始日期。 預設值是目前的日期。 | 否 |
| endDate | date | 要擷取評等資料之日期範圍的結束日期。 預設值是目前的日期。 | 否 |
| 熱門 | int | 要求中要傳回的資料列數。 如果未指定，則最大值和預設值為 10000。 如果查詢中有更多資料列，回應本文會包含下一個連結，您可以用來要求下一頁的資料。 | 否 |
| skip | int | 要在查詢中忽略的列數。 使用此參數逐頁瀏覽大型資料集。 例如，top=10000 和 skip=0 會擷取前 10000 列資料，top=10000 和 skip=10000 會擷取接下來的 10000 列資料，依此類推。 | 否 |
| 篩選器 | 字串 | 篩選回應中的資料列的一或多個陳述式。 如需詳細資訊，請參閱下面的篩選功能變數一節。 | 否 |
| aggregationLevel | 字串 | 指定要擷取彙總資料的時間範圍。 可以是下列其中一個字串：day、week 或 month。 如果未指定，則預設值為 day。 | 否 |
| orderby | 字串 | 對每個評等的結果資料值進行排序的陳述式。 語法為 orderby=field [order],field [order],...。field 參數可以是下列其中一個字串：
order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。 預設為asc。 以下是範例 orderby 字串：orderby=date,market |
否 |
| groupby | 字串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以指定下列功能變數：
傳回的資料列將包含 groupby 參數中指定的欄位，以及下列項目：
groupby 參數可以搭配 aggregationLevel 參數使用。 例如：&groupby=osVersion,market&aggregationLevel=week |
否 |
篩選功能變數
要求的 filter 參數包含一或多個陳述式，可篩選回應中的資料列。 每個陳述式都包含與 eq 或 ne 運算子相關聯的功能變數和值，而且可以使用 and 或 or 來結合陳述式。
以下是範例 filter 字串：filter=market eq 'US' and deviceType eq 'phone' and isRevised eq true
如需支援的功能變數清單，請參閱下表。 字串值必須以 filter 參數中的單引號括住。
| 功能變數 | 描述 |
|---|---|
| market | 字串，其中包含對您的應用程式進行評等之市場的 ISO 3166 國家/地區代碼。 |
| osVersion | 下列其中一個字串：
|
| deviceType | 下列其中一個字串：
|
| isRevised | 指定 true 以篩選已修訂的評等，否則為 false。 |
要求範例
下列範例示範數個取得評等資料的要求。 以您應用程式的 Store ID 取代 applicationId 值。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?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/ratings?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應本文
| 值 | 類型 | 描述 |
|---|---|---|
| 值 | 陣列 | 包含彙總評等資料的物件陣列。 如需關於每個物件中的資料的詳細資訊，請參閱下方的評等值一節。 |
| @nextLink | 字串 | 如果有額外的資料頁面，此字串會包含可用來要求下一頁資料的 URI。 例如，如果要求的 top 參數設定為 10000，但評等資料超過 10000 個資料列，則會傳回此值。 |
| TotalCount | int | 查詢的資料結果中的總列數。 |
評等值
Value 陣列中的元素包含下列值。
| 值 | 類型 | 描述 |
|---|---|---|
| date | 字串 | 評等資料之日期範圍中的第一個日期。 如果要求指定了單天，這個值就是該日期。 如果要求指定了一週、月或其他日期範圍，這個值就是該日期範圍中的第一個日期。 |
| applicationId | 字串 | 您正在擷取評等資料之應用程式的 Store ID。 |
| applicationName | 字串 | 應用程式的顯示名稱。 |
| market | 字串 | 提交評等之市場的 ISO 3166 國家/地區代碼。 |
| osVersion | 字串 | 提交評等的 OS 版本。 如需支援的字串清單，請參閱上面的篩選功能變數一節。 |
| deviceType | 字串 | 提交評等的裝置類型。 如需支援的字串清單，請參閱上面的篩選功能變數一節。 |
| isRevised | 布林值 | 值 true 表示已修訂評等，否則為 false。 |
| oneStar | 值 | 一星評等的數目。 |
| twoStars | 值 | 二星評等的數目。 |
| threeStars | 值 | 三星評等的數目。 |
| fourStars | 值 | 四星評等的數目。 |
| fiveStars | 值 | 五星評等的數目。 |
要求和回應範例
下列程式碼片段示範一些要求的範例要求和 JSON 回應本文。
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"date": "2012-09-01",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"oneStar": 1,
"twoStars": 0,
"threeStars": 0,
"fourStars": 1,
"fiveStars": 3
},
{
"date": "2012-09-02",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"oneStar": 3,
"twoStars": 0,
"threeStars": 1,
"fourStars": 2,
"fiveStars": 17
},
{
"date": "2012-09-03",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"oneStar": 1,
"twoStars": 1,
"threeStars": 1,
"fourStars": 5,
"fiveStars": 17
},
],
"TotalCount": 3
}
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=date,applicationName,market,osVersion,deviceType,isRevised
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"date": "2022-06-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "CL",
"osVersion": "Windows 11",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-06-22",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "TR",
"osVersion": "Windows 11",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-06-29",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "FR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 1,
"fiveStars": 0
},
{
"date": "2022-07-01",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-04",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "ES",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-06",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "ES",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-07",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "AE",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "true",
"oneStar": 1,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 0
},
{
"date": "2022-07-10",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "true",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-13",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "EG",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "false",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 0,
"fiveStars": 1
},
{
"date": "2022-07-14",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"isRevised": "true",
"oneStar": 0,
"twoStars": 0,
"threeStars": 0,
"fourStars": 1,
"fiveStars": 0
}
],
"TotalCount": 10
}
相關主題
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應