Obtenir les données relatives aux performances de la campagne publicitaire

  • Article

Utilisez cette méthode dans l’API d’analyse de la Boutique Microsoft pour obtenir un résumé agrégé des données de performances des campagnes publicitaires promotionnelles 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 campagne publicitaire dans l’Espace partenaires. Pour plus d’informations sur les campagnes publicitaires, consultez Créer une campagne publicitaire pour votre application.

Pour créer, mettre à jour ou récupérer des détails pour les campagnes publicitaires, vous pouvez utiliser les méthodes Gérer les campagnes publicitaires dans l’API de promotions de la Boutique Microsoft.

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/promotion

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 les données de performances des campagnes 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 des campagnes publicitaires. Non
startDate date Date de début dans la plage de dates des données de performances de campagne publicitaire à 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 de campagne publicitaire à 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. Le seul filtre pris en charge est campaignId. Chaque instruction peut utiliser les 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=campaignId eq '100023'. 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 les données de performances de la campagne publicitaire. La syntaxe est orderby=field [order],field [order],.... Le paramètre de champ peut être l’une des chaînes suivantes :

  • date
  • campaignId

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,campaignId

 Non
groupby string

Instruction qui applique l’agrégation de données uniquement aux champs spécifiés. Spécifiez les champs suivants :

  • campaignId
  • applicationId
  • date
  • currencyCode

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

 Non

Exemple de requête

L’exemple suivant illustre plusieurs demandes d’obtention de données de performances de campagne publicitaire.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' 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 de campagne publicitaire agrégées. Pour plus d’informations sur les données de chaque objet, consultez la section objet de performance de la campagne 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.

Objet de performance de la campagne

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 de la campagne publicitaire. 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 de campagne publicitaire.
campaignId string ID de la campagne publicitaire.
lineId string ID de la ligne de remise de campagne publicitaire qui a généré ces données de performances.
currencyCode string Code monétaire du budget de la campagne.
Dépense string Montant du budget dépensé pour la campagne publicitaire.
impressions long Nombre d’expositions publicitaires pour la campagne.
installations long Nombre d’installations d’application liées à la campagne.
clicks long Nombre de clics sur publicité pour la campagne.
iapInstalls long Le nombre de modules complémentaires (également appelés achats dans l’application ou IAP) est installé en lien avec la campagne.
activeUsers long Nombre d’utilisateurs qui ont cliqué sur une publicité qui fait partie de la campagne et qui sont retournés à l’application.

Exemple de réponse

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

{
  "Value": [
    {
      "date": "2015-04-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "4568",
      "lineId": "0001",
      "currencyCode": "USD",
      "spend": 700.6,
      "impressions": 200,
      "installs": 30,
      "clicks": 8,
      "iapInstalls": 0,
      "activeUsers": 0
    },
    {
      "date": "2015-05-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "1234",
      "lineId": "0002",
      "currencyCode": "USD",
      "spend": 325.3,
      "impressions": 20,
      "installs": 2,
      "clicks": 5,
      "iapInstalls": 0,
      "activeUsers": 0
    }
  ],
  "@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
  "TotalCount": 1917
}