Obtenir un lot d’activités

Obtient un lot d’activités multijoueur pour une liste d’utilisateurs. Cette API permet aux clients et aux services d’obtenir un lot d’activités pour une liste d’utilisateurs. Cette API peut renvoyer des résultats partiels ; chaque utilisateur aura son ensemble complet d’activités, mais certains utilisateurs peuvent n’avoir aucune activité. Si des activités sont trouvées pour un sous-ensemble d’utilisateurs, celles-ci sont renvoyées. Pour les utilisateurs dont les activités n’ont pas été trouvées, une liste vide est renvoyée pour cet utilisateur. Pour les utilisateurs dont les activités n’ont pas pu être récupérées en raison d’une erreur interne, la valeur null est renvoyée pour cet utilisateur ; le client doit réessayer l’appel. En résumé, un utilisateur peut avoir une liste d’activités, une liste vide ou null.

POST /titles/{titleId}/activities/query

Paramètres d’URI

Paramètre	Emplacement	Obligatoire	Type	Description
titleId	path	TRUE	integer	titleId du jeu pour lequel la requête est envoyée.

Corps de la requête

Nom	Obligatoire	Type	Description
users	TRUE	string[]	ID des utilisateurs dont les informations d’activité doivent être récupérées. Jusqu’à 30 utilisateurs sont pris en charge.

En-tête de requête

Nom	Obligatoire	Type	Description
Authorization	TRUE	integer	L’appelant doit fournir un XToken au format d’autorisation XBL 3.0. Par exemple, Authorization: XBL3.0 x=2553948354698;>jeton chiffré <)
Content-Type	TRUE	string	ContentType doit être défini sur application/json

Réponses

Nom	Type	Description
200 OK	GetActivityBatchResponse	L’objet renvoyé contient une liste d’activités pour chaque utilisateur. Si l’utilisateur n’a pas d’activité en cours, sa liste d’activités est vide. En cas de problème de service lors de la récupération des activités d’un utilisateur, sa liste d’activités est null.
400 Bad Request	ErrorResponse	Une erreur s’est produite lors du traitement de la requête. Codes d’erreur possibles : “InvalidRequest - La charge utile de la requête n’est pas valide.”, ” AuthorizationError: L’appelant n’est pas autorisé à accéder à la ressource.”
Autres codes d’état	ThrottledEntity	Trop de requêtes. En-têtes Retry-After: integer

ErrorResponse

Nom	Type	Description
debugMessage	string	Version lisible du message d’erreur, utilisable pour le débogage.
errorCode	string	Énumération du code d’erreur.

GetActivityBatchRequest

Nom	Type	Description
users	string[]	ID des utilisateurs dont les informations d’activité doivent être récupérées. Jusqu’à 30 utilisateurs sont pris en charge.

GetActivityBatchResponse

Nom	Type	Description
userActivities	UserActivity[]

GetActivityResponse

Nom	Type	Description
connectionString	string	La chaîne de connexion est l’objet transmis au client qui se connecte afin de rejoindre la partie. Elle contient généralement des informations telles que l’adresse IP du serveur pour permettre à l’utilisateur qui rejoint de se connecter. La longueur de la chaîne de connexion est limitée à 512 caractères.
currentPlayers	integer	Nombre de joueurs qui jouent déjà avec l’utilisateur dans une activité multijoueur.
groupId	string	Identificateur unique permettant de regrouper tous les utilisateurs qui jouent dans la même partie.
joinRestriction	JoinRestriction	Paramètre qui détermine qui peut rejoindre le joueur actuel.
maxPlayers	integer	Nombre maximal de joueurs pouvant jouer avec ce joueur dans l’activité actuelle.
platform	Platform
sequenceNumber	string	Représentation sous forme de chaîne d’un nombre monotone croissant (ulong) que le client doit transmettre à chaque requête. Il permet de garantir l’ordre des mises à jour d’une activité. Un bon exemple de sequenceNumber est l’heure Unix du client, car elle est garantie croissante. Doit être supérieur à 0 et ne peut pas dépasser la valeur ulong maximale.
titleId	integer	titleId du jeu pour lequel l’activité a été demandée.

JoinRestriction

Nom	Type	Description
Followed	string
InviteOnly	string
Public	string

Platform

Nom	Type	Description
Android	string
IOS	string
Nintendo	string
PlayStation	string
Scarlett	string
Win32	string
WindowsOneCore	string
XboxOne	string

ThrottledEntity

Nom	Type	Description
currentRequests	string	Nombre actuel de requêtes (simultanéité ou débit).
debugMessage	string	Version lisible du message de limitation, utilisable pour le débogage.
limitType	string	Type de limite, c’est-à-dire simultanéité ou débit.
maxRequests	string	Nombre maximal de requêtes autorisées (simultanéité ou débit).
periodInSeconds	string	Période en secondes qui s’applique en cas de dépassement des limites de débit ou de simultanéité.
version	string	Version actuelle du contrat de limitation.

UserActivity

Nom	Type	Description
activities	GetActivityResponse[]
userId	string

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

Obtenir un lot d'activités

Obtenir un lot d’activités

Paramètres d’URI

Corps de la requête

En-tête de requête

Réponses

Définitions

ErrorResponse

GetActivityBatchRequest

GetActivityBatchResponse

GetActivityResponse

JoinRestriction

Platform

ThrottledEntity

UserActivity

​Obtenir un lot d’activités

​Paramètres d’URI

​Corps de la requête

​En-tête de requête

​Réponses

​Définitions

​ErrorResponse

​GetActivityBatchRequest

​GetActivityBatchResponse

​GetActivityResponse

​JoinRestriction

​Platform

​ThrottledEntity

​UserActivity

Obtenir un lot d’activités

Paramètres d’URI

Corps de la requête

En-tête de requête

Réponses

Définitions

ErrorResponse

GetActivityBatchRequest

GetActivityBatchResponse

GetActivityResponse

JoinRestriction

Platform

ThrottledEntity

UserActivity