Obter todos os complementos

  • Artigo

Use esse método na API de envio da Microsoft Store para recuperar dados de todos os complementos para todos os aplicativos registrados em sua conta do Partner Center.

Pré-requisitos

Para usar este método, primeiro você precisa do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.

Solicitação

Esse método tem a seguinte sintaxe. Veja as seções a seguir para obter exemplos de uso e descrições do corpo da solicitação e do cabeçalho.

Método URI da solicitação
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< do formulário.

Parâmetros da solicitação

Todos os parâmetros de solicitação são opcionais para esse método. Se você chamar esse método sem parâmetros, a resposta conterá dados para todos os complementos de todos os aplicativos que estão registrados em sua conta.

Parâmetro Type Descrição Obrigatório
top INT O número de itens a serem retornados na solicitação (ou seja, o número de complementos a serem retornados). Se sua conta tiver mais complementos que o valor especificado na consulta, o corpo da resposta incluirá um caminho relativo do URI que você pode acrescentar ao URI do método para solicitar a próxima página de dados. Não
skip INT O número de itens a serem ignorados na consulta antes de retornar os itens restantes. Use este parâmetro para percorrer conjuntos de dados. Por exemplo, top=10 e skip=0 recuperam os itens de 1 a 10, top=10 e skip=10 recuperam os itens de 11 a 20 e assim por diante. Não

Corpo da solicitação

Não forneça um corpo da solicitação para esse método.

Exemplos de solicitação

O exemplo a seguir demonstra como recuperar todos os dados de complemento de todos os aplicativos que estão registrados em sua conta.

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

O exemplo a seguir demonstra como recuperar somente os 10 primeiros complementos.

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

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON retornado por uma solicitação bem-sucedida para os 5 primeiros complementos que são registrados para uma conta de desenvolvedor com 1072 complementos no total. Para abreviar, este exemplo mostra apenas os dados dos dois primeiros complementos retornados pela solicitação. Para obter mais detalhes sobre os valores no corpo da resposta, veja a seção a seguir.

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

Corpo da resposta

Valor Type Descrição
@nextLink string Se houver páginas adicionais de dados, essa cadeia de caracteres terá um caminho relativo que você pode acrescentar ao URI básico da solicitação https://manage.devcenter.microsoft.com/v1.0/my/ para solicitar a próxima página de dados. Por exemplo, se o parâmetro top do corpo da solicitação inicial for definido como 10, mas houver 100 complementos registrados em sua conta, o corpo da resposta incluirá um valor @nextLink de inappproducts?skip=10&top=10, o que indica que você pode chamar https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 para solicitar os próximos 10 complementos.
value array Uma matriz que contém objetos que fornecem informações sobre cada complemento. Para saber mais, veja recurso de complemento.
totalCount INT O número de objetos de aplicativo na matriz value do corpo da resposta.

Códigos do Erro

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro Descrição
404 Nenhum complemento foi encontrado.
409 Os aplicativos ou complementos usam recursos do Partner Center que atualmente não são compatíveis com a API de envio da Microsoft Store.