Ottenere i componenti aggiuntivi per un'app

  • Articolo

Usare questo metodo nell'API di invio di Microsoft Store per elencare i componenti aggiuntivi per un'app registrata nel proprio account del Centro per i partner.

Prerequisiti

Per usare questo metodo, è necessario prima eseguire le operazioni seguenti:

  • Se non lo si è ancora fatto, completare i prerequisiti per l'API di invio di Microsoft Store.
  • Ottenere un token di accesso di Azure AD da usare nell'intestazione della richiesta per questo metodo. Dopo aver ottenuto un token di accesso, questo sarà disponibile per 60 minuti prima della scadenza. Dopo la scadenza del token, è possibile ottenerne uno nuovo.

Richiesta

Questo metodo ha la sintassi seguente. Vedere le sezioni seguenti per esempi di uso e descrizioni dell'intestazione e del corpo della richiesta.

metodo URI della richiesta
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listinappproducts

Intestazione della richiesta

Intestazione Type Descrizione
Autorizzazione stringa Obbligatorio. Token di accesso di Azure AD nel formato Token di<connessione>.

Parametri della richiesta

Nome Tipo Descrizione Richiesto
applicationId string ID dello Store dell'app per cui si desidera recuperare i componenti aggiuntivi. Per ulteriori informazioni sull'ID dello Store, vedere Visualizzare i dettagli dell'identità dell'app. Sì
migliori int Numero di elementi da restituire nella richiesta (ossia il numero di componenti aggiuntivi da restituire). Se l'app ha un numero di componenti aggiuntivi maggiore del valore specificato nella query, il corpo della risposta includerà un percorso URI relativo che è possibile aggiungere all'URI del metodo per richiedere la pagina di dati successiva. No
skip int Numero di elementi da ignorare nella query prima di restituire gli elementi rimanenti. Usare questo parametro per scorrere i set di dati. Ad esempio, top=10 e skip=0 recupera gli elementi da 1 a 10, top=10 e skip=10 recupera gli elementi da 11 a 20 e così via. No

Corpo della richiesta

Non fornire un corpo della richiesta per questo metodo.

Esempi di richiesta

L'esempio seguente illustra come elencare tutti i componenti aggiuntivi per un'app.

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

L'esempio seguente illustra come elencare i primi 10 componenti aggiuntivi per un'app.

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

Response

L'esempio seguente illustra il corpo della risposta JSON restituito da una richiesta riuscita dei primi 10 componenti aggiuntivi per un'app che include un totale di 53 componenti aggiuntivi. Per brevità, questo esempio mostra solo i dati per i primi tre componenti aggiuntivi restituiti dalla richiesta. Per ulteriori dettagli sui valori nel corpo della risposta, vedere la sezione seguente.

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

Corpo della risposta

Valore Tipo Descrzione
@nextLink stringa Se sono presenti pagine aggiuntive di dati, questa stringa contiene un percorso relativo che è possibile aggiungere all'URI della richiesta https://manage.devcenter.microsoft.com/v1.0/my/ di base per richiedere la pagina di dati successiva. Ad esempio, se il parametro top del corpo della richiesta iniziale è impostato su 10 ma vi sono 50 componenti aggiuntivi per l'app, il corpo della risposta includerà un valore @nextLinkapplications/{applicationid}/listinappproducts/?skip=10&top=10 che indica che è possibile chiamare https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listinappproducts/?skip=10&top=10 per richiedere i successivi 10 componenti aggiuntivi.
value matrice Matrice di oggetti che elencano l'ID dello Store di ogni componente aggiuntivo per l'app specificata. Per ulteriori informazioni sui dati in ogni oggetto, vedere Risorsa del componente aggiuntivo.
totalCount int Numero totale di righe nel risultato dei dati per la query (ossia il numero totale di componenti aggiuntivi per l'app specificata).

Codici di errore

Se la richiesta non può essere completata, la risposta conterrà uno dei codici di errore HTTP seguenti.

Codice di errore Descrizione
404 Non sono stati trovati componenti aggiuntivi.
409 I componenti aggiuntivi usano funzionalità del Centro per i partner attualmente non supportate dall'API di invio di Microsoft Store.