GET (/users/me/inventory)

Renvoie à l’appelant l’ensemble de l’inventaire actuellement associé à l’utilisateur fourni. Le domaine de ces URI est inventory.xboxlive.com.

Remarques
Paramètres de chaîne de requête
Exemple de requête
Corps de la réponse

Remarques

Aucune vérification, application ou filtrage de politique n’aura lieu dans le cadre de cet appel. Les appelants ont la possibilité de transmettre des paramètres de requête afin de restreindre la portée des résultats renvoyés. Les appelants peuvent parcourir les résultats page par page à l’aide d’un jeton de continuation fourni dans une réponse précédente : /users/me/inventory?continuationToken=continuationTokenString. L’appelant peut appeler l’API de détails avec une URL d’élément spécifique afin de consulter les informations sur un élément spécifique.

Paramètres de chaîne de requête

Paramètre	Type	Description
availability	chaîne	Disponibilité actuelle des éléments à renvoyer. La valeur par défaut est « Available », qui renvoie les éléments pour lesquels la date actuelle se situe entre la date de début et la date de fin. Les autres valeurs comprennent « All », qui renvoie tous les éléments, et « Unavailable », qui renvoie les éléments pour lesquels la date actuelle se situe en dehors de la plage de dates de début et de fin et qui ne sont donc pas disponibles actuellement.
container	chaîne	Facultatif. Si vous définissez la valeur sur l’ID de produit d’un jeu, les résultats de l’inventaire incluent uniquement les éléments liés à ce jeu. Cela est particulièrement utile lorsque vous appelez l’inventaire à partir de votre serveur pour filtrer les résultats aux produits d’un jeu spécifique.
expandSatisfyingEntitlements	chaîne	Indicateur qui précise si la réponse inclut tous les droits d’utilisation satisfaisants que l’utilisateur possède dans les résultats renvoyés. La valeur par défaut est « false ». Lorsque ce paramètre est utilisé avec la valeur « true », tous les produits accordés à l’utilisateur au moyen de droits d’utilisation satisfaisants, comme les éléments groupés, les achats XBOX 360 migrés vers XBOX One, les avantages d’abonnement, etc., sont ajoutés aux résultats. Lorsque cette valeur est « false », seuls les éléments parents, comme le ProductID de l’ensemble, sont renvoyés dans les résultats, et non les éléments individuels inclus. Remarque : L’utilisation de ce paramètre avec la valeur « true » est uniquement prise en charge si le paramètre itemType n’est pas inclus dans l’URI; sinon, vous recevrez une erreur HTTP 400.
productIds	chaîne	Collection de ProductIds que vous souhaitez récupérer spécifiquement dans l’inventaire de l’utilisateur, séparés par « , ». Si l’utilisateur n’a pas un ProductID fourni dans ses résultats d’inventaire, cet élément n’apparaîtra pas dans les résultats de l’appel d’API. Si vous transmettez le productID d’un ensemble avec le paramètre expandSatisfyingEntitlements défini sur true, tous les éléments inclus dans l’ensemble sont renvoyés dans les résultats de l’appel (que vous ayez spécifié ou non leurs productIds dans votre chaîne de requête).
state	chaîne	État des éléments à renvoyer. La valeur par défaut est « all », qui renvoie tous les éléments. Les autres valeurs sont « Enabled », qui indique que seuls les éléments activés doivent être renvoyés, « Suspended », qui indique que seuls les éléments suspendus doivent être renvoyés, « Expired », qui indique que seuls les éléments expirés doivent être renvoyés, « Cancelled », qui indique que seuls les éléments annulés doivent être renvoyés, et « Renewed », qui indique que seuls les éléments renouvelés doivent être renvoyés.

En plus de ceux-ci, la ressource prend en charge les mécanismes de pagination standard.

Exemple de requête

Le nom de domaine complet de cette méthode d’URI est https://inventory.xboxlive.com/users/me/inventory.

Remarque :
Les utilisateurs pris en compte dépendent du jeton fourni, qui peut inclure plusieurs utilisateurs. Si vous voulez l’inventaire d’un seul utilisateur, vous devez également fournir le hachage d’utilisateur de l’utilisateur spécifique que vous souhaitez prendre en compte exclusivement.

Corps de la réponse

Si l’appel réussit, le service renvoie un tableau d’éléments d’inventaire. Consultez inventoryItem (JSON).

Exemple de réponse

{
  "pagingInfo": {
    "continuationToken": string,
    "totalItems": int
  },
  "items":
  {
    "url": string,
    "itemType": "Music",
    "titleId": string,
    "containers": string,
    "obtained": DateTime,
    "startDate": DateTime,
    "endDate": DateTime,
    "state": "Enabled"  
}

Voir aussi

Parent

/users/me/inventory

Informations supplémentaires

En-têtes communs d’EDS Paramètres d’EDS Affineurs de requête d’EDS URI de Marketplace Référence supplémentaire

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

GET (/users/me/inventory)

GET (/users/me/inventory)

Remarques

Paramètres de chaîne de requête

Exemple de requête

Corps de la réponse

Exemple de réponse

Voir aussi

Parent

Informations supplémentaires

​GET (/users/me/inventory)

​Remarques

​Paramètres de chaîne de requête

​Exemple de requête

​Corps de la réponse

​Exemple de réponse

​Voir aussi

Parent

Informations supplémentaires

GET (/users/me/inventory)

Remarques

Paramètres de chaîne de requête

Exemple de requête

Corps de la réponse

Exemple de réponse

Voir aussi