Obtener datos de uso simultáneo de Xbox LiveGet Xbox Live concurrent usage data

Use este método en la API de Microsoft Store Analytics para obtener datos de uso casi en tiempo real (con una latencia de 5-15 minutos) sobre el número promedio de clientes que juegan su juego habilitado para Xbox Live cada minuto, hora o día durante un intervalo de tiempo especificado.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. Esta información también está disponible en el Informe de análisis de Xbox del centro de Partners.This information is also available in the Xbox analytics report in Partner Center.

Importante

Este método solo admite juegos para Xbox o juegos que usan los servicios de Xbox Live.This method only supports games for Xbox or games that use Xbox Live services. Estos juegos deben pasar por el proceso de aprobación del concepto, que incluye juegos publicados por asociados de Microsoft y juegos enviados a través del ID@Xbox programa.These games must go through the concept approval process, which includes games published by Microsoft partners and games submitted via the ID@Xbox program. Este método no admite actualmente juegos publicados a través del programa de creadores de Xbox Live.This method does not currently support games published via the Xbox Live Creators Program.

Requisitos previosPrerequisites

Para usar este método, primero debes hacer lo siguiente:To use this method, you need to first do the following:

  • Si aún no lo ha hecho, complete todos los requisitos previos de la API de Microsoft Store Analytics.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método.Obtain an Azure AD access token to use in the request header for this method. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/gameanalytics

Encabezado de solicitudRequest header

EncabezadoHeader TipoType DescripciónDescription
AuthorizationAuthorization stringstring Necesario.Required. El token de acceso de Azure AD del formulario Bearer <token>.The Azure AD access token in the form Bearer <token>.

Parámetros de solicitudRequest parameters

ParámetroParameter TipoType DescripciónDescription ObligatorioRequired
applicationIdapplicationId stringstring El identificador de almacén del juego para el que desea recuperar los datos de uso simultáneo de Xbox Live.The Store ID of the game for which you want to retrieve Xbox Live concurrent usage data. Yes
metricTypemetricType stringstring Cadena que especifica el tipo de datos de análisis de Xbox Live que se va a recuperar.A string that specifies the type of Xbox Live analytics data to retrieve. Para este método, especifique la simultaneidaddel valor.For this method, specify the value concurrency. Yes
startDatestartDate datedate Fecha de inicio del intervalo de fechas de datos de uso simultáneos que se va a recuperar.The start date in the date range of concurrent usage data to retrieve. Vea la descripción de aggregationLevel para ver el comportamiento predeterminado.See the aggregationLevel description for default behavior. NoNo
endDateendDate datedate Fecha de finalización del intervalo de fechas de datos de uso simultáneos que se va a recuperar.The end date in the date range of concurrent usage data to retrieve. Vea la descripción de aggregationLevel para ver el comportamiento predeterminado.See the aggregationLevel description for default behavior. NoNo
aggregationLevelaggregationLevel stringstring Especifica el intervalo de tiempo necesario para el que quieres recuperar datos agregados.Specifies the time range for which to retrieve aggregate data. Puede ser una de las siguientes cadenas: minute, houro Day.Can be one of the following strings: minute, hour, or day. Si no se especifica, el valor predeterminado es día.If unspecified, the default is day.

Si no especifica startDate ni EndDate, el cuerpo de respuesta tiene como valor predeterminado el siguiente:If you do not specify startDate or endDate, the response body defaults to the following:

  • minute: los últimos 60 registros de datos disponibles.minute: The last 60 records of available data.
  • hour: los últimos 24 registros de datos disponibles.hour: The last 24 records of available data.
  • Day: los 7 últimos registros de datos disponibles.day: The last 7 records of available data.

Los siguientes niveles de agregación tienen límites de tamaño en el número de registros que se pueden devolver.The following aggregation levels have size limits on the number of records that can be returned. Los registros se truncarán si el intervalo de tiempo solicitado es demasiado grande.The records will be truncated if the requested time span is too large.

  • minuto: hasta 1440 registros (24 horas de datos).minute: Up to 1440 records (24 hours of data).
  • hora: hasta 720 registros (30 días de datos).hour: Up to 720 records (30 days of data).
  • Day: hasta 60 registros (60 días de datos).day: Up to 60 records (60 days of data).
NoNo

Ejemplo de solicitudRequest example

En el ejemplo siguiente se muestra una solicitud para obtener datos de uso simultáneos para el juego habilitado para Xbox Live.The following example demonstrates a request for getting concurrent usage data for your Xbox Live-enabled game. Esta solicitud recupera los datos de cada minuto entre el 1 2018 de febrero y el 2 2018 de febrero.This request retrieves data for every minute between February 1 2018 and February 2 2018. Reemplace el valor de ApplicationID por el identificador de almacén del juego.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>

ResponseResponse

El cuerpo de la respuesta contiene una matriz de objetos que contienen un conjunto de datos de uso simultáneo para un minuto, hora o día especificados.The response body contains an array of objects that each contain one set of concurrent usage data for a specified minute, hour, or day. Cada objeto contiene los valores siguientes.Each object contains the following values.

ValueValue TipoType DescripciónDescription
CountCount numbernumber El número promedio de clientes que juegan su Xbox Live habilitada para el minuto, hora o día especificados.The average number of customers playing your Xbox Live-enabled for the specified minute, hour, or day.

Nota:     Un valor de 0 indica que no había usuarios simultáneos durante el intervalo especificado o que se produjo un error al recopilar datos de usuario simultáneos para el juego durante el intervalo especificado.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 stringstring Fecha y hora que especifican el minuto, la hora o el día en que se produjeron los datos de uso simultáneos.The date and time that specifies the minute, hour or day during which the concurrent usage data occurred.
SeriesNameSeriesName stringstring Siempre tiene el valor UserConcurrency.This always has the value UserConcurrency.

Ejemplo de respuestaResponse example

En el ejemplo siguiente se muestra un cuerpo de respuesta JSON de ejemplo para esta solicitud con la agregación de datos por minuto.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"
    }
]