Obtenir un lot d’activités

Obtient un lot d’activités multijoueurs 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 retourner des résultats partiels; chaque utilisateur aura son ensemble complet d’activités, mais certains utilisateurs peuvent n’avoir aucune activité. Si nous trouvons des activités pour un sous-ensemble d’utilisateurs, nous retournons celles-ci. Pour les utilisateurs dont les activités n’ont pas été trouvées, nous retournons une liste vide 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, nous retournons null pour cet utilisateur; le client doit réessayer l’appel. En bref, 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	Dans	Obligatoire	Type	Description
titleId	chemin	TRUE	entier	Le titleId du jeu pour lequel la requête est envoyée.

Corps de la requête

Nom	Obligatoire	Type	Description
users	TRUE	chaîne[]	Les 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 la requête

Nom	Obligatoire	Type	Description
Authorization	TRUE	entier	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	chaîne	ContentType doit être défini sur application/json

Réponses

Nom	Type	Description
200 OK	GetActivityBatchResponse	L’objet retourné contient une liste d’activités pour chaque utilisateur. Si l’utilisateur n’a pas d’activité en cours, la liste d’activités de cet utilisateur sera vide. En cas de problème de service lors de l’obtention des activités d’un utilisateur, la liste d’activités de cet utilisateur sera null.
400 Bad Request	ErrorResponse	Une erreur s’est produite lors du traitement de la requête. Codes d’erreur possibles : “InvalidRequest - The request payload is invalid.”, ” AuthorizationError: The caller is not allowed to access the resource.”
Autres codes d’état	ThrottledEntity	Trop de requêtes. En-têtes Retry-After: integer

ErrorResponse

Nom	Type	Description
debugMessage	chaîne	Version lisible du message d’erreur pouvant être utilisée pour le débogage.
errorCode	chaîne	Énumération du code d’erreur.

GetActivityBatchRequest

Nom	Type	Description
users	chaîne[]	Les 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	chaîne	La chaîne de connexion est l’objet passé au client qui se connecte afin de rejoindre la partie. La chaîne de connexion contient généralement des informations comme l’adresse IP du serveur pour permettre à l’utilisateur qui se joint de se connecter. La longueur de la chaîne de connexion est limitée à 512 caractères.
currentPlayers	entier	Le nombre de joueurs qui jouent déjà avec l’utilisateur dans une activité multijoueur.
groupId	chaîne	Un identificateur unique permettant de regrouper tous les utilisateurs qui jouent dans la même partie.
joinRestriction	JoinRestriction	Le paramètre qui détermine qui peut rejoindre le joueur actuel.
maxPlayers	entier	Le nombre maximal de joueurs pouvant jouer avec ce joueur dans l’activité en cours.
platform	Platform
sequenceNumber	chaîne	Il s’agit d’une représentation sous forme de chaîne d’un nombre à croissance monotone (ulong) que le client doit passer pour chaque requête. Il sert à garantir l’ordre des mises à jour d’une activité. Un bon exemple de sequenceNumber est l’heure Unix du client, puisqu’elle est garantie d’être croissante. Doit être supérieur à 0 et ne peut pas être supérieur à la valeur maximale d’un ulong.
titleId	entier	Le titleId du jeu pour lequel l’activité a été demandée.

JoinRestriction

Nom	Type	Description
Followed	chaîne
InviteOnly	chaîne
Public	chaîne

Platform

Nom	Type	Description
Android	chaîne
IOS	chaîne
Nintendo	chaîne
PlayStation	chaîne
Scarlett	chaîne
Win32	chaîne
WindowsOneCore	chaîne
XboxOne	chaîne

ThrottledEntity

Nom	Type	Description
currentRequests	chaîne	Nombre actuel de requêtes - simultanéité ou débit.
debugMessage	chaîne	Version lisible du message de limitation pouvant être utilisée pour le débogage.
limitType	chaîne	Le type de limite, c’est-à-dire simultanéité ou débit.
maxRequests	chaîne	Nombre maximal de requêtes autorisées - simultanéité ou débit.
periodInSeconds	chaîne	La période en secondes qui s’applique lorsque les limites de débit ou de simultanéité sont dépassées.
version	chaîne	Version actuelle du contrat de limitation.

UserActivity

Nom	Type	Description
activities	GetActivityResponse[]
userId	chaîne

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 la 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 la 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 la requête

Réponses

Définitions

ErrorResponse

GetActivityBatchRequest

GetActivityBatchResponse

GetActivityResponse

JoinRestriction

Platform

ThrottledEntity

UserActivity