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.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Si el token expira, puedes obtener uno nuevo.

Solicitud

Este método tiene la siguiente sintaxis. Consulta las siguientes secciones para ver ejemplos de uso y descripciones tanto del encabezado como del 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
Authorization string Necesario. Token de acceso de Azure AD con el formato Token de portador<>.

Parámetros de solicitud

Nombre Tipo 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 detalles de identidad de las aplicaciones. Sí
top int El número de elementos que se devolverán en la solicitud (es decir, el número de complementos que se devolverán). Si los complementos de la aplicación superan el valor especificado en la consulta, el cuerpo de la respuesta incluye una ruta de acceso al URI relativa que puedes anexar al URI del método para solicitar la siguiente página de datos. No
skip int El número de elementos que se omitirán en la consulta antes de devolver los elementos restantes. Usa este parámetro para consultar conjuntos de datos. Por ejemplo, top = 10 y skip = 0 recuperan los elementos del 1 al 10, mientras que top = 10 y skip = 10 recuperan los elementos del 11 al 20, y así sucesivamente. No

Cuerpo de la solicitud

No incluyas un cuerpo de la solicitud para este método.

Ejemplos de solicitud

En el siguiente ejemplo 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 siguiente ejemplo se muestra cómo enumerar los 10 primeros 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>

Response

En el ejemplo siguiente se muestra el cuerpo de respuesta de JSON que devuelve una solicitud correcta para los 10 primeros complementos para una aplicación con un total de 53 complementos. Para mayor brevedad, en este ejemplo se muestran solo los datos de los tres primeros complementos que devuelve la solicitud. Para obtener más información acerca de los valores del cuerpo de respuesta, consulta la siguiente sección.

{
  "@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
}

Response body

Valor Tipo Descripción
@nextLink string Si hay páginas adicionales de datos, esta cadena contiene una ruta de acceso relativa que se puede anexar al URI de la solicitud de 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 se establece 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 Una matriz de objetos que enumera el Id. de la Tienda de cada complemento de la aplicación especificada. Para obtener más información sobre los datos de cada objeto, consulta Recurso de complemento.
totalCount int El número total de filas del resultado de datos de la consulta (es decir, el número total de complementos de 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 las características del Centro de partners que actualmente no son compatibles con la API de envío de Microsoft Store.