Sdílet prostřednictvím

Získejte všechny doplňky

Tuto metodu použijte v rozhraní API pro odesílání z Microsoft Storu k načtení dat pro všechny doplňky pro všechny aplikace zaregistrované ve vašem účtu Partnerského centra.

Požadavky

Pokud chcete použít tuto metodu, musíte nejprve provést následující:

  • Pokud jste to ještě neudělali, splňte všechny nezbytné předpoklady pro API pro odesílání do Microsoft Storu.
  • Získejte přístupový token Azure AD a použijte ho v hlavičce požadavku pro tuto metodu. Po získání přístupového tokenu ho budete mít 60 minut, než vyprší jeho platnost. Po vypršení platnosti tokenu můžete získat nový.

Žádost

Tato metoda má následující syntaxi. Příklady použití a popisy hlavičky a textu požadavku najdete v následujících částech.

Metoda Požadavek na URI
získej https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

Hlavička požadavku

Záhlaví Typ Popis
Autorizace řetězec Povinné. Přístupový token Azure AD ve formátu Bearer<token>.

Parametry požadavku

Všechny parametry požadavku jsou pro tuto metodu volitelné. Pokud tuto metodu zavoláte bez parametrů, odpověď obsahuje data pro všechny doplňky pro všechny aplikace zaregistrované ve vašem účtu.

Parametr Typ Popis Povinné
vrchol int (integer) Počet položek, které se mají vrátit v požadavku (to znamená počet doplňků, které se mají vrátit). Pokud má váš účet více doplňků, než je hodnota zadaná v dotazu, text odpovědi obsahuje relativní cestu URI, kterou můžete připojit k identifikátoru URI metody a požádat o další stránku dat. Ne
přeskočit int (integer) Počet položek, které mají být v dotazu přeskočeny před vrácením zbývajících položek. Pomocí tohoto parametru můžete stránkovat datové sady. Například top=10 a skip=0 načte položky 1 až 10, top=10 a skip=10 načte položky 11 až 20 atd. Ne

Obsah požadavku

Pro tuto metodu nezadádejte text požadavku.

Žádejte příklady

Následující příklad ukazuje, jak načíst všechna doplňková data pro všechny aplikace zaregistrované ve vašem účtu.

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

Následující příklad ukazuje, jak načíst pouze prvních 10 doplňků.

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

Odezva

Následující příklad ukazuje text odpovědi JSON vrácený úspěšným požadavkem na prvních 5 doplňků, které jsou zaregistrované na vývojářském účtu s celkovým počtem doplňků 1072. Pro stručnost tento příklad ukazuje pouze data prvních dvou doplňků vrácených požadavkem. Další podrobnosti o hodnotách v textu odpovědi najdete v následující části.

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

Obsah odpovědi

Hodnota Typ Popis
@nextLink řetězec Pokud existují další stránky dat, tento řetězec obsahuje relativní cestu, kterou můžete připojit k URI základní https://manage.devcenter.microsoft.com/v1.0/my/ žádosti, abyste vyžádali další stránku dat. Pokud je například parametr top textu počátečního požadavku nastavený na 10, ale pro váš účet je zaregistrovaných 100 doplňků, text odpovědi bude obsahovat @nextLink hodnotu inappproducts?skip=10&top=10, což znamená, že můžete volat https://manage.devcenter.microsoft.com/v1.0/my/inappproducts?skip=10&top=10 a požádat o další 10 doplňků.
hodnota pole Pole obsahující objekty, které poskytují informace o každém doplňku. Další informace najdete v tématu doplněk.
celkový počet int (integer) Počet objektů aplikace v hodnotě pole textu odpovědi.

Kódy chyb

Pokud požadavek nelze úspěšně dokončit, odpověď bude obsahovat jeden z následujících kódů chyb HTTP.

Kód chyby Popis
404 Nebyly nalezeny žádné doplňky.
409 Aplikace nebo doplňky používají funkce Partnerského centra, které aktuálně nepodporuje rozhraní API pro odesílání z Microsoft Storu.
  • Last updated on