Recuperare le conversioni dei componenti aggiuntivi per canaleGet add-on conversions by channel

Usare questo metodo nell'API Microsoft Store Analytics per ottenere le conversioni di aggregazione in base al canale per un componente aggiuntivo durante un determinato intervallo di date e altri filtri facoltativi.Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an add-on during a given date range and other optional filters.

  • Una conversione significa che un cliente (connesso con una account Microsoft) ha appena ottenuto una licenza per il componente aggiuntivo (indipendentemente dal fatto che sia stato addebitato il denaro o che sia stato offerto gratuitamente).A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your add-on (whether you charged money or you've offered it for free).
  • Il canale è il metodo in cui un cliente è arrivato alla pagina di presentazione dell'app, ad esempio tramite lo Store o una campagna di promozione delle app personalizzata.The channel is the method in which a customer arrived at your app's listing page (for example, via the Store or a custom app promotion campaign).

Queste informazioni sono disponibili anche nel report acquisizioni componenti aggiuntivi nel centro per i partner.This information is also available in the Add-on acquisitions report in Partner Center.

PrerequisitiPrerequisites

Per usare questo metodo, devi prima eseguire le operazioni seguenti:To use this method, you need to first do the following:

  • Se non è già stato fatto, completare tutti i prerequisiti per l'API di analisi del Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Ottieni un token di accesso di Azure AD da usare nell'intestazione della richiesta per questo metodo.Obtain an Azure AD access token to use in the request header for this method. Dopo aver ottenuto un token di accesso, questo sarà disponibile per 60 minuti prima della scadenza.After you obtain an access token, you have 60 minutes to use it before it expires. Dopo la scadenza del token, puoi ottenerne uno nuovo.After the token expires, you can obtain a new one.

RichiestaRequest

Sintassi della richiestaRequest syntax

MetodoMethod URI richiestaRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions

Intestazione della richiestaRequest header

IntestazioneHeader TipoType DescrizioneDescription
AutorizzazioneAuthorization stringstring Obbligatorio.Required. Il token di accesso Azure ad nel token di connessione del modulo < token > .The Azure AD access token in the form Bearer <token>.

Parametri della richiestaRequest parameters

ParametroParameter TypeType DescriptionDescription ObbligatoriaRequired
applicationIdapplicationId stringstring ID dello Store dell'app per cui si desidera recuperare i dati di conversione del componente aggiuntivo.The Store ID of the app for which you want to retrieve add-on conversion data. Un esempio di ID dello Store è 9WZDNCRFJ3Q8.An example Store ID is 9WZDNCRFJ3Q8. Yes
inAppProductIdinAppProductId stringstring ID dello Store del componente aggiuntivo per il quale si desidera recuperare i dati di conversione.The Store ID of the add-on for which you want to retrieve conversion data. Yes
startDatestartDate datedate Data di inizio nell'intervallo di date dei dati di conversione da recuperare.The start date in the date range of conversion data to retrieve. Il valore predefinito è 1/1/2016.The default is 1/1/2016. NoNo
endDateendDate datedate Data di fine nell'intervallo di date dei dati di conversione da recuperare.The end date in the date range of conversion data to retrieve. L'impostazione predefinita è la data corrente.The default is the current date. NoNo
toptop intint Numero di righe di dati da restituire nella richiesta.The number of rows of data to return in the request. Il valore massimo e il valore predefinito se non specificato è 10000.The maximum value and the default value if not specified is 10000. Se nella query sono presenti più righe, il corpo della risposta include un link successivo che puoi usare per richiedere la pagina successiva dei dati.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NoNo
skipskip intint Numero di righe da ignorare nella query.The number of rows to skip in the query. Usa questo parametro per scorrere set di dati di grandi dimensioni.Use this parameter to page through large data sets. Ad esempio, top=10000 e skip=0 recupera le prime 10000 righe di dati, top=10000 e skip=10000 recupera le 10000 righe successive e così via.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NoNo
filterfilter stringstring Una o più istruzioni che filtrano il corpo della risposta.One or more statements that filter the response body. Ogni istruzione può usare l'operatore eq o ne e le istruzioni possono essere combinate con and o or.Each statement can use the eq or ne operators, and statements can be combined using and or or. Nelle istruzioni di filtro è possibile specificare le stringhe seguenti.You can specify the following strings in the filter statements. Per le descrizioni, vedere la sezione valori di conversione in questo articolo.For descriptions, see the conversion values section in this article.
  • applicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • mercatomarket

Ecco un parametro di filtro di esempio: Filter = DeviceType EQ ' PC '.Here is an example filter parameter: filter=deviceType eq 'PC'.

NoNo
aggregationLevelaggregationLevel stringstring Specifica l'intervallo di tempo per cui recuperare dati aggregati.Specifies the time range for which to retrieve aggregate data. Può essere una delle stringhe seguenti: day, week o month.Can be one of the following strings: day, week, or month. Se non viene specificato, il valore predefinito è day.If unspecified, the default is day. NoNo
orderbyorderby stringstring Istruzione che ordina i valori dei dati di risultato per ogni conversione.A statement that orders the result data values for each conversion. La sintassi è OrderBy = Field [Order], Field [Order],.... Il parametro Field può essere una delle seguenti stringhe:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • applicationNameapplicationName
  • inAppProductNameinAppProductName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • mercatomarket

Il parametro order è facoltativo e può essere asc o desc per specificare l’ordine crescente o decrescente per ogni campo.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Il valore predefinito è ASC.The default is asc.

Di seguito è riportato un esempio di stringa OrderBy : OrderBy = date, MarketHere is an example orderby string: orderby=date,market

NoNo
groupbygroupby stringstring Istruzione che applica l'aggregazione dei dati solo ai campi specificati.A statement that applies data aggregation only to the specified fields. Puoi specificare i campi seguenti:You can specify the following fields:

  • datedate
  • applicationNameapplicationName
  • inAppProductNameinAppProductName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • mercatomarket

Le righe di dati restituite conterranno i campi specificati nel parametro groupby, oltre ai seguenti:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • inAppProductIdinAppProductId
  • inAppProductNameinAppProductName
  • conversionCountconversionCount
  • clickCountclickCount

Il parametro groupby può essere usato con il parametro aggregationLevel.The groupby parameter can be used with the aggregationLevel parameter. Ad esempio: GroupBy = ageGroup, Market & aggregationLevel = weekFor example: groupby=ageGroup,market&aggregationLevel=week

NoNo

Esempio di richiestaRequest example

Nell'esempio seguente vengono illustrate diverse richieste per ottenere i dati di conversione delle app.The following example demonstrates several requests for getting app conversion data. Sostituisci il valore applicationId con l'ID dello Store per la tua app.Replace the applicationId value with the Store ID for your 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>

RispostaResponse

Corpo della rispostaResponse body

ValoreValue TipoType DescrizioneDescription
ValoreValue arrayarray Matrice di oggetti che contengono dati di conversione aggregati per il componente aggiuntivo.An array of objects that contain aggregate conversion data for the add-on. Per ulteriori informazioni sui dati in ogni oggetto, vedere la sezione valori di conversione riportata di seguito.For more information about the data in each object, see the conversion values section below.
@nextLink stringstring In presenza di altre pagine di dati, questa stringa contiene un URI che puoi usare per richiedere la pagina successiva dei dati.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Questo valore, ad esempio, viene restituito se il parametro Top della richiesta è impostato su 10, ma sono presenti più di 10 righe di dati di conversione per la query.For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of conversion data for the query.
TotalCountTotalCount intint Numero totale di righe nei dati risultanti dalla query.The total number of rows in the data result for the query.

Valori di conversioneConversion values

Gli oggetti nella matrice di valori contengono i valori seguenti.Objects in the Value array contain the following values.

ValoreValue TipoType DescrizioneDescription
datedate stringstring Prima data nell'intervallo di date per i dati di conversione.The first date in the date range for the conversion data. Se la richiesta specifica un singolo giorno, questo valore è la data.If the request specified a single day, this value is that date. Se la richiesta specifica una settimana, un mese o un altro intervallo di date, questo valore è la prima data in tale intervallo.If the request specified a week, month, or other date range, this value is the first date in that date range.
inAppProductIdinAppProductId stringstring ID dello Store del componente aggiuntivo per il quale si stanno recuperando i dati di conversione.The Store ID of the add-on for which you are retrieving conversion data.
inAppProductNameinAppProductName stringstring Nome visualizzato del componente aggiuntivo per il quale si desidera recuperare i dati di conversione.The display name of the add-on for which you are retrieving conversion data.
applicationIdapplicationId stringstring ID dello Store dell'app per cui si stanno recuperando i dati di conversione.The Store ID of the app for which you are retrieving conversion data.
applicationNameapplicationName stringstring Nome visualizzato dell'app per cui si stanno recuperando i dati di conversione.The display name of the app for which you are retrieving conversion data.
appTypeappType stringstring Tipo di prodotto per il quale si desidera recuperare i dati di conversione.The type of the product for which you are retrieving conversion data. Per questo metodo, l'unico valore supportato è componente aggiuntivo.For this method, the only supported value is Add-On.
customCampaignIdcustomCampaignId stringstring Stringa ID per una campagna di promozione delle app personalizzata associata all'app.The ID string for a custom app promotion campaign that is associated with the app.
referrerUriDomainreferrerUriDomain stringstring Specifica il dominio in cui è stata attivata l'inserzione dell'app con l'ID della campagna di promozione dell'app personalizzata.Specifies the domain where the app listing with the custom app promotion campaign ID was activated.
channelTypechannelType stringstring Una delle stringhe seguenti che specifica il canale per la conversione:One of the following strings that specifies the channel for the conversion:
  • CustomCampaignIdCustomCampaignId
  • Archiviare il trafficoStore Traffic
  • AltroOther
storeClientstoreClient stringstring Versione dell'archivio in cui si è verificata la conversione.The version of the Store where the conversion occurred. Attualmente, l'unico valore supportato è SFC.Currently, the only supported value is SFC.
deviceTypedeviceType stringstring Una delle stringhe seguenti:One of the following strings:
  • PCPC
  • PhonePhone
  • Console-Xbox OneConsole-Xbox One
  • Console-serie Xbox XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • UnknownUnknown
marketmarket stringstring Il codice paese ISO 3166 del mercato in cui si è verificata la conversione.The ISO 3166 country code of the market where the conversion occurred.
clickCountclickCount d'acquistonumber Il numero di clic del cliente sul collegamento all'elenco di app.The number of customer clicks on your app listing link.
conversionCountconversionCount d'acquistonumber Il numero di conversioni dei clienti.The number of customer conversions.

Esempio di rispostaResponse example

L'esempio seguente illustra un esempio di corpo della risposta JSON per questa richiesta.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2016-01-01",
      "inAppProductId": "9NBLGGH3LHKL",
      "inAppProductName": "Contoso Add-On",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "Add-On",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "CN",
      "clickCount": 1,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}