Recuperare le conversioni dei componenti aggiuntivi per canale

Usare questo metodo nell'API di analisi di Microsoft Store per ottenere le conversioni aggregate per canale per un componente aggiuntivo durante un determinato intervallo di date e altri filtri opzionali.

  • Una conversione indica che un cliente (connesso con un account Microsoft) ha appena ottenuto una licenza per il componente aggiuntivo (a pagamento o gratuito).
  • Il canale è il metodo con cui un cliente ha raggiunto la pagina di presentazione dell'app (ad esempio, tramite lo Store o una campagna promozionale personalizzata dell'app).

Queste informazioni sono disponibili anche nel report sulle acquisizioni dei componenti aggiuntivi nel 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 analisi 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

Sintassi della richiesta

metodo URI della richiesta
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions

Intestazione della richiesta

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

Parametri della richiesta

Parametro Tipo Descrizione Richiesto
applicationId string ID dello Store dell'app per cui si desidera recuperare i dati sulle conversioni del componente aggiuntivo. Un esempio di ID dello Store è 9WZDNCRFJ3Q8.
inAppProductId string ID dello Store del componente aggiuntivo per cui si desidera recuperare i dati sulle conversioni.
startDate data Data di inizio nell'intervallo di date dei dati sulle conversioni da recuperare. Il valore predefinito è 1/1/2016. No
endDate data Data di fine nell'intervallo di date dei dati sulle conversioni da recuperare. L'impostazione predefinita è la data corrente. No
migliori int Numero di righe di dati da restituire nella richiesta. Il valore massimo e il valore predefinito, se non specificati, sono pari a 10000. Se nella query sono presenti più righe, il corpo della risposta includerà un collegamento che consente di richiedere la pagina successiva dei dati. No
skip int Numero di righe da ignorare nella query. Usare questo parametro per scorrere i set di dati di grandi dimensioni. Ad esempio, top=10000 e skip=0 recupera le prime 10.000 righe di dati, top=10000 e skip=10000 recupera le 10.000 righe di dati successive e così via. No
filter string Una o più istruzioni che filtrano il corpo della risposta. Ogni istruzione può usare gli operatori eq o ne e le istruzioni possono essere combinate mediante gli operatori and o or. È possibile specificare le stringhe seguenti nelle istruzioni di filtro. Per le descrizioni, vedere la sezione Valori delle conversioni in questo articolo.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

Di seguito è riportato un esempio di parametro filter: filter=deviceType eq 'PC'.

No
aggregationLevel string Specifica l'intervallo di tempo per il quale recuperare i dati aggregati. Può essere una delle stringhe seguenti: day, week o month. Se non è specificato, il valore predefinito è day. No
orderby string Istruzione che ordina i valori dei dati dei risultati per ogni conversione. La sintassi è orderby=field [order],field [order],.... Il parametro field può essere una delle stringhe seguenti:
  • date
  • applicationName
  • inAppProductName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

Il parametro order è facoltativo e può essere asc o desc per specificare l'ordine crescente o decrescente di ogni campo. Il valore predefinito è asc.

Di seguito è riportato un esempio di stringa orderby: orderby=date,market

No
groupby string Istruzione che applica l'aggregazione dei dati solo ai campi specificati. È possibile specificare i campi seguenti:

  • date
  • applicationName
  • inAppProductName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • market

Le righe di dati restituite conterranno i campi specificati nel parametro groupby e i seguenti:

  • date
  • applicationId
  • inAppProductId
  • inAppProductName
  • conversionCount
  • clickCount

Il parametro groupby può essere usato con il parametro aggregationLevel. Ad esempio: groupby=ageGroup,market&aggregationLevel=week

No

Esempio di richiesta

L'esempio seguente illustra diverse richieste di recupero dei dati sulle conversioni dell'app. Sostituire il valore applicationId con l'ID dello Store dell'app.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  HTTP/1.1
Authorization: Bearer <your access token>

Response

Corpo della risposta

Valore Tipo Descrizione
Valore matrice Matrice di oggetti che contengono dati sulle conversioni aggregati per il componente aggiuntivo. Per ulteriori informazioni sui dati in ogni oggetto, vedere la sezione Valori delle conversioni seguente.
@nextLink string Se vi sono ulteriori pagine di dati, la stringa conterrà un URI che è possibile usare per richiedere la pagina di dati successiva. Ad esempio, questo valore viene restituito se il parametro top della richiesta è impostato su 10 ma vi sono più di 10 righe di dati delle conversioni per la query.
TotalCount int Numero totale di righe nei risultati di dati per la query.

Valori delle conversioni

Gli oggetti nella matrice Value contengono i valori seguenti.

Valore Tipo Descrizione
data string Prima data dell'intervallo di date per i dati sulle conversioni. Se la richiesta ha specificato un singolo giorno, questo valore corrisponde alla data. Se la richiesta ha specificato una settimana, un mese o un altro intervallo di date, questo valore corrisponde alla prima data nell'intervallo di date.
inAppProductId string ID dello Store del componente aggiuntivo per cui si stanno recuperando i dati sulle conversioni.
inAppProductName string Nome visualizzato del componente aggiuntivo per cui si stanno recuperando i dati sulle conversioni.
applicationId string ID dello Store dell'app per cui si stanno recuperando i dati sulle conversioni.
applicationName string Nome visualizzato dell'app per cui si stanno recuperando i dati sulle conversioni.
appType string Tipo di prodotto per il quale si stanno recuperando i dati sulle conversioni. Per questo metodo, l'unico valore supportato è Add-On.
customCampaignId string Stringa ID per una campagna promozionale personalizzata per l'app associata all'app.
referrerUriDomain string Specifica il dominio in cui è stata attivata la presentazione dell'app con l'ID della campagna promozionale dell'app personalizzata.
channelType string Una delle stringhe seguenti che specifica il canale per la conversione:
  • CustomCampaignId
  • Store Traffic
  • Altro
storeClient string Versione dello Store in cui è stata effettuata la conversione. Al momento, l'unico valore supportato è SFC.
deviceType string Una delle stringhe seguenti:
  • PC
  • Telefono
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Unknown
market string Codice Paese ISO 3166 del mercato in cui è stata effettuata la conversione.
clickCount Numero Numero di clic dei clienti sul collegamento alla presentazione dell'app.
conversionCount Numero Numero di conversioni dei clienti.

Esempio di richiesta e risposta

I frammenti di codice seguenti illustrano alcune richieste di esempio e il corpo della risposta JSON per tali richieste.

Richiesta di esempio

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Risposta di esempio

{
    "Value": [
        {
            "inAppProductId": "9NN2HW33ZB2G",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 220636,
            "conversionCount": 154
        },
        {
            "inAppProductId": "9PN07J0WC18B",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 277061,
            "conversionCount": 187
        }
    ],
    "@nextLink": "",
    "TotalCount": 2
}

Richiesta di esempio

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>

Risposta di esempio

{
    "Value": [
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_mahjong_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "BR",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_solitaire_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "AT",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5Z",
            "inAppProductName": "Episode1Combo",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4Z",
            "inAppProductName": "Episode1Grandfathered",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "|autosuggest",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "ES",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5W",
            "inAppProductName": "Episode2Combo",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4P",
            "inAppProductName": "SeasonPass24",
            "appType": "Add-On",
            "date": "2022-07-12",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "9wzdncrfjbd8",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CA",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-07-17",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "scom-web-store",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "US",
            "clickCount": 1,
            "conversionCount": 1
        }
    ],
    "@nextLink": "",
    "TotalCount": 9
}