Abrufen von Xbox Live SpielehubdatenGet Xbox Live Game Hub data

Verwenden Sie diese Methode in der Microsoft Store Analytics-API, um Game Hub-Daten für das Live-aktivierte Xbox-Spielzu erhalten.Use this method in the Microsoft Store analytics API to get Game Hub data for your Xbox Live-enabled game. 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 typeType BESCHREIBUNGDescription ErforderlichRequired
applicationIdapplicationId Zeichenfolgestring Die Speicher-ID des Spiels, für das Sie Xbox Live Game Hub-Daten abrufen möchten.The Store ID of the game for which you want to retrieve Xbox Live Game Hub 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 Wert communitymanagergamehuban.For this method, specify the value communitymanagergamehub. JaYes
startDatestartDate datedate Das Startdatum im Datumsbereich der abzurufenden spielhub-Daten.The start date in the date range of Game Hub data to retrieve. Der Standardwert ist 30 Tage vor dem aktuellen Datum.The default is 30 days before the current date. NeinNo
endDateendDate datedate Das Enddatum im Datumsbereich der abzurufenden spielhub-Daten.The end date in the date range of Game Hub data to retrieve. Als Standardeinstellung wird das aktuelle Datum festgelegt.The default is the current date. NeinNo
toptop INTint Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen.The number of rows of data to return in the request. Der Maximal- und Standardwert ist 10.000, wenn nicht anders angegeben.The maximum value and the default value if not specified is 10000. Sind in der Abfrage keine weiteren Zeilen, enthält der Antworttext den Link „Weiter“, über den Sie die nächste Seite mit Daten anfordern können.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NeinNo
skipskip INTint Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen.The number of rows to skip in the query. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern.Use this parameter to page through large data sets. Beispielsweise rufen „top=10000“ und „skip=0“ die ersten 10.000 Datenzeilen ab, „top=10000“ und „skip=10000“ die nächsten 10.000 Datenzeilen usw.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NeinNo

AnforderungsbeispielRequest example

Das folgende Beispiel zeigt eine Anforderung zum erhalten von spielhub-Daten für Ihr Xbox Live-fähiges Spiel.The following example demonstrates a request for getting Game Hub data for your Xbox Live-enabled game. 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=communitymanagergamehub&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

AntwortResponse

WertValue typeType BESCHREIBUNGDescription
WertValue arrayarray Ein Array von-Objekten, die spielhub Daten für jedes Datum im angegebenen Datumsbereich enthalten.An array of objects that contain Game Hub data for each date in the specified date range. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in der folgenden Tabelle.For more information about the data in each object, see the following table.
@nextLink Zeichenfolgestring Wenn weitere Seiten mit Daten vorhanden sind, enthält diese Zeichenfolge einen URI, mit dem Sie die nächste Seite mit Daten anfordern können.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Dieser Wert wird z. b. zurückgegeben, wenn der Top -Parameter der Anforderung auf 10000 festgelegt ist, aber mehr als 10000 Daten Zeilen für die Abfrage vorhanden sind.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of data for the query.
TotalCountTotalCount INTint Die Gesamtzahl der Zeilen im Datenergebnis für die Abfrage.The total number of rows in the data result for the query.

Elemente im Array Value enthalten die folgenden Werte.Elements in the Value array contain the following values.

WertValue typeType BESCHREIBUNGDescription
datedate Zeichenfolgestring Das Datum für die spielhub-Daten in diesem-Objekt.The date for the Game Hub data in this object.
applicationIdapplicationId Zeichenfolgestring Die Speicher-ID des Spiels, für das Sie die spielhub-Daten abrufen.The Store ID of the game for which you are retrieving Game Hub data.
gamehublikecountgameHubLikeCount numbernumber Die Anzahl der der spielhub Seite am angegebenen Datum hinzugefügten likes.The number of likes added to the Game Hub page on the specified date.
gamehubcommentcountgameHubCommentCount numbernumber Die Anzahl der Kommentare, die der spielhub Seite für Ihre APP am angegebenen Datum hinzugefügt werden.The number of comments added to the Game Hub page for your app on the specified date.
gamehubsharecountgameHubShareCount numbernumber Gibt an, wie oft die spielhub Seite für Ihre APP an dem angegebenen Datum von Kunden gemeinsam genutzt wurde.The number of times the Game Hub page for your app was shared by customers on the specified date.
gamehubfollowercountgameHubFollowerCount numbernumber Die Anzahl aller Zeit-Follower für die spielhub Seite für Ihre APP.The number of all-time followers for the Game Hub page for your app.

AntwortbeispielResponse example

Das folgende Beispiel zeigt ein Beispiel für einen JSON-Antworttext für diese Anforderung.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2018-01-04",
      "applicationId": "9NBLGGGZ5QDR",
      "gameHubLikeCount": 10,
      "gameHubCommentCount": 1,
      "gameHubShareCount": 0,
      "gameHubFollowerCount": 15924
    },
    {
      "date": "2018-01-05",
      "applicationId": "9NBLGGGZ5QDR",
      "gameHubLikeCount": 12,
      "gameHubCommentCount": 1,
      "gameHubShareCount": 0,
      "gameHubFollowerCount": 15931
    }
  ],
  "@nextLink": null,
  "TotalCount": 26
}