取得應用程式評論

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

擷取評論之後，您可以在 Microsoft Store 評論 API 中使用取得應用程式評論的回應資訊和提交應用程式評論的回應方法，以程式設計方式來回應評論。

必要條件

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

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

要求

要求語法

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

要求標頭

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

要求參數

參數	類型	描述	必要
applicationId	字串	您想要擷取評論資料之應用程式的 Store ID。	是
startDate	date	要擷取評論資料之日期範圍的開始日期。 預設值是目前的日期。	否
endDate	date	要擷取評論資料之日期範圍的結束日期。 預設值是目前的日期。	否
熱門	int	要求中要傳回的資料列數。 如果未指定，則最大值和預設值為 10000。 如果查詢中有更多資料列，回應本文會包含下一個連結，您可以用來要求下一頁的資料。	否
skip	int	要在查詢中忽略的列數。 使用此參數逐頁瀏覽大型資料集。 例如，top=10000 和 skip=0 會擷取前 10000 列資料，top=10000 和 skip=10000 會擷取接下來的 10000 列資料，依此類推。	否
篩選器	字串	篩選回應中的資料列的一或多個陳述式。 如需詳細資訊，請參閱下面的篩選功能變數一節。	否
orderby	字串	排序結果資料值的陳述式。 語法為 orderby=field [order],field [order],...。field 參數可以是下列其中一個字串： date osVersion market deviceType isRevised packageVersion deviceModel productFamily deviceScreenResolution isTouchEnabled reviewerName reviewTitle reviewText helpfulCount notHelpfulCount responseDate responseText deviceRAM deviceStorageCapacity rating order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。 預設為asc。 以下是範例 orderby 字串：orderby=date,market	否

篩選功能變數

要求的 filter 參數包含一或多個陳述式，可篩選回應中的資料列。 每個陳述式都包含與 eq 或 ne 運算子相關聯的功能變數和值，而某些功能變數也支援 contains、gt、lt、ge 和 le 運算子。 可以使用 and 或 or 來結合陳述式。

以下是範例 filter字串：filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'

如需支援的功能變數清單以及每個功能變數的支援運算子，請參閱下表。 字串值必須以 filter 參數中的單引號括住。

功能變數	支援的運算子	描述
market	eq、ne	字串，包含裝置市場的 ISO 3166 國家/地區代碼。
osVersion	eq、ne	下列其中一個字串： Windows Phone 7.5 Windows Phone 8 Windows Phone 8.1 Windows Phone 10 Windows 8 Windows 8.1 Windows 10 Windows 11 Unknown
deviceType	eq、ne	下列其中一個字串： PC 手機 Console-Xbox One Console-Xbox Series X IoT Holographic Unknown
isRevised	eq、ne	指定 true 以篩選已修訂的評論，否則為 false。
packageVersion	eq、ne	接受評論的應用程式套件版本。
deviceModel	eq、ne	接受評論的應用程式所在的裝置類型。
productFamily	eq、ne	下列其中一個字串： PC 平板電腦 手機 Wearable Server Collaborative 其他
deviceRAM	eq、ne、gt、lt、ge、le	實體 RAM，以 MB 為單位。
deviceScreenResolution	eq、ne	格式為 "width x height" 的裝置螢幕解析度。
deviceStorageCapacity	eq、ne、gt、lt、ge、le	主要記憶體磁碟的容量，以 GB 為單位。
isTouchEnabled	eq、ne	指定 true 以篩選觸控式裝置，否則為 false。
reviewerName	eq、ne	評論者名稱。
rating	eq、ne、gt、lt、ge、le	應用程式評等，以星級顯示。
reviewTitle	eq、ne、contains	評論的標題。
reviewText	eq、ne、contains	評論的文字內容。
helpfulCount	eq、ne	評論標示為有幫助的次數。
notHelpfulCount	eq、ne	評論標示為沒有幫助的次數。
responseDate	eq、ne	提交回應的日期。
responseText	eq、ne、contains	回應的文字內容。
id	eq、ne	評論的識別碼 (這是 GUID)。

要求範例

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?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/reviews?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US' 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。
packageVersion	字串	接受評論的應用程式套件版本。
deviceModel	字串	接受評論的應用程式所在的裝置類型。
productFamily	字串	裝置系列名稱。 如需支援的字串清單，請參閱上面的篩選功能變數一節。
deviceRAM	值	實體 RAM，以 MB 為單位。
deviceScreenResolution	字串	格式為 "width x height" 的裝置螢幕解析度。
deviceStorageCapacity	值	主要記憶體磁碟的容量，以 GB 為單位。
isTouchEnabled	布林值	值 true 表示已啟用觸控，否則為 false。
reviewerName	字串	評論者名稱。
rating	值	應用程式評等，以星級顯示。
reviewTitle	字串	評論的標題。
reviewText	字串	評論的文字內容。
helpfulCount	值	評論標示為有幫助的次數。
notHelpfulCount	值	評論標示為沒有幫助的次數。
responseDate	字串	提交回應的日期。
responseText	字串	回應的文字內容。
id	字串	評論的識別碼 (這是 GUID)。 您可以在取得應用程式評論的回應資訊和提交應用程式評論的回應方法中使用此識別碼。

要求和回應範例

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

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?applicationId=9WZDNCRFJB4P&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "date": "3/5/2021 12:48:33 PM",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": false,
            "packageVersion": "2.5.2.34894",
            "reviewerName": "Jose Antonio",
            "rating": 5,
            "reviewTitle": "Contoso Demo",
            "reviewText": "Un juego fantastico",
            "helpfulCount": 3,
            "notHelpfulCount": 0,
            "id": "b5e27de9-2334-4849-d17d-4eae3e1e7aa9"
        },
        {
            "date": "1/6/2021 8:41:42 AM",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": false,
            "packageVersion": "2.5.2.34894",
            "reviewerName": "fef",
            "rating": 5,
            "helpfulCount": 0,
            "notHelpfulCount": 0,
            "id": "f5d2510a-9796-45ee-01e5-6d5cc4550b09"
        }
    ],
    "TotalCount": 2
}

相關主題

• 評論報告
• 使用 Microsoft Store 服務存取分析資料
• 取得應用程式評論的回應資訊
• 提交應用程式評論的回應
• 取得應用程式下載數
• 取得附加元件下載數
• 取得錯誤報告資料
• 取得應用程式評分