Získejte data o akvizicích pro vaše hry a aplikace

Tuto metodu použijte v rozhraní API pro analýzu Microsoft Storu ke získání agregovaných akvizičních dat ve formátu JSON pro aplikace UWP a hry pro Xbox One, které byly přijaty prostřednictvím portálu pro vývojáře Xboxu (XDP) a jsou dostupné na řídicím panelu XDP Analytics.

Poznámka:

Toto rozhraní API neposkytuje denní agregovaná data před 1. říjnem 2016.

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 předpoklady pro Microsoft Store Analytics API.
  • 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

Syntaxe požadavku

Metoda Požadavek na URI
ZÍSKAT https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions

Hlavička požadavku

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

Parametry požadavku

Parametr Typ Popis Povinné
ID aplikace řetězec ID produktu hry pro Xbox One, pro kterou načítáte data o získání. Pokud chcete získat ID produktu vaší hry, přejděte do hry v programu XDP Analytics a načtěte ID produktu z adresy URL. Alternativně, pokud si stáhnete data o akvizicích ze sestavy analýz Partner Center, ID produktu bude zahrnuto v souboru .tsv. Ano
Datum zahájení datum Počáteční datum v rozsahu dat pořízení, které se mají načíst. Výchozí hodnota je aktuální datum. Ne
datum ukončení datum Koncové datum v časovém období dat pořízení, které se mají získat. Výchozí hodnota je aktuální datum. Ne
filtr řetězec Jeden nebo více příkazů, které filtrují řádky v odpovědi. Každý příkaz obsahuje název pole z textu odpovědi a hodnotu, která je přidružena k operátorům eq nebo ne, a příkazy lze kombinovat pomocí a nebo nebo. Řetězcové hodnoty musí být v parametru filtru ohraničené jednoduchými uvozovkami. Například filtr=trh eq 'US' a pohlaví eq 'm'.
V textu odpovědi můžete zadat následující pole:
  • typ akvizice
  • věk
  • obchodníKlient
  • pohlaví
  • trh
  • verze operačního systému
  • typ zařízení
  • id_pískoviště
 Ne
úroveň agregace řetězec Určuje časový rozsah, pro který se mají načítat agregovaná data. Může to být jeden z následujících řetězců: den, týdennebo měsíc. Pokud není zadáno, výchozí hodnota je . Ne
seřadit podle řetězec Příkaz, který objedná výsledné datové hodnoty pro každou akvizici. Syntax vypadá takto: orderby=field [order],field [order],... Parametr pole může být jedním z následujících řetězců:
  • datum
  • typ akvizice
  • věk
  • obchodníKlient
  • pohlaví
  • trh
  • verze operačního systému
  • typ zařízení
  • Typ platebního nástroje
  • id_pískoviště
  • xboxTitleId
Parametr pořadí je volitelný a může být nastaven na asc nebo desc, aby určoval vzestupné nebo sestupné pořadí pro každé pole. Výchozí hodnota je asc. Tady je příklad řetězce orderby: orderby=datum,trh		 Ne
skupinování řetězec Příkaz, který použije agregaci dat pouze na zadaná pole. Můžete zadat následující pole:
  • datum
  • název aplikace
  • typ akvizice
  • věk
  • obchodníKlient
  • pohlaví
  • trh
  • verze operačního systému
  • typ zařízení
  • Typ platebního nástroje
  • id_pískoviště
  • xboxTitleId
Vrácené datové řádky budou obsahovat pole zadaná v parametru groupby a také následující:
  • datum
  • identifikátor aplikace
  • množstvíAkvizice
Parametr groupby lze použít s parametrem aggregationLevel. Příklad: &groupby=age,market&aggregationLevel=week		 Ne

Požadavek příkladu

Následující příklad ukazuje několik žádostí o získání dat o získávání her z Xboxu One. Nahraďte hodnotu applicationId za ID produktu pro vaši hru.

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/acquisitions?applicationId=9WZDNCRFHXHT&startDate=1/1/2017&endDate=2/1/2019&skip=0&filter=market eq 'US' and gender eq 'm' HTTP/1.1 
Authorization: Bearer <your access token>

Odezva

Obsah odpovědi

Hodnota Typ Popis
Hodnota pole Pole objektů, které obsahují agregovaná data získávání pro hru. Pro více informací o datech v každém objektu, viz níže uvedenou sekci akviziční hodnoty.
Celkový počet celočíselný Celkový počet řádků ve výsledku dat dotazu.

Pořizovací hodnoty

Prvky v poli Hodnota obsahují následující hodnoty.

Hodnota Typ Popis
datum řetězec První datum v časovém rozmezí pro data o akvizici. Pokud je v požadavku uveden jeden den, je tato hodnota tímto datem. Pokud požadavek zadal týden, měsíc nebo jiný rozsah kalendářních dat, je tato hodnota prvním datem v daném rozsahu dat.
ID aplikace řetězec ID produktu hry pro Xbox One, pro kterou načítáte data o získání.
název aplikace řetězec Zobrazovaný název hry.
typ akvizice řetězec Jeden z následujících řetězců, který označuje typ získání:
  • Bezplatné
  • Zkušební verze
  • zaplaceno
  • propagační kód
  • IAP
  • Předplatné Iap
  • soukromé publikum
  • předběžná objednávka
  • Xbox Game Pass (nebo Game Pass při dotazování na data před 23. březnem 2018)
  • Disk
  • Předplacený kód
  • Předobjednávka s platbou předem
  • Zrušená předobjednávka
  • Neúspěšná předobjednávka
věk řetězec Jeden z následujících řetězců označuje věkovou skupinu uživatele, který provedl pořízení.
  • méně než 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • větší než 55
  • Neznámý
typ zařízení řetězec Jeden z následujících řetězců, který specifikuje typ zařízení, které dokončilo akvizici.
  • Osobní počítač
  • Telefon
  • Console-Xbox One
  • Console-Xbox série X
  • Iot
  • Server
  • Tableta
  • Holografický
  • Neznámý
pohlaví řetězec Jeden z následujících řetězců, který určuje pohlaví uživatele, který provedl akvizici:
  • m
  • f
  • Neznámý
trh řetězec Kód země ISO 3166 trhu, kde došlo k pořízení.
osVersion řetězec Verze operačního systému, na které došlo k akvizici. Pro tuto metodu je tato hodnota vždy Windows 10 nebo Windows 11.
typ platebního nástroje řetězec Jedna z následujících řetězců, která označuje pokyn k platbě použitý pro akvizici:
  • kreditní karta
  • karta pro inkaso
  • Odvozený nákup
  • MS Rovnováha
  • mobilní operátor
  • online bankovní převod
  • PayPal
  • Rozdělení transakce
  • Uplatnění Tokenu
  • Nulová částka zaplacena
  • eWallet
  • Neznámý
sandboxId řetězec ID sandboxu vytvořené pro hru. Může to být hodnota RETAIL nebo id privátního sandboxu.
Klient obchodu řetězec Jeden z následujících řetězců, který označuje verzi obchodu, ve kterém došlo k transakci:
  • Windows Phone Store (klient)
  • Microsoft Store (klient) (nebo Windows Store (klient), pokud se dotazuje na data před 23. březnem 2018)
  • Microsoft Store (web) (nebo Windows Store (web) při dotazování na data před 23. březnem 2018)
  • Hromadný nákup organizací
  • Jiný
xboxTitleId řetězec ID názvu služby Xbox Live (reprezentované v šestnáctkové hodnotě) přiřazené portálem pro vývojáře xboxu (XDP) pro hry s podporou služby Xbox Live.
množství akvizice číslo Počet pořízení, ke kterým došlo během zadané úrovně agregace.
částka nákupní ceny v USD číslo Částka zaplacená zákazníkem za pořízení převedená na USD pomocí měsíčního směnného kurzu.
částka daně z nákupu v USD číslo Částka daně uplatněná na pořízení převedená na USD.
kód místní měny řetězec Kód místní měny založený na zemi nebo oblasti účtu Partnerského centra.
ID Produktu Xbox řetězec ID produktu Xbox z XDP, pokud je to možné.
ID dostupnosti řetězec ID dostupnosti produktu z XDP, pokud je k dispozici.
ID skladové jednotky řetězec ID skladové položky produktu z XDP, pokud je k dispozici.
skuDisplayName řetězec Zobrazený název SKU produktu z XDP, pokud je k dispozici.
xboxParentProductId řetězec ID nadřazeného produktu Xbox od XDP( pokud je to možné).
název mateřského produktu řetězec Nadřazený název produktu z XDP, pokud je k dispozici.
názevTypuProduktu řetězec Název typu produktu z XDP, pokud je k dispozici.
typ daně z nákupu řetězec Typ daně nákupu produktu od XDP, pokud je to možné.
nákupní cena v místní měně číslo Místní cena nákupu produktu od XDP, pokud je k dispozici.
částka místní daně z nákupu číslo Místní daňová částka produktu od XDP, pokud je to relevantní.

Příklad odpovědi

Následující příklad ukazuje příklad textu odpovědi JSON pro tento požadavek.

{ 
    "Value": [ 
        { 
            "date": "2019-01-15T01:00:00.0000000Z", 
            "applicationId": "9WZDNCRFHXHT", 
            "applicationName": null, 
            "acquisitionType": "Paid", 
            "age": null, 
            "deviceType": "Phone", 
            "gender": null, 
            "market": "US", 
            "osVersion": "Windows 11", 
            "paymentInstrumentType": null, 
            "sandboxId": "RETAIL", 
            "storeClient": "Microsoft Store (client)", 
            "xboxTitleId": null, 
            "localCurrencyCode": "USD", 
            "xboxProductId": null, 
            "availabilityId": "B42LRTSZ2MCJ", 
            "skuId": "0010", 
            "skuDisplayName": null, 
            "xboxParentProductId": null, 
            "parentProductName": null, 
            "productTypeName": "Game", 
            "purchaseTaxType": "TaxesNotIncluded", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 3.08, 
            "purchasePriceLocalAmount": 3.08, 
            "purchaseTaxUSDAmount": 0.09, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null,
    
    "TotalCount": 12221 
}

 

  • Last updated on