Obtenir les données relatives aux performances publicitaires

  • Article

Utilisez cette méthode dans l’API d’analytique de la Boutique Microsoft 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 sur les performances publicitaires 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.

Pour plus d’informations, consultez Accéder aux données d’analyse à l’aide des services de la Boutique Microsoft.

Requête

Syntaxe de la requête

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

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

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 performances publicitaires pour toutes les applications associées à votre compte de développeur, omettez le paramètre applicationId.

Paramètre Type Description Obligatoire
applicationId string ID Store de l’application pour laquelle vous souhaitez récupérer les données de performances publicitaires. Non
startDate 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 30 jours. Non
endDate date Date de fin de la plage de dates des données de performances publicitaires à récupérer, au format AAAA/MM/DD. Par défaut, il s'agit de la date du jour moins un jour. 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. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes :
  • date
  • market
  • deviceType
  • 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
groupby string Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Spécifiez les champs suivants :

  • applicationId
  • applicationName
  • date
  • accountCurrencyCode
  • market
  • deviceType
  • adUnitName
  • adUnitId
  • pubCenterAppName
  • adProvider

Le paramètre groupby peut être utilisé avec le paramètre aggregationLevel. Par exemple : &groupby=applicationId&aggregationLevel=week

 Non

Champs Filtrer

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 et ou ou. Voici un exemple de paramètres de filtres :

  • filter=market eq 'US' et deviceType eq 'phone'

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.

Champ Description
market Chaîne qui contient le code pays ISO 3166 du marché où les publicités ont été servies.
deviceType 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 Chaîne qui spécifie une date au format AAAA/MM/MM/DD à 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>

Response

Response body

Valeur Type Description
active 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 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 5, mais qu’il y a plus de 5 éléments de données pour la requête.
TotalCount 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 Type Description
date string 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 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 des données de performances publicitaires.
applicationName string Nom complet de l'application.
adUnitId string ID de l’unité publicitaire.
adUnitName string Nom de l’unité publicitaire, tel que spécifié par le développeur dans l’Espace partenaires.
adProvider string Nom du fournisseur de publicités
deviceType string Type d’appareil sur lequel les publicités ont été servies. Pour obtenir la liste des chaînes prises en charge, consultez la section champs de filtre ci-dessus.
market string Code pays ISO 3166 du marché où les publicités ont été diffusées.
accountCurrencyCode string Le code devise du compte.
pubCenterAppName string Nom de l’application pubCenter associée à l’application dans l’Espace partenaires.
adProviderRequests int Nombre de demandes publicitaires pour le fournisseur de publicité spécifié.
impressions int Nombre d’expositions publicitaires.
clicks int Nombre de clics sur publicité.
revenueInAccountCurrency number Chiffre d’affaires, dans la devise du pays/région du compte.
requests int Le nombre de demandes de publicité.

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
}