Compartir a través de

Obtener complementos para una aplicación

  • Artículo

Usa este método en la API de envío de Microsoft Store para enumerar los complementos de una aplicación registrada en tu cuenta del Centro de partners.

Requisitos previos

Para usar este método, primero debes hacer lo siguiente:

  • Si aún no lo ha hecho, complete todos los requisitos previos para la API de envío de Microsoft Store.
  • Consigue un token de acceso a Azure AD para utilizarlo en el encabezado de solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.

Solicitar

Este método tiene la sintaxis siguiente. Consulte las secciones siguientes para ver ejemplos de uso y descripciones del encabezado y el cuerpo de la solicitud.

Método URI de solicitud
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización string Necesario. Token de acceso de Azure AD con el formato Token<de portador>.

Parámetros de solicitud

Nombre Escribir Descripción Obligatorio
applicationId string El identificador de la Tienda de la aplicación para la que quieres recuperar los complementos. Para obtener más información sobre el identificador de la Tienda, consulta Ver los detalles de la identidad de la aplicación. Sí
superior int Número de elementos que se van a devolver en la solicitud (es decir, el número de complementos que se van a devolver). Si la aplicación tiene más complementos que el valor especificado en la consulta, el cuerpo de la respuesta incluye una ruta de acceso de URI relativa que puede anexar al URI del método para solicitar la siguiente página de datos. No
skip int Número de elementos que se van a omitir en la consulta antes de devolver los elementos restantes. Use este parámetro para paginar a través de conjuntos de datos. Por ejemplo, top=10 y skip=0 recupera los elementos del 1 al 10, top=10 y skip=10 recupera los elementos de 11 a 20, etc. No

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Ejemplos de solicitud

En el ejemplo siguiente se muestra cómo enumerar todos los complementos de una aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts HTTP/1.1
Authorization: Bearer <your access token>

En el ejemplo siguiente se muestra cómo enumerar los primeros 10 complementos de una aplicación.

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listinappproducts?top=10 HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

En el ejemplo siguiente se muestra el cuerpo de respuesta JSON devuelto por una solicitud correcta de los primeros 10 complementos para una aplicación con 53 complementos totales. Por motivos de brevedad, en este ejemplo solo se muestran los datos de los tres primeros complementos devueltos por la solicitud. Para obtener más información sobre los valores en el cuerpo de la respuesta, consulte la sección siguiente.

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

Cuerpo de la respuesta

Valor Tipo Description
@nextLink string Si hay páginas adicionales de datos, esta cadena contiene una ruta de acceso relativa que puede anexar al URI de solicitud base https://manage.devcenter.microsoft.com/v1.0/my/ para solicitar la siguiente página de datos. Por ejemplo, si el parámetro superior del cuerpo de la solicitud inicial está establecido en 10, pero hay 50 complementos para la aplicación, el cuerpo de la respuesta incluirá un @nextLink valor de applications/{applicationid}/listinappproducts/?skip=10&top=10, que indica que puede llamar https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 a para solicitar los 10 complementos siguientes.
value array Matriz de objetos que enumeran el identificador de la Tienda de cada complemento para la aplicación especificada. Para obtener más información sobre los datos de cada objeto, vea recurso de complemento.
totalCount int Número total de filas del resultado de los datos de la consulta (es decir, el número total de complementos para la aplicación especificada).

Códigos de error

Si la solicitud no se puede completar correctamente, la respuesta contendrá uno de los siguientes códigos de error HTTP.

Código de error Descripción
404 No se encontraron complementos.
409 Los complementos usan características del Centro de partners que actualmente no son compatibles con la API de envío de Microsoft Store.