Obtenir les avis sur les applicationsGet app reviews

Utilisez cette méthode dans l’API Microsoft Store Analytics pour obtenir des données de révision au format JSON pour une plage de dates donnée et d’autres filtres facultatifs.Use this method in the Microsoft Store analytics API to get review data in JSON format for a given date range and other optional filters. Ces informations sont également disponibles dans le rapport de révisions dans l’espace partenaires.This information is also available in the Reviews report in Partner Center.

Une fois que vous avez récupéré les révisions, vous pouvez utiliser les méthodes obtenir les informations de réponse pour les révisions de l’application et Envoyer des réponses aux révisions d’application dans l’API de révisions de l’Microsoft Store pour répondre par programmation auxAfter you retrieve reviews, you can use the get response info for app reviews and submit responses to app reviews methods in the Microsoft Store reviews API to programmatically respond to reviews.

PrérequisPrerequisites

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :To use this method, you need to first do the following:

  • Si vous ne l’avez pas déjà fait, renseignez toutes les conditions préalables pour l’API Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de cette méthode.Obtain an Azure AD access token to use in the request header for this method. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire.After you obtain an access token, you have 60 minutes to use it before it expires. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.After the token expires, you can obtain a new one.

RequêteRequest

Syntaxe de la requêteRequest syntax

MéthodeMethod URI de demandeRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews

En-tête de requêteRequest header

En-têteHeader TypeType DescriptionDescription
AutorisationAuthorization stringstring Obligatoire.Required. Jeton d’accès Azure AD sous la forme Bearer <jeton>.The Azure AD access token in the form Bearer <token>.

Paramètres de la demandeRequest parameters

ParamètreParameter TypeType DescriptionDescription ObligatoireRequired
applicationIdapplicationId stringstring ID de stockage de l’application dont vous souhaitez récupérer les données de révision.The Store ID of the app for which you want to retrieve review data. OuiYes
startDatestartDate Datedate Dans la plage de dates, la date de début de la récupération des avis.The start date in the date range of review data to retrieve. La valeur par défaut est la date actuelle.The default is the current date. NonNo
endDateendDate Datedate Dans la plage de dates, la date de début de la récupération des avis.The end date in the date range of review data to retrieve. La valeur par défaut est la date actuelle.The default is the current date. NonNo
toptop intint Le nombre de lignes de données à renvoyer dans la requête.The number of rows of data to return in the request. La valeur maximale et la valeur par défaut en l’absence de définition est 10000.The maximum value and the default value if not specified is 10000. Si la requête comporte davantage de lignes, le corps de la réponse inclut un lien sur lequel vous cliquez pour solliciter la page suivante de données.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NonNo
skipskip intint Le nombre de lignes à ignorer dans la requête.The number of rows to skip in the query. Utilisez ce paramètre pour parcourir de grands ensembles de données.Use this parameter to page through large data sets. Par exemple, indiquez top=10000 et skip=0 pour obtenir les 10000 premières lignes de données, top=10000 et skip=10000 pour obtenir les 10000 lignes suivantes, et ainsi de suite.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NonNo
Filterfilter stringstring Une ou plusieurs instructions qui filtrent les lignes de la réponse.One or more statements that filter the rows in the response. Pour plus d’informations, voir la section Champs de filtre ci-dessous.For more information, see the filter fields section below. NonNo
orderbyorderby stringstring Instruction commandant les valeurs des données de résultats.A statement that orders the result data values. La syntaxe est orderby = Field [Order], champ [Order],.... Le paramètre Field peut être l’une des chaînes suivantes :The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • osVersionosVersion
  • négocimarket
  • deviceTypedeviceType
  • isRevisedisRevised
  • packageVersionpackageVersion
  • DeviceModel audeviceModel
  • productFamilyproductFamily
  • deviceScreenResolutiondeviceScreenResolution
  • isTouchEnabledisTouchEnabled
  • reviewerNamereviewerName
  • reviewTitlereviewTitle
  • reviewTextreviewText
  • helpfulCounthelpfulCount
  • notHelpfulCountnotHelpfulCount
  • responseDateresponseDate
  • responseTextresponseText
  • deviceRAMdeviceRAM
  • deviceStorageCapacitydeviceStorageCapacity
  • audiencerating

Le paramètre order, facultatif, peut comporter les valeurs asc ou desc afin de spécifier l’ordre croissant ou décroissant pour chaque champ.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. La valeur par défaut est ASC.The default is asc.

Voici un exemple de chaîne orderby : orderby = date, MarketHere is an example orderby string: orderby=date,market

NonNo

Champs de filtrageFilter fields

Le paramètre filter de la requête contient une ou plusieurs instructions qui filtrent les lignes de la réponse.The filter parameter of the request contains one or more statements that filter the rows in the response. Chaque instruction comporte un champ et une valeur qui sont associés aux opérateurs eq ou ne, et certains champs prennent également en charge les opérateurs contains, gt, lt, ge et le.Each statement contains a field and value that are associated with the eq or ne operators, and some fields also support the contains, gt, lt, ge, and le operators. Les instructions peuvent être combinées à l’aide des opérateurs and ou or.Statements can be combined using and or or.

Voici un exemple de chaîne filter : filter=contains(reviewText,’great’) and contains(reviewText,’ads’) and deviceRAM lt 2048 and market eq ’US’Here is an example filter string: filter=contains(reviewText,'great') and contains(reviewText,'ads') and deviceRAM lt 2048 and market eq 'US'

Pour obtenir une liste des champs pris en charge et des opérateurs associés à chacun d’entre eux, consultez le tableau suivant.For a list of the supported fields and support operators for each field, see the following table. Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter.String values must be surrounded by single quotes in the filter parameter.

ChampsFields Opérateurs pris en chargeSupported operators DescriptionDescription
marketmarket eq, neeq, ne Chaîne contenant le code pays ISO 3166 du marché des appareils.A string that contains the ISO 3166 country code of the device market.
osVersionosVersion eq, neeq, ne Une des chaînes suivantes :One of the following strings:
  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnknownUnknown
deviceTypedeviceType eq, neeq, ne Une des chaînes suivantes :One of the following strings:
  • PCPC
  • NumérosPhone
  • Console-Xbox OneConsole-Xbox One
  • Console-série Xbox XConsole-Xbox Series X
  • IoTIoT
  • HologrammesHolographic
  • UnknownUnknown
isRevisedisRevised eq, neeq, ne Spécifiez la valeur true pour filtrer les avis révisés ; sinon, définissez la valeur false.Specify true to filter for reviews that have been revised; otherwise false.
packageVersionpackageVersion eq, neeq, ne La version du package d’application qui a été passée en revue.The version of the app package that was reviewed.
deviceModeldeviceModel eq, neeq, ne Le type d’appareil sur lequel l’application a été révisée.The type of device on which the app was reviewed.
productFamilyproductFamily eq, neeq, ne Une des chaînes suivantes :One of the following strings:
  • PCPC
  • TabletTablet
  • NumérosPhone
  • WearableWearable
  • ServeurServer
  • CCMCollaborative
  • AutreOther
deviceRAMdeviceRAM eq, ne, gt, lt, ge, leeq, ne, gt, lt, ge, le Mémoire RAM physique, en Mo.The physical RAM, in MB.
deviceScreenResolutiondeviceScreenResolution eq, neeq, ne Résolution de l’écran de l’appareil dans la hauteur de la " largeur x height " .The device screen resolution in the format "width x height".
deviceStorageCapacitydeviceStorageCapacity eq, ne, gt, lt, ge, leeq, ne, gt, lt, ge, le Capacité du disque de stockage principal, en Go.The capacity of the primary storage disk, in GB.
isTouchEnabledisTouchEnabled eq, neeq, ne Spécifiez la valeur true pour filtrer les appareils tactiles ; sinon, définissez la valeur false.Specify true to filter for touch-enabled devices; otherwise false.
reviewerNamereviewerName eq, neeq, ne Nom de réviseur.The reviewer name.
ratingrating eq, ne, gt, lt, ge, leeq, ne, gt, lt, ge, le Classification de l’application, en étoiles.The app rating, in stars.
reviewTitlereviewTitle eq, ne, containseq, ne, contains Le titre de l’avis.The title of the review.
reviewTextreviewText eq, ne, containseq, ne, contains Texte de l’avis.The text contents of the review.
helpfulCounthelpfulCount eq, neeq, ne Le nombre d’occurrences où l’avis a été marqué comme utile.The number of times the review was marked helpful.
notHelpfulCountnotHelpfulCount eq, neeq, ne Nombre d’occurrences où l’avis a été signalé comme inutile.The number of times the review was marked not helpful.
responseDateresponseDate eq, neeq, ne Date à laquelle la réponse a été soumise.The date that the response was submitted.
responseTextresponseText eq, ne, containseq, ne, contains Texte de la réponse.The text contents of the response.
idid eq, neeq, ne ID de la révision (il s’agit d’un GUID).The ID of the review (this is a GUID).

Exemple de requêteRequest example

Les exemples suivants illustrent plusieurs requêtes de récupération des avis.The following examples demonstrate several requests for getting review data. Remplacez la valeur applicationId par l’ID Windows Store de votre application.Replace the applicationId value with the Store ID for your app.

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>

responseResponse

Response bodyResponse body

ValeurValue TypeType DescriptionDescription
ValeurValue tableauarray Un tableau d’objets comportant des avis.An array of objects that contain review data. Pour plus d’informations sur les données de chaque objet, consultez la section Valeurs d’avis ci-dessous.For more information about the data in each object, see the review values section below.
@nextLink stringstring S’il existe des pages supplémentaires de données, cette chaîne comporte un URI que vous pouvez utiliser pour solliciter la page suivante de données.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Par exemple, cette valeur est renvoyée si le paramètre top de la requête est défini sur 10000, mais que plus de 10000 lignes de données d’avis sont associées à la requête.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of reviews data for the query.
TotalCountTotalCount intint Nombre total de lignes dans les résultats de la requête.The total number of rows in the data result for the query.

 

Valeurs d’avisReview values

Les éléments du tableau Value comportent les valeurs suivantes :Elements in the Value array contain the following values.

ValeurValue TypeType DescriptionDescription
Datedate stringstring Première date dans la plage de dates des données d’avis.The first date in the date range for the review data. Si la requête spécifiait un jour précis, cette valeur correspond à la date.If the request specified a single day, this value is that date. Si la requête était relative à une semaine, un mois ou toute autre plage de dates, cette valeur correspond à la première date de la plage de dates.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId stringstring ID Windows Store de l’application dont vous récupérez les données d’avis.The Store ID of the app for which you are retrieving review data.
applicationNameapplicationName stringstring Nom d’affichage de l’application.The display name of the app.
marketmarket stringstring Code pays ISO 3166 du marché où l’avis a été soumis.The ISO 3166 country code of the market where the review was submitted.
osVersionosVersion stringstring Version du système d’exploitation sur lequel l’avis a été soumis.The OS version on which the review was submitted. Pour obtenir la liste des chaînes prises en charge, consultez la section Champs de filtrage ci-dessus.For a list of the supported strings, see the filter fields section above.
deviceTypedeviceType stringstring Type d’appareil sur lequel l’avis a été soumis.The type of device on which the review was submitted. Pour obtenir la liste des chaînes prises en charge, consultez la section Champs de filtrage ci-dessus.For a list of the supported strings, see the filter fields section above.
isRevisedisRevised BooléenBoolean La valeur true indique que l’avis a été révisé ; sinon, la valeur false est affichée.The value true indicates that the review was revised; otherwise false.
packageVersionpackageVersion stringstring La version du package d’application qui a été passée en revue.The version of the app package that was reviewed.
deviceModeldeviceModel stringstring Le type d’appareil sur lequel l’application a été révisée.The type of device on which the app was reviewed.
productFamilyproductFamily stringstring Le nom de la famille d’appareils.The device family name. Pour obtenir la liste des chaînes prises en charge, consultez la section Champs de filtrage ci-dessus.For a list of the supported strings, see the filter fields section above.
deviceRAMdeviceRAM nombrenumber Mémoire RAM physique, en Mo.The physical RAM, in MB.
deviceScreenResolutiondeviceScreenResolution stringstring Résolution de l’écran de l’appareil au format «largeur x hauteur».The device screen resolution in the format "width x height".
deviceStorageCapacitydeviceStorageCapacity nombrenumber Capacité du disque de stockage principal, en Go.The capacity of the primary storage disk, in GB.
isTouchEnabledisTouchEnabled BooléenBoolean La valeur true indique l’activation de l’interaction tactile ; sinon, la valeur false est affichée.The value true indicates that touch is enabled; otherwise false.
reviewerNamereviewerName stringstring Nom de réviseur.The reviewer name.
ratingrating nombrenumber Classification de l’application, en étoiles.The app rating, in stars.
reviewTitlereviewTitle stringstring Le titre de l’avis.The title of the review.
reviewTextreviewText stringstring Texte de l’avis.The text contents of the review.
helpfulCounthelpfulCount nombrenumber Le nombre d’occurrences où l’avis a été marqué comme utile.The number of times the review was marked helpful.
notHelpfulCountnotHelpfulCount nombrenumber Nombre d’occurrences où l’avis a été signalé comme inutile.The number of times the review was marked not helpful.
responseDateresponseDate stringstring Date de soumission d’une réponse.The date a response was submitted.
responseTextresponseText stringstring Texte de la réponse.The text contents of the response.
idid stringstring ID de la révision (il s’agit d’un GUID).The ID of the review (this is a GUID). Vous pouvez utiliser cet ID dans les méthodes obtenir les informations de réponse pour les révisions d’application et envoyer des réponses aux révisions d’application .You can use this ID in the get response info for app reviews and submit responses to app reviews methods.

Exemple de réponseResponse example

L’exemple suivant représente un corps de réponse JSON pour cette requête.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2015-07-29",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso demo",
      "market": "US",
      "osVersion": "10.0.10240.16410",
      "deviceType": "PC",
      "isRevised": true,
      "packageVersion": "",
      "deviceModel": "Microsoft Corporation-Virtual Machine",
      "productFamily": "PC",
      "deviceRAM": -1,
      "deviceScreenResolution": "1024 x 768",
      "deviceStorageCapacity": 51200,
      "isTouchEnabled": false,
      "reviewerName": "ALeksandra",
      "rating": 5,
      "reviewTitle": "Love it",
      "reviewText": "Great app for demos and great dev response.",
      "helpfulCount": 0,
      "notHelpfulCount": 0,
      "responseDate": "2015-08-07T01:50:22.9874488Z",
      "responseText": "1",
      "id": "6be543ff-1c9c-4534-aced-af8b4fbe0316"
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}