Obtener lote de actividades

Obtiene un lote de actividades multijugador para una lista de usuarios. Esta API permite que los clientes y servicios obtengan un lote de actividades para una lista de usuarios. Esta API puede devolver resultados parciales; cualquier usuario determinado tendrá su conjunto completo de actividades, pero es posible que algunos usuarios no tengan ninguna actividad. Si se encontraron actividades para un subconjunto de usuarios, se devuelven. Para los usuarios cuyas actividades no se encontraron, se devuelve una lista vacía para ese usuario. Para los usuarios cuyas actividades no se pudieron recuperar debido a un error interno, se devuelve null para ese usuario; el cliente debe reintentar la llamada. En resumen, un usuario puede tener una lista de actividades, una lista vacía o null.

POST /titles/{titleId}/activities/query

Parámetros de URI

Parámetro	En	Obligatorio	Tipo	Descripción
titleId	path	TRUE	integer	El titleId del juego para el que se envía la solicitud.

Cuerpo de la solicitud

Nombre	Obligatorio	Tipo	Descripción
users	TRUE	string[]	Los identificadores de los usuarios cuya información de actividad debe recuperarse. Se admiten hasta 30 usuarios.

Encabezado de la solicitud

Nombre	Obligatorio	Tipo	Descripción
Authorization	TRUE	integer	El autor de la llamada debe proporcionar un XToken en el formato de autorización XBL 3.0. Por ejemplo, Authorization: XBL3.0 x=2553948354698;>encrypted token <)
Content-Type	TRUE	string	ContentType debe establecerse en application/json

Respuestas

Nombre	Tipo	Descripción
200 OK	GetActivityBatchResponse	El objeto devuelto contiene una lista de actividades para cada usuario. Si el usuario no tiene una actividad actual, la lista de actividades de ese usuario estará vacía. Si hubo un problema de servicio al obtener las actividades de un usuario, la lista de actividades de ese usuario será null.
400 Bad Request	ErrorResponse	Se produjo un error al procesar la solicitud. Códigos de error posibles: “InvalidRequest - The request payload is invalid.”, ” AuthorizationError: The caller is not allowed to access the resource.”
Otros códigos de estado	ThrottledEntity	Demasiadas solicitudes. Encabezados Retry-After: integer

ErrorResponse

Nombre	Tipo	Descripción
debugMessage	string	Versión legible del mensaje de error que se puede usar para depurar.
errorCode	string	Enumeración de códigos de error.

GetActivityBatchRequest

Nombre	Tipo	Descripción
users	string[]	Los identificadores de los usuarios cuya información de actividad debe recuperarse. Se admiten hasta 30 usuarios.

GetActivityBatchResponse

Nombre	Tipo	Descripción
userActivities	UserActivity[]

GetActivityResponse

Nombre	Tipo	Descripción
connectionString	string	La cadena de conexión es el objeto que se pasa al cliente que se conecta para poder unirse al juego. La cadena de conexión suele contener información como la IP del servidor para permitir que el usuario que se une pueda conectarse. La longitud de la cadena de conexión está limitada a 512 caracteres.
currentPlayers	integer	El número de jugadores que ya están jugando con el usuario en una actividad multijugador.
groupId	string	Un identificador único para agrupar a todos los usuarios que juegan como parte del mismo juego.
joinRestriction	JoinRestriction	La configuración que determina quién puede unirse al jugador actual.
maxPlayers	integer	El número máximo de jugadores que pueden jugar con este jugador en la actividad actual.
platform	Platform
sequenceNumber	string	Es una representación de cadena de un número monótonamente creciente (ulong) que el cliente debe pasar en cada solicitud. Se usa para garantizar el orden de las actualizaciones de una actividad. Un buen ejemplo de sequenceNumber puede ser la hora Unix del cliente, ya que se garantiza que va en aumento. Debe ser mayor que 0 y no puede ser mayor que el valor máximo de ulong.
titleId	integer	El titleId del juego para el que se solicitó la actividad.

JoinRestriction

Nombre	Tipo	Descripción
Followed	string
InviteOnly	string
Public	string

Platform

Nombre	Tipo	Descripción
Android	string
IOS	string
Nintendo	string
PlayStation	string
Scarlett	string
Win32	string
WindowsOneCore	string
XboxOne	string

ThrottledEntity

Nombre	Tipo	Descripción
currentRequests	string	Número actual de solicitudes: simultaneidad o frecuencia.
debugMessage	string	Versión legible del mensaje de limitación que se puede usar para depurar.
limitType	string	El tipo de límite, es decir, simultaneidad o frecuencia.
maxRequests	string	Número máximo de solicitudes permitidas: simultaneidad o frecuencia.
periodInSeconds	string	El período en segundos que se aplica cuando se superan los límites de frecuencia o simultaneidad.
version	string	Versión actual del contrato de limitación.

UserActivity

Nombre	Tipo	Descripción
activities	GetActivityResponse[]
userId	string

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

POST /titles/{titleId}/activities/query

Obtener lote de actividades

Parámetros de URI

Cuerpo de la solicitud

Encabezado de la solicitud

Respuestas

Definiciones

ErrorResponse

GetActivityBatchRequest

GetActivityBatchResponse

GetActivityResponse

JoinRestriction

Platform

ThrottledEntity

UserActivity

​Obtener lote de actividades

​Parámetros de URI

​Cuerpo de la solicitud

​Encabezado de la solicitud

​Respuestas

​Definiciones

​ErrorResponse

​GetActivityBatchRequest

​GetActivityBatchResponse

​GetActivityResponse

​JoinRestriction

​Platform

​ThrottledEntity

​UserActivity

Obtener lote de actividades

Parámetros de URI

Cuerpo de la solicitud

Encabezado de la solicitud

Respuestas

Definiciones

ErrorResponse

GetActivityBatchRequest

GetActivityBatchResponse

GetActivityResponse

JoinRestriction

Platform

ThrottledEntity

UserActivity