Consultar productos

Usa este método en la API de recopilación de Microsoft Store para obtener todos los productos que posee un cliente para las aplicaciones asociadas al identificador de cliente de Azure AD. Puede definir el ámbito de la consulta a un producto determinado o usar otros filtros.

Este método está diseñado para que el servicio lo llame como respuesta a un mensaje de la aplicación. El servicio no debe sondear periódicamente a todos los usuarios según una programación.

La biblioteca Microsoft.StoreServices proporciona la funcionalidad de este método a través de la API StoreServicesClient.CollectionsQueryAsync.

Requisitos previos

Para usar este método, necesitará:

• Un token de acceso de Azure AD que tiene el valor https://onestore.microsoft.comde URI de audiencia .
• Clave de identificador de Microsoft Store que representa la identidad del usuario cuyos productos quiere obtener.

Para obtener más información, consulte Administración de derechos de producto desde un servicio.

Solicitar

Sintaxis de la solicitud

Método	URI de solicitud
PUBLICAR	https://collections.mp.microsoft.com/v6.0/collections/query

Encabezado de solicitud

Encabezado	Tipo	Descripción
Autorización	string	Necesario. Token de acceso de Azure AD con el formato Token<de portador>.
Host	string	Debe establecerse en el valor collections.mp.microsoft.com.
Content-Length	number	Este encabezado especifica la longitud del cuerpo de la solicitud.
Content-Type	string	Especifica el tipo de solicitud y respuesta. Actualmente, el único valor admitido es application/json.

Cuerpo de la solicitud

Parámetro	Tipo	Descripción	Obligatorio
Beneficiarios	list<UserIdentity>	Lista de objetos UserIdentity que representan los usuarios que se consultan para los productos. Para obtener más información, consulte la tabla siguiente.	Sí
continuationToken	string	Si hay varios conjuntos de productos, el cuerpo de la respuesta devuelve un token de continuación cuando se alcanza el límite de página. Proporcione ese token de continuación aquí en llamadas posteriores para recuperar los productos restantes.	No
maxPageSize	number	Número máximo de productos que se van a devolver en una respuesta. El valor predeterminado y máximo es 100.	No
modifiedAfter	datetime	Si se especifica, el servicio solo devuelve productos modificados después de esta fecha.	No
parentProductId	string	Si se especifica, el servicio solo devuelve complementos que corresponden a la aplicación especificada.	No
productSkuIds	list<ProductSkuId>	Si se especifica, el servicio solo devuelve productos aplicables a los pares de producto o SKU proporcionados. Para obtener más información, consulte la tabla siguiente.	No
productTypes	list<string>	Especifica los tipos de productos que se van a devolver en los resultados de la consulta. Los tipos de productos admitidos son Application, Durable, Game y UnmanagedConsumable.	Sí
validityType	string	Cuando se establece en Todos, se devolverán todos los productos de un usuario, incluidos los elementos expirados. Cuando se establece en Válido, solo se devuelven productos válidos en este momento (es decir, tienen un estado activo, fecha < de inicio ahora y fecha de finalización ahora).>	No

El objeto UserIdentity contiene los parámetros siguientes.

Parámetro	Tipo	Descripción	Obligatorio
identityType	string	Especifique el valor de cadena b2b.	Sí
identityValue	string	Clave de identificador de Microsoft Store que representa la identidad del usuario para el que quiere consultar productos.	Sí
localTicketReference	string	Identificador solicitado para los productos devueltos. Los elementos devueltos en el cuerpo de la respuesta tendrán una localTicketReference coincidente. Se recomienda usar el mismo valor que la notificación userId en la clave de identificador de Microsoft Store.	Sí

El objeto ProductSkuId contiene los parámetros siguientes.

Parámetro	Tipo	Descripción	Obligatorio
productId	string	Identificador de la Tienda de un producto en el catálogo de Microsoft Store. Un ejemplo de Id. de la Tienda para un producto es 9NBLGGH42CFD.	Sí
skuId	string	Identificador de la Tienda para la SKU de un producto en el catálogo de Microsoft Store. Un id. de tienda de ejemplo para una SKU es 0010.	Sí

Ejemplo de solicitud

POST https://collections.mp.microsoft.com/v6.0/collections/query HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1Q…….
Host: collections.mp.microsoft.com
Content-Length: 2531
Content-Type: application/json

{
  "maxPageSize": 100,
  "beneficiaries": [
    {
      "localTicketReference": "1055521810674918",
      "identityValue": "eyJ0eXAiOiJ……",
      "identityType": "b2b"
    }
  ],
  "modifiedAfter": "\/Date(-62135568000000)\/",
  "productSkuIds": [
    {
      "productId": "9NBLGGH5WVP6",
      "skuId": "0010"
    }
  ],
  "productTypes": [
    "UnmanagedConsumable"
  ],
  "validityType": "All"
}

Respuesta

Cuerpo de la respuesta

Parámetro	Tipo	Descripción	Obligatorio
continuationToken	string	Si hay varios conjuntos de productos, este token se devuelve cuando se alcanza el límite de página. Puede especificar este token de continuación en llamadas posteriores para recuperar los productos restantes.	No
items	CollectionItemContractV6	Matriz de productos para el usuario especificado. Para obtener más información, consulte la tabla siguiente.	No

El objeto CollectionItemContractV6 contiene los parámetros siguientes.

Parámetro	Tipo	Descripción	Obligatorio
acquiredDate	datetime	Fecha en la que el usuario adquirió el elemento.	Sí
campaignId	string	Identificador de campaña que se proporcionó en el momento de la compra para este artículo.	No
devOfferId	string	Identificador de la oferta de una compra desde la aplicación.	No
endDate	datetime	Fecha de finalización del elemento.	Sí
fulfillmentData	list<string>	N/D	No
inAppOfferToken	string	Cadena de identificador de producto especificada por el desarrollador que se asigna al elemento en el Centro de partners. Un identificador de producto de ejemplo es product123.	No
itemId	string	Identificador que identifica este elemento de colección de otros elementos que posee el usuario. Este identificador es único por producto.	Sí
localTicketReference	string	Identificador del localTicketReference proporcionado anteriormente en el cuerpo de la solicitud.	Sí
ModifiedDate	datetime	Fecha en que se modificó por última vez este elemento.	Sí
orderId	string	Si está presente, el identificador de pedido del que se obtuvo este elemento.	No
orderLineItemId	string	Si está presente, el elemento de línea del orden concreto para el que se obtuvo este elemento.	No
ownershipType	string	Cadena OwnedByBeneficiary.	Sí
productId	string	Identificador de la Tienda del producto en el catálogo de Microsoft Store. Un ejemplo de Id. de la Tienda para un producto es 9NBLGGH42CFD.	Sí
productType	string	Uno de los siguientes tipos de producto: Application, Durable y UnmanagedConsumable.	Sí
purchasedCountry	string	N/D	No
comprador	IdentityContractV6	Si está presente, representa la identidad del comprador del artículo. Consulte los detalles de este objeto a continuación.	No
cantidad	number	Cantidad del artículo. Actualmente, siempre será 1.	No
skuId	string	Identificador de la Tienda para la SKU del producto en el catálogo de Microsoft Store. Un id. de tienda de ejemplo para una SKU es 0010.	Sí
skuType	string	Tipo de la SKU. Entre los valores posibles se incluyen Trial, Full y Rental.	Sí
startDate	datetime	Fecha en que el elemento comienza a ser válido.	Sí
estado	string	Estado del elemento. Entre los valores posibles se incluyen Active, Expired, Revoked y Banned.	Sí
etiquetas	list<string>	N/D	Sí
transactionId	guid	Identificador de transacción como resultado de la compra de este artículo. Se puede usar para notificar un elemento como cumplido.	Sí

El objeto IdentityContractV6 contiene los parámetros siguientes.

Parámetro	Tipo	Descripción	Obligatorio
identityType	string	Contiene el valor pub.	Sí
identityValue	string	Valor de cadena del publisherUserId de la clave de identificador de Microsoft Store especificada.	Sí

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Length: 7241
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: a9988cf9-652b-4791-beba-b0e732121a12
MS-CV: xu2HW6SrSkyfHyFh.0.1
MS-ServerId: 020022359
Date: Tue, 22 Sep 2015 20:28:18 GMT

{
  "items" : [
    {
      "acquiredDate" : "2015-09-22T19:22:51.2068724+00:00",
      "devOfferId" : "f9587c53-540a-498b-a281-8a349491ed47",
      "endDate" : "9999-12-31T23:59:59.9999999+00:00",
      "fulfillmentData" : [],
      "inAppOfferToken" : "consumable2",
      "itemId" : "4b8fbb13127a41f299270ea668681c1d",
      "localTicketReference" : "1055521810674918",
      "modifiedDate" : "2015-09-22T19:22:51.2513155+00:00",
      "orderId" : "4ba5960d-4ec6-4a81-ac20-aafce02ddf31",
      "ownershipType" : "OwnedByBeneficiary",
      "productId" : "9NBLGGH5WVP6",
      "productType" : "UnmanagedConsumable",
      "purchaser" : {
        "identityType" : "pub",
        "identityValue" : "user123"
      },
      "skuId" : "0010",
      "skuType" : "Full",
      "startDate" : "2015-09-22T19:22:51.2068724+00:00",
      "status" : "Active",
      "tags" : [],
      "transactionId" : "4ba5960d-4ec6-4a81-ac20-aafce02ddf31"
    }
  ]
}

Temas relacionados

• Administración de derechos de producto desde un servicio
• Notificar productos consumibles como cumplidos
• Concesión de productos gratuitos
• Renovación de una clave de identificador de Microsoft Store
• Biblioteca Microsoft.StoreServices (GitHub)