Abrufen von Xbox Live-Daten zur gleichzeitigen NutzungGet Xbox Live concurrent usage data

Verwenden Sie diese Methode in der Microsoft Store Analytics-API, um Nutzungsdaten nahezu in Echtzeit (mit einer Latenz von 5-15 Minuten) für die durchschnittliche Anzahl der Kunden zu erhalten, die das Xbox Live-fähige Spiel alle Minuten, Stunden oder Tage innerhalb eines bestimmten Zeitraums spielen.Use this method in the Microsoft Store analytics API to get near real-time usage data (with 5-15 minutes latency) about the average number of customers playing your Xbox Live-enabled game every minute, hour, or day during a specified time range. Diese Informationen sind auch im Bericht " Xbox Analytics " im Partner Center verfügbar.This information is also available in the Xbox analytics report in Partner Center.

Wichtig

Diese Methode unterstützt nur Spiele für Xbox oder Spiele, die Xbox Live-Dienste verwenden.This method only supports games for Xbox or games that use Xbox Live services. Diese Spiele müssen den Genehmigungsprozess des Konzeptsdurchlaufen, der Spiele umfasst, die von Microsoft-Partnern und über das ID@Xbox Programmgesendeten spielen veröffentlicht wurden.These games must go through the concept approval process, which includes games published by Microsoft partners and games submitted via the ID@Xbox program. Diese Methode unterstützt zurzeit keine Spiele, die über das Xbox Live Creators-Programmveröffentlicht wurden.This method does not currently support games published via the Xbox Live Creators Program.

VoraussetzungenPrerequisites

Zur Verwendung dieser Methode sind folgende Schritte erforderlich:To use this method, you need to first do the following:

  • Wenn Sie dies nicht bereits getan haben, müssen Sie alle Voraussetzungen für die Microsoft Store Analytics-API erfüllen.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird.Obtain an Azure AD access token to use in the request header for this method. 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. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.After the token expires, you can obtain a new one.

AnforderungRequest

AnforderungssyntaxRequest syntax

MethodeMethod Anforderungs-URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/gameanalytics

AnforderungsheaderRequest header

HeaderHeader typeType BESCHREIBUNGDescription
AuthorizationAuthorization Zeichenfolgestring Erforderlich.Required. Das Azure AD-Zugriffstoken im Format Bearer <token>.The Azure AD access token in the form Bearer <token>.

AnforderungsparameterRequest parameters

ParameterParameter TypType BESCHREIBUNGDescription ErforderlichRequired
applicationIdapplicationId Zeichenfolgestring Die Speicher-ID des Spiels, für das Sie die Daten zur gleichzeitigen Verwendung von Xbox Live abrufen möchten.The Store ID of the game for which you want to retrieve Xbox Live concurrent usage data. JaYes
metrictypemetricType Zeichenfolgestring Eine Zeichenfolge, die den Typ der abzurufenden Xbox Live Analytics-Daten angibt.A string that specifies the type of Xbox Live analytics data to retrieve. Geben Sie für diese Methode den WertParallelität an.For this method, specify the value concurrency. JaYes
startDatestartDate datedate Das Startdatum im Datumsbereich der abzurufenden Daten der gleichzeitigen Verwendung.The start date in the date range of concurrent usage data to retrieve. Das Standardverhalten finden Sie in der aggregationlevel -Beschreibung.See the aggregationLevel description for default behavior. NeinNo
endDateendDate datedate Das Enddatum im Datumsbereich der abzurufenden Daten der gleichzeitigen Verwendung.The end date in the date range of concurrent usage data to retrieve. Das Standardverhalten finden Sie in der aggregationlevel -Beschreibung.See the aggregationLevel description for default behavior. NeinNo
aggregationLevelaggregationLevel Zeichenfolgestring Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen.Specifies the time range for which to retrieve aggregate data. Kann eine der folgenden Zeichen folgen sein: Minute, Houroder Day.Can be one of the following strings: minute, hour, or day. Wenn keine Angabe erfolgt, lautet der Standardwert day.If unspecified, the default is day.

Wenn Sie StartDate oder EndDatenicht angeben, lautet der Antworttext standardmäßig wie folgt:If you do not specify startDate or endDate, the response body defaults to the following:

  • Minute: die letzten 60 Datensätze verfügbarer Daten.minute: The last 60 records of available data.
  • Hour: die letzten 24 Datensätze verfügbarer Daten.hour: The last 24 records of available data.
  • Day: die letzten 7 Datensätze verfügbarer Daten.day: The last 7 records of available data.

Die folgenden Aggregations Ebenen haben Größenbeschränkungen hinsichtlich der Anzahl von Datensätzen, die zurückgegeben werden können.The following aggregation levels have size limits on the number of records that can be returned. Die Datensätze werden abgeschnitten, wenn die angeforderte Zeitspanne zu groß ist.The records will be truncated if the requested time span is too large.

  • Minute: bis zu 1440 Datensätze (24 Stundendaten).minute: Up to 1440 records (24 hours of data).
  • Hour: bis zu 720 Datensätze (Daten von 30 Tagen).hour: Up to 720 records (30 days of data).
  • Day: bis zu 60 Datensätze (60 Tage Daten).day: Up to 60 records (60 days of data).
NeinNo

AnforderungsbeispielRequest example

Im folgenden Beispiel wird eine Anforderung zum erhalten von Daten zur gleichzeitigen Verwendung für das Xbox Live-fähige Spiel veranschaulicht.The following example demonstrates a request for getting concurrent usage data for your Xbox Live-enabled game. Mit dieser Anforderung werden Daten für jede Minute zwischen Februar 1 2018 und dem 2 2018. Februar abgerufen.This request retrieves data for every minute between February 1 2018 and February 2 2018. Ersetzen Sie den Wert ApplicationId durch die Store-ID für Ihr Spiel.Replace the applicationId value with the Store ID for your game.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/gameanalytics?applicationId=9NBLGGGZ5QDR&metrictype=concurrency&aggregationLevel=hour&startDate=2018-02-01&endData=2018-02-02 HTTP/1.1
Authorization: Bearer <your access token>

AntwortResponse

Der Antworttext enthält ein Array von-Objekten, die jeweils einen Satz gleichzeitiger Verwendungs Daten für eine angegebene Minute, Stunde oder einen bestimmten Tag enthalten.The response body contains an array of objects that each contain one set of concurrent usage data for a specified minute, hour, or day. Jedes-Objekt enthält die folgenden Werte:Each object contains the following values.

WertValue TypType BESCHREIBUNGDescription
AnzahlCount numbernumber Die durchschnittliche Anzahl der Kunden, die Ihre Xbox Live-Funktion für die angegebene Minute, Stunde oder den angegebenen Tag spielen.The average number of customers playing your Xbox Live-enabled for the specified minute, hour, or day.

Note   Hinweis   Der Wert 0 gibt entweder an, dass während des angegebenen Intervalls keine gleichzeitigen Benutzer vorhanden waren, oder dass während des angegebenen Intervalls während der Erfassung gleichzeitiger Benutzerdaten für das Spiel ein Fehler aufgetreten ist.Note  A value of 0 indicates either that there were no concurrent users during the specified interval, or that there was a failure while collecting concurrent user data for the game during the specified interval.

DateDate Zeichenfolgestring Das Datum und die Uhrzeit der Angabe von Minute, Stunde oder Tag, in der die Daten zur gleichzeitigen Verwendung aufgetreten sind.The date and time that specifies the minute, hour or day during which the concurrent usage data occurred.
SeriesnameSeriesName Zeichenfolgestring Dies hat immer den Wert userparallelcurrency.This always has the value UserConcurrency.

AntwortbeispielResponse example

Im folgenden Beispiel wird ein Beispiel für einen JSON-Antworttext für diese Anforderung mit Datenaggregation pro Minute veranschaulicht.The following example demonstrates an example JSON response body for this request with data aggregation by minute.

[   {
        "Count": 418.0,
        "Date": "2018-02-02T04:42:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 418.0,
        "Date": "2018-02-02T04:43:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 415.0,
        "Date": "2018-02-02T04:44:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 412.0,
        "Date": "2018-02-02T04:45:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 414.0,
        "Date": "2018-02-02T04:46:13.65Z",
        "SeriesName": "UserConcurrency"
    }
]