アプリの評価の取得

  • [アーティクル]

指定した期間やその他のオプション フィルターに該当する評価の集計データを JSON 形式で取得するには、Microsoft Store 分析 API でこのメソッドを使用します。 この情報は、パートナー センターのレビュー レポートでも確認できます。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

要求

要求の構文

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

要求ヘッダー

Header 型 説明
承認 string 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。

要求パラメーター

パラメーター Type 内容 必須
applicationId string 評価 データを取得するアプリの Store ID。 はい
startDate 日付 取得する評価データの期間の開始日。 既定値は現在の日付です。 いいえ
endDate 日付 取得する評価データの期間の終了日。 既定値は現在の日付です。 いいえ
top int 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 いいえ
skip int クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。 No
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 詳しくは、次の「フィルター フィールド」セクションをご覧ください。 No
aggregationLevel string 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 No
orderby string 各評価の結果データ値の順序を指定するステートメント。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
  • date
  • osVersion
  • market
  • deviceType
  • isRevised

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

orderby 文字列の例: orderby=date,market

 No
groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
  • date
  • applicationName
  • market
  • osVersion
  • deviceType
  • isRevised

返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。

  • date
  • applicationId
  • fiveStars
  • fourStars
  • threeStars
  • twoStars
  • oneStar

groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。 例: &groupby=osVersion,market&aggregationLevel=week

 いいえ

 

フィルター フィールド

要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには eq 演算子または ne 演算子と関連付けられるフィールドと値が含まれ、and または or を使ってステートメントを組み合わせることができます。

filter 文字列の例は次のとおりです: filter=market eq 'US' and deviceType eq 'phone' and isRevised eq true

サポートされているフィールドの一覧については、次の表をご覧ください。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。

Fields 説明
market アプリが評価された市場の ISO 3166 国コードを含む文字列。
osVersion 次の文字列のいずれかです。
  • 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 次の文字列のいずれかです。
  • PC
  • 電話
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Unknown
isRevised 変更された評価をフィルター処理する場合は true、それ以外の場合は false を指定します。

要求の例

評価データを取得するための要求の例を、いくつか次に示します。 applicationId 値を、目的のアプリのストア ID に置き換えてください。

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 string データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10000 に設定されていた場合、クエリの評価 データが 10000 行を超えると、この値が返されます。
TotalCount int クエリの結果データ内の行の総数です。

評価値

Value 配列の要素には、次の値が含まれます。

値 種類 説明
date string 評価データの期間の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
applicationId string 評価データを取得するアプリの Store ID。
applicationName string アプリの表示名です。
market string 評価が送信された市場の ISO 3166 国コード。
osVersion string 評価が送信された OS バージョン。 サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。
deviceType string 評価が送信されたデバイスの種類。 サポートされる文字列の一覧については、前の「フィルター フィールド」セクションをご覧ください。
isRevised Boolean 値 true は評価が変更されたことを示します。それ以外の場合は false です。
oneStar 数値 1 つ星評価の数。
twoStars 数値 2 つ星評価の数。
threeStars 数値 3 つ星評価の数。
fourStars 数値 4 つ星評価の数。
fiveStars 数値 5 つ星評価の数。

要求と応答の例

次のコード スニペットは、これらの要求についての要求と 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
}