Obtenir les données d’entonnoir d’acquisition d’applications

Utilisez cette méthode dans l’API analytique du Microsoft Store pour obtenir les données d’entonnoir d’acquisition d’une application pendant une plage de dates donnée et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport Acquisitions dans l’Espace partenaires.

Prérequis

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

  • Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour l’API d’analyse du Microsoft Store.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de 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 arrivé à expiration, 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/funnel

En-tête de requête

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD sous la formeJeton> du porteur<.

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 de l’entonnoir d’acquisition. Exemple d’ID Windows Store : 9WZDNCRFJ3Q8. Yes
startDate Date Date de début dans la plage de dates des données d’entonnoir d’acquisition à 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’entonnoir d’acquisition à récupérer. La valeur par défaut est la date actuelle. Non
filter string Une ou plusieurs instructions qui filtrent les lignes de la réponse. Pour plus d’informations, voir la section Champs de filtre ci-dessous. Non

 

Champs de filtrage

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

Les champs de filtre suivants sont pris en charge. Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter.

Champs Description
campaignId Chaîne d’ID d’une campagne de promotion d’application personnalisée associée à l’acquisition.
market Chaîne contenant le code pays ISO 3166 du marché de l’acquisition.
deviceType Une des chaînes suivantes qui spécifie le type d’appareil sur lequel l’acquisition s’est produite :
  • PC
  • Téléphone
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Hologrammes
  • Unknown
ageGroup Une des chaînes suivantes qui spécifie le groupe d’âge de l’utilisateur qui a terminé l’acquisition :
  • 0 – 17
  • 18 – 24
  • 25 – 34
  • 35 – 49
  • 50 ans ou plus
  • Unknown
gender Une des chaînes suivantes qui spécifie le sexe de l’utilisateur qui a terminé l’acquisition :
  • M
  • F
  • Unknown

Exemple de requête

L’exemple suivant illustre plusieurs demandes d’obtention de données d’entonnoir d’acquisition pour une application. Remplacez la valeur applicationId par l’ID Windows Store de votre application.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

response

Response body

Valeur Type Description
Valeur tableau Tableau d’objets qui contiennent des données d’entonnoir d’acquisition pour l’application. Pour plus d’informations sur les données de chaque objet, consultez la section Valeurs d’entonnoir ci-dessous.
TotalCount int Nombre total d’objets dans le tableau Value .

Valeurs d’entonnoir

Les objets du tableau Value contiennent les valeurs suivantes.

Valeur Type Description
MetricType string Une des chaînes suivantes qui spécifie le type de données d’entonnoir incluses dans cet objet :
  • PageView
  • Acquisition
  • Installer
  • Utilisation
UserCount string Nombre d’utilisateurs qui ont effectué l’étape d’entonnoir spécifiée par la valeur MetricType .

Exemple de requête et de réponse

Les extraits de code suivants illustrent quelques exemples de requête et de corps de réponse JSON pour ces demandes.

Exemple de demande

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

Exemple de réponse

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 1502
        },
        {
            "MetricType": "Usage",
            "UserCount": 606
        },
        {
            "MetricType": "Install",
            "UserCount": 977
        }
    ],
    "TotalCount": 4
}

Exemple de demande

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/21/2021&filter=market eq 'US' and gender eq 'm'
HTTP/1.1
Authorization: Bearer <your access token>

Exemple de réponse

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 10
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}