Obtenir les classifications des applications

Article
01/17/2024

Utilisez cette méthode dans l’API d’analyse de la Boutique Microsoft pour obtenir des données d’évaluation agrégées au format JSON pour une plage de dates donnée et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport Révisions dans l’Espace partenaires.

Prérequis

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :

Si ce n’est pas déjà fait, remplissez toutes les conditions préalables relatives à l’API d’analyse de la Boutique Microsoft.
Obtenir un jeton d’accès Azure AD à utiliser dans l’en-tête de requête pour cette méthode. 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. Une fois le jeton expiré, vous pouvez en obtenir un nouveau.

Requête

Syntaxe de la requête

Méthode	URI de demande
GET	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings`

En-tête de requête

En-tête	Type	Description
Autorisation	string	Obligatoire. Jeton d’accès Azure AD au format porteur<jeton>.

Paramètres de la demande

Paramètre	Type	Description	Obligatoire
applicationId	string	ID Store de l’application pour laquelle vous souhaitez récupérer les données d’évaluation.	Oui
startDate	date	Date de début dans la plage de dates des données d’évaluation à récupérer. La valeur par défaut est la date actuelle.	Non
endDate	date	Date de fin dans la plage de dates des données d’évaluation à récupérer. La valeur par défaut est la date actuelle.	Non
haut	int	Nombre de lignes de données à retourner dans la requête. La valeur maximale, soit la valeur par défaut, est 10000 (si cette valeur n’est pas spécifiée). S’il existe plus de lignes dans la requête, le corps de la réponse inclut un lien suivant que vous pouvez utiliser pour demander la page suivante de données.	Non
skip	int	Nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir des jeux de données volumineux. Par exemple, top=10000 et skip=0 récupère les 10000 premières lignes de données, top=10000 et skip=10000 récupère les 10000 lignes de données suivantes, et ainsi de suite.	Non
filter	string	Une ou plusieurs instructions qui filtrent les lignes dans la réponse. Pour plus d’informations, consultez la section Champs de filtreci-dessous.	Non
aggregationLevel	string	Spécifie l’intervalle de temps pour lequel récupérer des données agrégées. Il peut s’agir de l’une des chaînes suivantes : jour, semaine ou mois. Si aucune valeur n’est spécifiée, la valeur par défaut est jour.	Non
orderby	string	Instruction qui commande les valeurs de données de résultat pour chaque évaluation. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes : date osVersion market deviceType isRevised Le paramètre d’ordre est facultatif et peut être asc ou desc pour spécifier l’ordre croissant ou décroissant pour chaque champ. La valeur par défaut est asc. Voici un exemple de chaîne orderby : orderby=date,market	Non
groupby	string	Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Spécifiez les champs suivants : date applicationName market osVersion deviceType isRevised Les lignes de données retournées contiennent les champs spécifiés dans le paramètre groupby, ainsi que les éléments suivants : date applicationId fiveStars fourStars threeStars twoStars Onestar Le paramètre groupby peut être utilisé avec le paramètre aggregationLevel. Par exemple : &groupby=osVersion,market&aggregationLevel=week	Non

Champs Filtrer

Le paramètre de filtre de la requête contient une ou plusieurs instructions qui filtrent les lignes dans la réponse. Chaque instruction contient un champ et une valeur associés aux opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide et ou ou.

Voici un exemple de chaîne de filtre : filter=market eq 'US' et deviceType eq 'phone' et isRevised eq true

Pour connaître les champs pris en charge, consultez la table suivante. Les valeurs de chaîne doivent être entourées de guillemets simples dans le paramètre de filtre.

Champs	Description
market	Chaîne qui contient le code pays ISO 3166 du marché où votre application a été évaluée.
osVersion	Une des chaînes suivantes : Windows Phone 7.5 Windows Phone 8 Windows Phone 8.1 Windows Phone 10 Windows 8 Windows 8.1 Windows 10 Windows 11 Inconnu
deviceType	Une des chaînes suivantes : PC Téléphone Console-Xbox One Console-Xbox Series X IoT Holographique Inconnu
isRevised	Spécifiez true pour filtrer les évaluations qui ont été révisées ; sinon false.

Exemple de requête

Les exemples suivants illustrent plusieurs demandes d’obtention de données d’évaluation. Remplacez la valeur applicationId par l’ID Store de votre application.

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>

Response

Response body

Valeur	Type	Description
active	tableau	Tableau d’objets qui contiennent des données d’évaluation agrégées. Pour plus d’informations sur les données de chaque objet, consultez la section valeurs d’évaluation ci-dessous.
@nextLink	string	S’il existe des pages de données supplémentaires, cette chaîne contient un URI que vous pouvez utiliser pour demander la page suivante des données. Par exemple, cette valeur est retournée si le paramètre supérieur de la requête est défini sur 10000, mais qu’il existe plus de 10000 lignes de données d’évaluations pour la requête.
TotalCount	int	Nombre total de lignes dans le résultat des données de la requête.

Valeurs d'évaluation

Les éléments du tableau Valeur contiennent les valeurs suivantes.

Valeur	Type	Description
date	string	Première date de la plage de dates pour les données d’évaluation. Si la demande a spécifié un jour unique, cette valeur est cette date. Si la requête a spécifié une semaine, un mois ou une autre plage de dates, cette valeur est la première date de cette plage de dates.
applicationId	string	ID Store de l’application pour laquelle vous récupérez les données d’évaluation.
applicationName	string	Nom complet de l'application.
market	string	Code pays ISO 3166 du marché où l’évaluation a été soumise.
osVersion	string	Version du système d’exploitation sur laquelle l’évaluation a été envoyée. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus.
deviceType	string	Type d’appareil sur lequel l’évaluation a été envoyée. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus.
isRevised	Boolean	La valeur true indique que l’évaluation a été révisée ; sinon false.
oneStar	nombre	Nombre d’évaluations d’une étoile.
twoStars	nombre	Nombre d’évaluations à deux étoiles.
threeStars	nombre	Nombre d’évaluations à trois étoiles.
fourStars	nombre	Nombre d’évaluations à quatre étoiles.
fiveStars	nombre	Nombre d’évaluations à cinq étoiles.

Exemple de requête et de réponse

Les extraits de code suivants illustrent un exemple de corps de requête et de réponse JSON pour cette requête.

Exemple de requête

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse


{
    "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
}

Exemple de requête

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>

Exemple de réponse

{
    "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
}

Partager via

Obtenir les classifications des applications

Prérequis

Requête

Syntaxe de la requête

En-tête de requête

Paramètres de la demande

Champs Filtrer

Exemple de requête

Response

Response body

Valeurs d'évaluation

Exemple de requête et de réponse

Exemple de requête

Exemple de réponse

Exemple de requête

Exemple de réponse

Commentaires

Ressources supplémentaires

Partager via

Obtenir les classifications des applications

Prérequis

Requête

Syntaxe de la requête

En-tête de requête

Paramètres de la demande

Champs Filtrer

Exemple de requête

Response

Response body

Valeurs d'évaluation

Exemple de requête et de réponse

Exemple de requête

Exemple de réponse

Exemple de requête

Exemple de réponse

Rubriques connexes

Commentaires

Ressources supplémentaires