Abrufen von App-Bewertungen
Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um aggregierte Bewertungsdaten im JSON-Format für einen bestimmten Zeitraum und andere optionale Filter abzurufen. Diese Informationen sind auch im Bericht "Rezensionen" im Partner Center verfügbar.
Voraussetzungen
Um diese Methode zu verwenden, müssen Sie zuerst Folgendes tun:
- Falls noch nicht geschehen, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API.
- Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.
Anfordern
Anforderungssyntax
Methode | Anforderungs-URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings |
Anforderungsheader
Header | Typ | Beschreibung |
---|---|---|
Autorisierung | Zeichenfolge | Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>. |
Anforderungsparameter
Parameter | Typ | Beschreibung | Erforderlich |
---|---|---|---|
applicationId | Zeichenfolge | Die Store-ID der App, für die Sie Bewertungsdaten abrufen möchten. | Ja |
startDate | date | Das Startdatum im Datumsbereich der abzurufenden Bewertungsdaten. Die Standardeinstellung ist das aktuelle Datum. | No |
endDate | date | Das Enddatum im Datumsbereich der abzurufenden Bewertungsdaten. Die Standardeinstellung ist das aktuelle Datum. | Nein |
Oben | int | Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Höchstwert und der Standardwert, falls nicht angegeben, ist 10000. Wenn in der Abfrage weitere Zeilen vorhanden sind, enthält der Antworttext einen nächsten Link, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. | Nein |
skip | int | Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datasets zu durchlaufen. Beispielsweise ruft top=10000 und skip=0 die ersten 10000 Datenzeilen ab, top=100000 und skip=10000 ruft die nächsten 10000 Datenzeilen usw. ab. | Nein |
filter | Zeichenfolge | Eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Weitere Informationen finden Sie im Abschnitt zu Filterfelder weiter unten. | No |
aggregationLevel | Zeichenfolge | Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen. Dies kann eine der folgenden Zeichenfolgen sein: Tag, Woche oder Monat. Wenn keine Angabe erfolgt, lautet der Standardwert Tag. | No |
orderby | Zeichenfolge | Eine Anweisung, die die Ergebnisdatenwerte für jede Bewertung anordnet. Die Syntax ist orderby=Feld [order], Feld [order],.... Der Feld-Parameter kann eine der folgenden Zeichenfolgen sein:
Der Order-Parameter ist optional und kann asc oder desc sein, um die aufsteigende oder absteigende Reihenfolge für jedes Feld anzugeben. Die Standardeinstellung ist asc. Hier ist ein Beispiel für eine orderby-Zeichenfolge: orderby=date,market |
Nein |
groupby | Zeichenfolge | Eine Anweisung, die Datenaggregation nur auf die angegebenen Felder anwendet. Sie können folgende Felder angeben:
Die zurückgegebenen Datenzeilen enthalten die im groupby-Parameter angegebenen Felder sowie Folgendes:
Der groupby-Parameter kann mit dem aggregationLevel-Parameter verwendet werden. Zum Beispiel: &groupby=osVersion,market&aggregationLevel=week |
No |
Filter (Felder)
Der Filter-Parameter der Anforderung enthält eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Jede Anweisung enthält ein Feld und einen Wert, die den Operatoren eq oder ne zugeordnet sind, und Anweisungen können mithilfe und oder oder kombiniert werden.
Hier ist eine Beispiel-Filter-Zeichenfolge: filter=market eq 'US' und deviceType eq 'phone' und isRevised eq true
Eine Liste der unterstützten Felder finden Sie in der folgenden Tabelle. Zeichenfolgenwerte müssen von einfachen Anführungszeichen im Filter-Parameter umgeben sein.
Felder | Beschreibung |
---|---|
Markt | Eine Zeichenfolge, die den ISO 3166-Ländercode des Marktes enthält, in dem Ihre App bewertet wurde. |
osVersion | Eine der folgenden Zeichenfolgen:
|
deviceType | Eine der folgenden Zeichenfolgen:
|
isRevised | Geben Sie true an, um nach Bewertungen zu filtern, die überarbeitet wurden; andernfalls false. |
Anforderungsbeispiel
Die folgenden Beispiele veranschaulichen mehrere Anforderungen zum Abrufen von Bewertungsdaten. Ersetzen Sie den applicationId-Wert durch die Store-ID für Ihre App.
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>
Antwort
Antworttext
Wert | Typ | BESCHREIBUNG |
---|---|---|
Wert | array | Ein Array von Objekten, die aggregierte Bewertungsdaten enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt Bewertungswerte. |
@nextLink | Zeichenfolge | Wenn zusätzliche Datenseiten vorhanden sind, enthält diese Zeichenfolge einen URI, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. Dieser Wert wird beispielsweise zurückgegeben, wenn der oberste Parameter der Anforderung auf 10000 festgelegt ist, aber für die Abfrage mehr als 10000 Zeilen mit Bewertungsdaten vorhanden sind. |
TotalCount | int | Die Gesamtanzahl der Zeilen im Datenergebnis für die Abfrage. |
Bewertungswerte
Elemente im Value-Array enthalten die folgenden Werte.
Wert | Typ | Beschreibung |
---|---|---|
Datum | Zeichenfolge | Das erste Datum im Datumsbereich für die Bewertungsdaten. Wenn die Anforderung einen einzelnen Tag angegeben hat, ist dieser Wert dieses Datum. Wenn die Anforderung eine Woche, einen Monat oder einen anderen Datumsbereich angegeben hat, ist dieser Wert das erste Datum in diesem Datumsbereich. |
applicationId | Zeichenfolge | Die Store-ID der App, für die Sie Bewertungsdaten abrufen. |
applicationName | Zeichenfolge | Der Anzeigename der App. |
Markt | Zeichenfolge | Der ISO 3166-Ländercode des Marktes, in dem die Bewertung eingereicht wurde. |
osVersion | Zeichenfolge | Die Betriebssystemversion, für die die Bewertung übermittelt wurde. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
deviceType | Zeichenfolge | Der Gerätetyp, auf dem die Bewertung übermittelt wurde. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
isRevised | Boolean | Der Wert true gibt an, dass die Bewertung überarbeitet wurde; andernfalls false. |
oneStar | Zahl | Die Anzahl der Bewertungen mit einem Stern. |
twoStars | Zahl | Die Anzahl der Bewertungen mit zwei Sternen. |
threeStars | Zahl | Die Anzahl der Bewertungen mit drei Sternen. |
fourStars | Zahl | Die Anzahl der Bewertungen mit vier Sternen. |
fiveStars | Zahl | Die Anzahl der Bewertungen mit fünf Sternen. |
Beispiel für Anforderung und Antwort
Die folgenden Codeausschnitte zeigen beispielweise Anforderungs- und JSON-Antworttext für diese Anforderung.
Beispiel-Anfrage
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
Beispiel für eine Antwort
{
"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
}
Beispiel-Anfrage
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>
Beispiel für eine Antwort
{
"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
}