Obtenir les données relatives aux performances publicitaires

Utilisez cette méthode dans l’API d’analytique du Microsoft Store pour obtenir des données de performances publicitaires agrégées pour vos applications pendant une plage de dates donnée et d’autres filtres facultatifs. Cette méthode retourne les données au format JSON.

Cette méthode retourne les mêmes données que celles fournies par le Rapport de performance publicitaire dans l’Espace partenaires.

Conditions préalables

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

Si vous ne l’avez pas déjà fait, remplissez tous les prérequis pour l’API d’analytique du Microsoft Store.
Obtenez 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.

Pour plus d'informations, consultez les données analytiques d'Access à l'aide des services du Microsoft Store.

Requête

Syntaxe de la requête

Méthode	URI de la requête
OBTENIR	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance`

En-tête de requête

En-tête de page	Catégorie	Descriptif
Autorisation	ficelle	Obligatoire. Le jeton d’accès Azure AD sous la forme Bearer<token>.

Paramètres de la demande

Pour récupérer des données de performances publicitaires pour une application spécifique, utilisez le paramètre applicationId . Pour récupérer les données de performance publicitaire pour toutes les applications associées à votre compte de développeur, omettez le paramètre applicationId.

Paramètre	Catégorie	Descriptif	Obligatoire
applicationId	ficelle	ID Store de l’application pour laquelle vous souhaitez récupérer les données de performances publicitaires.	Non
date de début	date	Date de début de la plage de dates des données de performances publicitaires à récupérer, au format AAAA/MM/DD. La valeur par défaut est la date actuelle moins de 30 jours.	Non
date de fin	date	Date de fin de la plage de dates des données de performances publicitaires à récupérer, au format AAAA/MM/DD. La valeur par défaut est la date actuelle moins un jour.	Non
Haut de page	Int	Nombre de lignes de données à retourner dans la requête. La valeur maximale et la valeur par défaut si elle n’est pas spécifiée est 1 0000. 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
passer	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 1 000 premières lignes de données, top=10000 et skip=10000 récupère les 1 0000 lignes de données suivantes, et ainsi de suite.	Non
Filter	ficelle	Une ou plusieurs instructions qui filtrent les lignes dans la réponse. Pour plus d’informations, consultez la section des champs de filtre ci-dessous.	Non
niveau d'agrégation	ficelle	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
classer par	ficelle	Une instruction qui ordonne les valeurs des données de résultat. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes : date marché type d'appareil adUnitId 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
grouppar	ficelle	Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Vous pouvez spécifier les champs suivants : applicationId nomapplication date accountCurrencyCode marché type d'appareil adUnitName adUnitId pubCenterAppName fournisseur de publicité Le paramètre groupby peut être utilisé avec le paramètre aggregationLevel . Par exemple : &groupby=applicationId&aggregationLevel=week	Non

Champs de filtre

Le paramètre de filtre du corps 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 etou ou. Voici un exemple de paramètre de filtre :

filter=market eq 'US' et typeAppareil eq 'phone'

Pour obtenir la liste des champs pris en charge, consultez le tableau suivant. Les valeurs de chaîne doivent être entourées de guillemets simples dans le paramètre de filtre .

Terrain	Descriptif
marché	Chaîne qui contient le code pays ISO 3166 du marché où les publicités ont été servies.
type de dispositif	Une des chaînes suivantes : PC/Tablette ou Téléphone.
adUnitId	Chaîne qui spécifie un ID d’unité publicitaire à appliquer au filtre.
pubCenterAppName	Chaîne qui spécifie le nom pubCenter de l’application actuelle à appliquer au filtre.
adProvider	Chaîne qui spécifie un nom de fournisseur de publicité à appliquer au filtre.
date	Une chaîne qui spécifie une date au format AAAA/MM/JJ à appliquer au filtre.

Exemple de requête

L’exemple suivant illustre plusieurs demandes d’obtention de données de performances publicitaires. Remplacez la valeur applicationId par l’ID store de votre application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&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/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Réponse

Corps de réponse

Valeur	Catégorie	Descriptif
Valeur	tableau	Tableau d’objets qui contiennent des données de performances publicitaires agrégées. Pour plus d’informations sur les données de chaque objet, consultez la section des valeurs de performances publicitaires ci-dessous.
@nextLink	ficelle	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 premier de la requête est défini sur 5, mais il y a plus de 5 éléments de données pour la requête.
NombreTotal	Int	Nombre total de lignes dans le résultat des données de la requête.

Valeurs de performances publicitaires

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

Valeur	Catégorie	Descriptif
date	ficelle	La première date de la plage de dates pour les données de performances publicitaires. Si la demande a spécifié un jour unique, cette valeur est cette date. Si la demande 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	ficelle	ID Store de l’application pour laquelle vous récupérez des données de performances publicitaires.
Nom de l'application	ficelle	Nom d'affichage de l'application.
adUnitId	ficelle	ID de l’unité publicitaire.
adUnitName	ficelle	Nom de l’unité publicitaire, tel que spécifié par le développeur dans l’Espace partenaires.
adProvider	ficelle	Nom du fournisseur de publicités
type de dispositif	ficelle	Type d’appareil sur lequel les publicités ont été servies. Pour obtenir la liste des chaînes prises en charge, consultez la section des champs de filtre ci-dessus.
marché	ficelle	Code pays ISO 3166 du marché où les publicités ont été diffusées.
codeDeviseCompte	ficelle	Code monétaire du compte.
pubCenterAppName	ficelle	Nom de l’application pubCenter associée à l’application dans l’Espace partenaires.
requêtesDuFournisseurDePublicité	Int	Nombre de demandes publicitaires pour le fournisseur de publicité spécifié.
Impressions	Int	Nombre d’impressions publicitaires.
Clics	Int	Nombre de clics publicitaires.
revenu en devise de compte	nombre	Chiffre d’affaires, dans la devise du pays/région du compte.
Requêtes	Int	Nombre de demandes publicitaires.

Exemple de réponse

L’exemple suivant illustre un exemple de corps de réponse JSON pour cette requête.

{
  "Value": [
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10765920",
      "adUnitName":"TestAdUnit",
      "revenueInAccountCurrency": 10.0,
      "impressions": 1000,
      "requests": 10000,
      "clicks": 1,
      "accountCurrencyCode":"USD"
    },
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10795110",
      "adUnitName":"TestAdUnit2",
      "revenueInAccountCurrency": 20.0,
      "impressions": 2000,
      "requests": 20000,
      "clicks": 3,
      "accountCurrencyCode":"USD"
    },
  ],
  "@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
  "TotalCount": 191753
}

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2025-06-10