Zugreifen auf Analytics-Daten mithilfe von Store ServicesAccess analytics data using Store services

Verwenden Sie die Microsoft Store Analytics-API zum programmgesteuerten Abrufen von Analysedaten für apps, die im Windows Partner Center-Konto Ihrer Organisation registriert sind.Use the Microsoft Store analytics API to programmatically retrieve analytics data for apps that are registered to your or your organization's Windows Partner Center account. Mit dieser API können Sie Daten zum Kauf von Apps und Add-Ons (auch als In-App-Produkte (IAPs) bezeichnet), Fehler, App-Bewertungen und App-Rezensionen abrufen.This API enables you to retrieve data for app and add-on (also known as in-app product or IAP) acquisitions, errors, app ratings and reviews. Diese API verwendet Azure Active Directory (Azure AD), um die Aufrufe von Ihrer App oder Ihrem Dienst zu authentifizieren.This API uses Azure Active Directory (Azure AD) to authenticate the calls from your app or service.

Dazu müssen folgende Schritte ausgeführt werden:The following steps describe the end-to-end process:

  1. Stellen Sie sicher, dass Sie alle Voraussetzungen erfüllt haben.Make sure that you have completed all the prerequisites.
  2. Bevor Sie eine Methode in der Microsoft Store Analytics-API aufrufen, erhalten Sie ein Azure AD Zugriffs Token.Before you call a method in the Microsoft Store analytics API, obtain an Azure AD access token. Nachdem Sie ein Token erhalten haben, haben Sie 60 Minuten Zeit, dieses Token in Aufrufen der Microsoft Store Analytics-API zu verwenden, bevor das Token abläuft.After you obtain a token, you have 60 minutes to use this token in calls to the Microsoft Store analytics API before the token expires. Nach dem Ablauf des Tokens können Sie ein neues Token generieren.After the token expires, you can generate a new token.
  3. Ruft die Microsoft Store Analytics-APIauf.Call the Microsoft Store analytics API.

Schritt 1: Voraussetzungen für die Verwendung der Microsoft Store Analytics-APIStep 1: Complete prerequisites for using the Microsoft Store analytics API

Bevor Sie mit dem Schreiben von Code beginnen, um die Microsoft Store Analytics-API aufzurufen, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind.Before you start writing code to call the Microsoft Store analytics API, make sure that you have completed the following prerequisites.

  • Sie (oder Ihre Organisation) müssen über ein Azure AD-Verzeichnis verfügen, und Ihnen müssen die Berechtigungen globaler Administrator für das Verzeichnis gewährt worden sein.You (or your organization) must have an Azure AD directory and you must have Global administrator permission for the directory. Wenn Sie Microsoft 365 oder andere Unternehmensdienste von Microsoft verwenden, verfügen Sie bereits über ein Azure AD-Verzeichnis.If you already use Microsoft 365 or other business services from Microsoft, you already have Azure AD directory. Andernfalls können Sie eine neue Azure AD im Partner Center erstellen , ohne dass zusätzliche Kosten anfallen.Otherwise, you can create a new Azure AD in Partner Center for no additional charge.

  • Sie müssen Ihrem Partner Center-Konto eine Azure AD Anwendung zuordnen, die Mandanten-ID und die Client-ID für die Anwendung abrufen und einen Schlüssel generieren.You must associate an Azure AD application with your Partner Center account, retrieve the tenant ID and client ID for the application and generate a key. Die Azure AD-Anwendung stellt die APP oder den Dienst dar, von dem aus Sie die Microsoft Store Analytics-API aufzurufen möchten.The Azure AD application represents the app or service from which you want to call the Microsoft Store analytics API. Sie benötigen die Mandanten-ID, die Client-ID und den Schlüssel, um ein Azure AD-Zugriffstoken zu erhalten, das Sie an die API übergeben.You need the tenant ID, client ID and key to obtain an Azure AD access token that you pass to the API.

    Hinweis

    Sie müssen diese Aufgabe nur einmal ausführen.You only need to perform this task one time. Nachdem Sie über die Mandanten-ID, die Client-ID und den Schlüssel verfügen, können Sie diese jederzeit wiederverwenden, wenn Sie ein neues Azure AD-Zugriffstoken erstellen müssen.After you have the tenant ID, client ID and key, you can reuse them any time you need to create a new Azure AD access token.

So ordnen Sie eine Azure AD Anwendung Ihrem Partner Center-Konto zu und rufen die erforderlichen Werte ab:To associate an Azure AD application with your Partner Center account and retrieve the required values:

  1. Verknüpfen Sie in Partner Center das Partner Center-Konto Ihres Unternehmens mit dem Azure AD-Verzeichnis Ihrer Organisation.In Partner Center, associate your organization's Partner Center account with your organization's Azure AD directory.

  2. Fügen Sie als nächstes auf der Seite " Benutzer " im Abschnitt " Kontoeinstellungen " von Partner Center die Azure AD Anwendung hinzu , die die APP oder den Dienst darstellt, die Sie für den Zugriff auf Analysedaten für Ihr Partner Center-Konto verwenden.Next, from the Users page in the Account settings section of Partner Center, add the Azure AD application that represents the app or service that you will use to access analytics data for your Partner Center account. Stellen Sie sicher, dass Sie dieser Anwendung die Rolle Manager zuweisen.Make sure you assign this application the Manager role. Wenn die Anwendung noch nicht in Ihrem Azure AD-Verzeichnis vorhanden ist, können Sie in Partner Center eine neue Azure AD-Anwendung erstellen.If the application doesn't exist yet in your Azure AD directory, you can create a new Azure AD application in Partner Center.

  3. Kehren Sie zur Seite Benutzer zurück, klicken Sie auf den Namen Ihrer Azure AD-Anwendung, um die Anwendungseinstellungen zu öffnen, und schreiben Sie die Werte Mandanten-ID und Client-ID auf.Return to the Users page, click the name of your Azure AD application to go to the application settings, and copy down the Tenant ID and Client ID values.

  4. Klicken Sie auf Neuen Schlüssel hinzufügen.Click Add new key. Notieren Sie auf dem folgenden Bildschirm den Wert von Schlüssel.On the following screen, copy down the Key value. Nachdem Sie diese Seite verlassen haben, können Sie nicht mehr auf diese Informationen zugreifen.You won't be able to access this info again after you leave this page. Weitere Informationen finden Sie unter Verwalten von Schlüsseln für eine Azure AD-Anwendung.For more information, see Manage keys for an Azure AD application.

Schritt 2: Abrufen eines Azure AD-ZugriffstokensStep 2: Obtain an Azure AD access token

Bevor Sie eine der Methoden in der Microsoft Store Analytics-API aufrufen, müssen Sie zuerst ein Azure AD Zugriffs Token abrufen, das Sie an den Autorisierungs Header jeder Methode in der API übergeben.Before you call any of the methods in the Microsoft Store analytics API, you must first obtain an Azure AD access token that you pass to the Authorization header of each method in the API. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft.After you obtain an access token, you have 60 minutes to use it before it expires. Nachdem das Token abgelaufen ist, können Sie es aktualisieren, um es in weiteren Aufrufen an die API zu verwenden.After the token expires, you can refresh the token so you can continue to use it in further calls to the API.

Befolgen Sie zum Abrufen des Zugriffstokens die Anweisungen unter Aufrufe zwischen Diensten mithilfe von Clientanmeldeinformationen, um eine HTTP POST-Anforderung an den https://login.microsoftonline.com/<tenant_id>/oauth2/token-Endpunkt zu senden.To obtain the access token, follow the instructions in Service to Service Calls Using Client Credentials to send an HTTP POST to the https://login.microsoftonline.com/<tenant_id>/oauth2/token endpoint. Hier ist ein Beispiel für eine Anforderung angegeben.Here is a sample request.

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

Geben Sie als Mandanten- * _ ID* im Post-URI und in den Parametern für die Client- _ ID und den * _ geheimen Client* Schlüssel die Mandanten-ID, die Client-ID und den Schlüssel für die Anwendung an, die Sie im vorherigen Abschnitt aus Partner Center abgerufen haben.For the tenant_id value in the POST URI and the client_id and client_secret parameters, specify the tenant ID, client ID and the key for your application that you retrieved from Partner Center in the previous section. Für den Parameter resource müssen Sie https://manage.devcenter.microsoft.com angeben.For the resource parameter, you must specify https://manage.devcenter.microsoft.com.

Nachdem das Zugriffstoken abgelaufen ist, können Sie es aktualisieren, indem Sie diese Anleitung befolgen.After your access token expires, you can refresh it by following the instructions here.

Schritt 3: Abrufen der Microsoft Store Analytics-APIStep 3: Call the Microsoft Store analytics API

Nachdem Sie über ein Azure AD Zugriffs Token verfügen, können Sie die Microsoft Store Analytics-API aufrufen.After you have an Azure AD access token, you are ready to call the Microsoft Store analytics API. Sie müssen das Zugriffstoken an den Authorization-Header der einzelnen Methoden übergeben.You must pass the access token to the Authorization header of each method.

Methoden für UWP-apps und SpieleMethods for UWP apps and games

Die folgenden Methoden sind für apps und Spiele Käufe und Add-on-Käufe verfügbar:The following methods are available for apps and games acquisitions and add-on acquisitions:

Methoden für UWP-appsMethods for UWP apps

Die folgenden Analysemethoden sind für UWP-apps im Partner Center verfügbar.The following analytics methods are available for UWP apps in Partner Center.

SzenarioScenario MethodenMethods
Akquisitionen, Konvertierungen, Installationen und VerwendungAcquisitions, conversions, installs, and usage
App-FehlerApp errors
EinblickeInsights
Bewertungen und RezensionenRatings and reviews
In-App-Werbeeinblendungen und WerbekampagnenIn-app ads and ad campaigns

Methoden für Desktop AnwendungenMethods for desktop applications

Die folgenden Analysemethoden können von Entwickler Konten verwendet werden, die zum Windows-Desktop Anwendungsprogrammgehören.The following analytics methods are available for use by developer accounts that belong to the Windows Desktop Application program.

SzenarioScenario MethodenMethods
VideoInstalls
BlöckeBlocks
AnwendungsfehlerApplication errors
EinblickeInsights

Methoden für Xbox Live-DiensteMethods for Xbox Live services

Die folgenden zusätzlichen Methoden sind für Entwickler Konten mit Spielen verfügbar, die Xbox Live-Diensteverwenden.The following additional methods are available for use by developer accounts with games that use Xbox Live services.

SzenarioScenario MethodenMethods
Allgemeine AnalysenGeneral analytics
Integritäts AnalyseHealth analytics
Community AnalyticsCommunity analytics

Methoden für Hardware und TreiberMethods for hardware and drivers

Entwickler Konten, die zum Windows-Hardware-dashboardprogramm gehören, haben Zugriff auf einen zusätzlichen Satz von Methoden zum Abrufen von Analysedaten für Hardware und Treiber.Developer accounts that belong to the Windows hardware dashboard program have access to an additional set of methods for retrieving analytics data for hardware and drivers. Weitere Informationen finden Sie unter Hardware Dashboard-API.For more information, see Hardware dashboard API.

CodebeispielCode example

Im folgenden Codebeispiel wird veranschaulicht, wie Sie ein Azure AD Zugriffs Token abrufen und die Microsoft Store Analytics-API aus einer c#-Konsolen-App aufrufen.The following code example demonstrates how to obtain an Azure AD access token and call the Microsoft Store analytics API from a C# console app. Wenn Sie dieses Codebeispiel verwenden möchten, weisen Sie die Variablen TenantId, ClientId, ClientSecret und AppID den entsprechenden Werten für Ihr Szenario zu.To use this code example, assign the tenantId, clientId, clientSecret, and appID variables to the appropriate values for your scenario. Für dieses Beispiel ist es erforderlich, dass das JSON.net-Paket von newtonsoft die von der Microsoft Store Analytics-API zurückgegebenen JSON-Daten deserialisiert.This example requires the Json.NET package from Newtonsoft to deserialize the JSON data returned by the Microsoft Store analytics API.

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

namespace TestAnalyticsAPI
{
    class Program
    {
        static void Main(string[] args)
        {
            string tenantId = "<your tenant ID>";
            string clientId = "<your client ID>";
            string clientSecret = "<your secret>";

            string scope = "https://manage.devcenter.microsoft.com";

            // Retrieve an Azure AD access token
            string accessToken = GetClientCredentialAccessToken(
                    tenantId,
                    clientId,
                    clientSecret,
                    scope).Result;

            // This is your app's Store ID. This ID is available on
            // the App identity page of the Dev Center dashboard.
            string appID = "<your app's Store ID>";

            DateTime startDate = DateTime.Parse("08-01-2015");
            DateTime endDate = DateTime.Parse("11-01-2015");
            int pageSize = 1000;
            int startPageIndex = 0;

            // Call the Windows Store analytics API
            CallAnalyticsAPI(accessToken, appID, startDate, endDate, pageSize, startPageIndex);

            Console.Read();
        }

        private static void CallAnalyticsAPI(string accessToken, string appID, DateTime startDate, DateTime endDate, int top, int skip)
        {
            string requestURI;

            // Get app acquisitions
            requestURI = string.Format(
                "https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId={0}&startDate={1}&endDate={2}&top={3}&skip={4}",
                appID, startDate, endDate, top, skip);

            //// Get add-on acquisitions
            //requestURI = string.Format(
            //    "https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId={0}&startDate={1}&endDate={2}&top={3}&skip={4}",
            //    appID, startDate, endDate, top, skip);

            //// Get app failures
            //requestURI = string.Format(
            //    "https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId={0}&startDate={1}&endDate={2}&top={3}&skip={4}",
            //    appID, startDate, endDate, top, skip);

            //// Get app ratings
            //requestURI = string.Format(
            //    "https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId={0}&startDate={1}&endDate={2}top={3}&skip={4}",
            //    appID, startDate, endDate, top, skip);

            //// Get app reviews
            //requestURI = string.Format(
            //    "https://manage.devcenter.microsoft.com/v1.0/my/analytics/reviews?applicationId={0}&startDate={1}&endDate={2}&top={3}&skip={4}",
            //    appID, startDate, endDate, top, skip);

            HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Get, requestURI);
            requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);

            WebRequestHandler handler = new WebRequestHandler();
            HttpClient httpClient = new HttpClient(handler);

            HttpResponseMessage response = httpClient.SendAsync(requestMessage).Result;

            Console.WriteLine(response);
            Console.WriteLine(response.Content.ReadAsStringAsync().Result);

            response.Dispose();
        }

        public static async Task<string> GetClientCredentialAccessToken(string tenantId, string clientId, string clientSecret, string scope)
        {
            string tokenEndpointFormat = "https://login.microsoftonline.com/{0}/oauth2/token";
            string tokenEndpoint = string.Format(tokenEndpointFormat, tenantId);

            dynamic result;
            using (HttpClient client = new HttpClient())
            {
                string tokenUrl = tokenEndpoint;
                using (
                    HttpRequestMessage request = new HttpRequestMessage(
                        HttpMethod.Post,
                        tokenUrl))
                {
                    string content =
                        string.Format(
                            "grant_type=client_credentials&client_id={0}&client_secret={1}&resource={2}",
                            clientId,
                            clientSecret,
                            scope);

                    request.Content = new StringContent(content, Encoding.UTF8, "application/x-www-form-urlencoded");

                    using (HttpResponseMessage response = await client.SendAsync(request))
                    {
                        string responseContent = await response.Content.ReadAsStringAsync();
                        result = JsonConvert.DeserializeObject(responseContent);
                    }
                }
            }

            return result.access_token;
        }
    }
}

FehlercodesError responses

Die Microsoft Store Analytics-API gibt Fehler Antworten in einem JSON-Objekt zurück, das Fehlercodes und Meldungen enthält.The Microsoft Store analytics API returns error responses in a JSON object that contains error codes and messages. Im folgenden Beispiel wird eine Fehlerantwort veranschaulicht, die durch einen ungültigen Parameter bewirkt wurde.The following example demonstrates an error response caused by an invalid parameter.

{
    "code":"BadRequest",
    "data":[],
    "details":[],
    "innererror":{
        "code":"InvalidQueryParameters",
        "data":[
            "top parameter cannot be more than 10000"
        ],
        "details":[],
        "message":"One or More Query Parameters has invalid values.",
        "source":"AnalyticsAPI"
    },
    "message":"The calling client sent a bad request to the service.",
    "source":"AnalyticsAPI"
}