Obtención de todos los complementosGet all add-ons

Utilice este método en la API de envío de Microsoft Store para recuperar datos para todos los complementos para todas las aplicaciones que están registrados en su cuenta del centro de partners.Use this method in the Microsoft Store submission API to retrieve data for all add-ons for all the apps that are registered to your Partner Center account.

Requisitos previosPrerequisites

Para usar este método, primero debes hacer lo siguiente:To use this method, you need to first do the following:

  • Si aún no lo has hecho, completa todos los requisitos previos para la API de envío de Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método.Obtain an Azure AD access token to use in the request header for this method. Después de obtener un token de acceso, tienes 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Este método tiene la siguiente sintaxis.This method has the following syntax. Consulta las siguientes secciones para ver ejemplos de uso y descripciones tanto del encabezado como del cuerpo de la solicitud.See the following sections for usage examples and descriptions of the header and request body.

MétodoMethod URI de la solicitudRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

Encabezado de la solicitudRequest header

HeaderHeader TipoType DescripciónDescription
AutorizaciónAuthorization stringstring Obligatorio.Required. El token de acceso de Azure AD en el formulario portador < token>.The Azure AD access token in the form Bearer <token>.

Parámetros de solicitudRequest parameters

Todos los parámetros de solicitud son opcionales para este método.All request parameters are optional for this method. Si llamas a este método sin parámetros, la respuesta contiene datos de todos los complementos de todas las aplicaciones registradas en tu cuenta.If you call this method without parameters, the response contains data for all add-ons for all apps that are registered to your account.

ParámetroParameter TipoType DescripciónDescription RequeridoRequired
toptop enteroint El número de elementos que se devolverán en la solicitud (es decir, el número de complementos que se devolverán).The number of items to return in the request (that is, the number of add-ons to return). Si los complementos de la cuenta 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.If your account has more add-ons than the value you specify in the query, the response body includes a relative URI path that you can append to the method URI to request the next page of data. NoNo
skipskip enteroint El número de elementos que se omitirán en la consulta antes de devolver los elementos restantes.The number of items to bypass in the query before returning the remaining items. Usa este parámetro para consultar conjuntos de datos.Use this parameter to page through data sets. 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.For example, top=10 and skip=0 retrieves items 1 through 10, top=10 and skip=10 retrieves items 11 through 20, and so on. NoNo

Cuerpo de la solicitudRequest body

No incluyas un cuerpo de la solicitud para este método.Do not provide a request body for this method.

Ejemplos de solicitudRequest examples

En el siguiente ejemplo se muestra cómo recuperar los datos de todos los complementos de todas las aplicaciones registradas en tu cuenta.The following example demonstrates how to retrieve all add-on data for all the apps that are registered to your account.

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

En el siguiente ejemplo se muestra cómo recuperar solo los 10 primeros complementos.The following example demonstrates how to retrieve the first 10 add-ons only.

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

RespuestaResponse

En el siguiente ejemplo se muestra el cuerpo de respuesta JSON que devuelve una solicitud correcta para los cinco primeros complementos registrados en una cuenta de desarrollador con un total de 1072 complementos.The following example demonstrates the JSON response body returned by a successful request for the first 5 add-ons that are registered to a developer account with 1072 total add-ons. Para mayor brevedad, en este ejemplo se muestran solo los datos de los dos primeros complementos que devuelve la solicitud.For brevity, this example only shows the data for the first two add-ons returned by the request. Para obtener más información acerca de los valores del cuerpo de respuesta, consulta la siguiente sección.For more details about the values in the response body, see the following section.

{
  "@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 respuestaResponse body

ValorValue TipoType DescripciónDescription
@nextLink stringstring 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.If there are additional pages of data, this string contains a relative path that you can append to the base https://manage.devcenter.microsoft.com/v1.0/my/ request URI to request the next page of data. Por ejemplo, si el parámetro top del cuerpo de la solicitud inicial se establece en 10, pero hay 100 complementos registrados en la cuenta, el cuerpo de la respuesta incluirá un valor @nextLink de inappproducts?skip=10&top=10, lo que indica que puedes llamar a https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 para solicitar los 10 complementos siguientes.For example, if the top parameter of the initial request body is set to 10 but there are 100 add-ons registered to your account, the response body will include a @nextLink value of inappproducts?skip=10&top=10, which indicates that you can call https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 to request the next 10 add-ons.
valuevalue arrayarray Una matriz que contiene objetos que proporcionan información sobre cada complemento.An array that contains objects that provide information about each add-on. Para obtener más información, consulta Recurso de complemento.For more information, see add-on resource.
totalCounttotalCount enteroint Número de objetos de la aplicación en la matriz value del cuerpo de la respuesta.The number of app objects in the value array of the response body.

Códigos de errorError codes

Si la solicitud no se puede completar correctamente, la respuesta contendrá uno de los siguientes códigos de error HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Código de errorError code DescripciónDescription
404404 No se encontraron complementos.No add-ons were found.
409409 Las aplicaciones o complementos usan características de centro de partners que están no compatible actualmente con la API de envío de Microsoft Store.The apps or add-ons use Partner Center features that are currently not supported by the Microsoft Store submission API.