Compartir a través de

Obtención de todos los complementos

  • Artículo

Usa este método en la API de envío de Microsoft Store para recuperar datos de todos los complementos para todas las aplicaciones registradas 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/inappproducts

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

Todos los parámetros de solicitud son opcionales para este método. Si llama a este método sin parámetros, la respuesta contiene datos de todos los complementos para todas las aplicaciones registradas en su cuenta.

Parámetro Tipo Descripción Obligatorio
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 cuenta 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 recuperar todos los datos del complemento para todas las aplicaciones registradas en su cuenta.

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

En el ejemplo siguiente se muestra cómo recuperar solo los primeros 10 complementos.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?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 5 complementos registrados en una cuenta de desarrollador con 1072 complementos totales. Por motivos de brevedad, en este ejemplo solo se muestran los datos de los dos 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": "inappproducts/?skip=5&top=5",
  "value": [
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMP",
      "productId": "a8b8310b-fa8d-4da0-aca0-577ef6dce4dd",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243619",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243705",
        "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
      }
    },
    {
      "applications": {
        "value": [
          {
            "id": "9NBLGGH4R315",
            "resourceLocation": "applications/9NBLGGH4R315"
          }
        ],
        "totalCount": 1
      },
      "id": "9NBLGGH4TNMN",
      "productId": "6a3c9788-a350-448a-bd32-16160a13018a",
      "productType": "Consumable",
      "pendingInAppProductSubmission": {
        "id": "1152921504621243538",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243538"
      },
      "lastPublishedInAppProductSubmission": {
        "id": "1152921504621243106",
        "resourceLocation": "inappproducts/9NBLGGH4TNMN/submissions/1152921504621243106"
      }
    },

  // Other add-ons omitted for brevity...
  ],
  "totalCount": 1072
}

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 100 complementos registrados en su cuenta, el cuerpo de la respuesta incluirá un @nextLink valor de inappproducts?skip=10&top=10, que indica que puede llamar https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 a para solicitar los 10 complementos siguientes.
value array Matriz que contiene objetos que proporcionan información sobre cada complemento. Para obtener más información, consulte recurso de complemento.
totalCount int Número de objetos de aplicación en la matriz de valores del cuerpo de la respuesta.

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 Las aplicaciones o complementos usan características del Centro de partners que actualmente no son compatibles con la API de envío de Microsoft Store.