Udostępnij przez


Pozyskiwanie dodatków

Aby uzyskać zagregowane dane dotyczące pozyskiwania dodatków do swojej aplikacji w formacie JSON w określonym zakresie dat i z opcjonalnymi filtrami, użyj tej metody w interfejsie API analizy sklepu Microsoft Store. Te informacje są również dostępne w raporcie dotyczącym pozyskiwania dodatków w Centrum partnerskim.

Wymagania wstępne

Aby użyć tej metody, należy najpierw wykonać następujące czynności:

  • Jeśli jeszcze tego nie zrobiłeś, wykonaj wszystkie wymagania wstępne i dla API analizy Microsoft Store.
  • Uzyskaj token dostępu usługi Azure AD do użycia w nagłówku żądania dla tej metody. Po uzyskaniu tokenu dostępu należy 60 minut używać go przed jego wygaśnięciem. Po wygaśnięciu tokenu można uzyskać nowy.

Żądanie

Składnia żądania

Metoda Żądanie URI
POBIERZ https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions

Nagłówek żądania

Nagłówek Typ Opis
Autoryzacja sznurek To jest wymagane. Token dostępu usługi Azure AD w postaci tokenu typu Bearer <>.

Parametry żądania

Wymagany jest parametr applicationId lub inAppProductId. Aby pobrać dane pozyskiwania dla wszystkich dodatków zarejestrowanych w aplikacji, określ parametr applicationId. Aby pobrać dane pozyskiwania dla pojedynczego dodatku, określ parametr inAppProductId. Jeśli określisz oba parametry, to parametr applicationId zostanie zignorowany.

Parametr Typ Opis Wymagane
applicationId (identyfikator aplikacji) sznurek Identyfikator sklepu aplikacji, dla której chcesz pobrać dane pozyskiwania dodatku. Tak
IdentyfikatorProduktuAplikacji sznurek Identyfikator magazynu dodatku, dla którego chcesz pobrać dane pozyskiwania. Tak
data rozpoczęcia termin Data początkowa w zakresie dat dotyczących pobierania danych o nabyciu dodatku. Wartość domyślna to bieżąca data. Nie.
data zakończenia termin Data końcowa w zakresie dat danych o nabyciu dodatku do pobrania. Wartość domyślna to bieżąca data. Nie.
Do góry int (integer) Liczba wierszy danych, które należy zwrócić w żądaniu. Wartość maksymalna i wartość domyślna, jeśli nie zostanie określona, to 10000. Jeśli w zapytaniu znajduje się więcej wierszy, treść odpowiedzi zawiera następny link, którego można użyć do żądania następnej strony danych. Nie.
pominąć int (integer) Liczba wierszy do pominięcia w zapytaniu. Użyj tego parametru, aby przeglądać duże zestawy danych. Na przykład top=10000 i skip=0 pobiera pierwsze 10000 wierszy danych, top=10000 i skip=10000 pobiera następne 10000 wierszy danych itd. Nie.
filtr sznurek Jedno lub więcej wyrażeń, które filtrują wiersze w odpowiedzi. Aby uzyskać więcej informacji, zobacz sekcję pól filtru poniżej. Nie.
poziom agregacji sznurek Określa zakres czasu, dla którego mają być pobierane agregowane dane. Może być jednym z następujących ciągów: dzień, tydzień lub miesiąc. Jeśli jest to nieokreślone, wartość domyślna to dzień. Nie.
sortowanie według sznurek Instrukcja, która porządkuje wartości danych wyników dla każdego nabycia dodatku. Składnia to orderby=field [order],field [order],.... Parametr field może być jednym z następujących ciągów:
  • daty
  • typ nabycia
  • grupa wiekowa
  • klient sklepu
  • płeć
  • rynek
  • wersja systemu operacyjnego
  • typ urządzenia
  • nazwa_zamówienia

Parametr order jest opcjonalny i może być asc lub desc w celu określenia kolejności rosnącej lub malejącej dla każdego pola. Wartość domyślna to asc.

Oto przykładowy ciąg orderby: orderby=date,market

Nie.
metoda grupowania sznurek Instrukcja, która stosuje agregację danych tylko do określonych pól. Możesz określić następujące pola:
  • daty
  • applicationName (nazwa_aplikacji)
  • inAppProductName (nazwa_produktu)
  • typ nabycia
  • grupa wiekowa
  • klient sklepu
  • płeć
  • rynek
  • wersja systemu operacyjnego
  • typ urządzenia
  • nazwa_zamówienia

Zwrócone wiersze danych będą zawierać pola określone w parametrze groupby , a także następujące:

  • daty
  • applicationId (identyfikator aplikacji)
  • inAppProductId
  • ilość nabycia

Parametr groupby może być używany z parametrem aggregationLevel . Na przykład: &groupby=ageGroup,market&aggregationLevel=week

Nie.

Filtrowanie pól

Parametr filtru w żądaniu zawiera jedną lub więcej instrukcji filtrujących wiersze w odpowiedzi. Każde wyrażenie zawiera pole i wartość, które są powiązane z operatorami eq lub ne, a wyrażenia mogą być łączone za pomocą i albo lub. Oto kilka przykładowych parametrów filtru:

  • filter=market eq "US" i gender eq "m"
  • filter=(market != "US") i (płeć != "nieznana") i (płeć != "m") i (market != "NO") i (ageGroup != "więcej niż 55" i ageGroup != "mniej niż 13")

Aby uzyskać listę obsługiwanych pól, zobacz poniższą tabelę. Wartości ciągu muszą być otoczone pojedynczymi cudzysłowami w parametrze filtru .

Pola formularza Opis
typ nabycia Jeden z następujących ciągów:
  • bezpłatne
  • wersji próbnej
  • płatne
  • kod promocyjny
  • Iap (Biblioteka IA
grupa wiekowa Jeden z następujących ciągów:
  • mniejsze niż 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • większe niż 55
  • Nieznane
klient sklepu Jeden z następujących ciągów:
  • Sklep Windows Phone (aplikacja kliencka)
  • Microsoft Store (klienta)
  • Microsoft Store (internet)
  • Zakupy hurtowe przez organizacje
  • Inne
płeć Jeden z następujących ciągów:
  • m
  • f
  • Nieznane
rynek Ciąg zawierający kod kraju ISO 3166 rynku, na którym miało miejsce nabycie.
Wersja systemu operacyjnego Jeden z następujących ciągów:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Telefon z systemem Windows Phone 10
  • Okna 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Nieznane
typ urządzenia Jeden z następujących ciągów:
  • Komputer osobisty
  • Telefon
  • Console-Xbox jeden
  • SeriaConsole-Xbox X
  • Iot
  • Holograficzne
  • Nieznane
nazwaZamówienia Ciąg określający nazwę zamówienia dla kodu promocyjnego, który został użyty do uzyskania dodatku (ma to zastosowanie tylko wtedy, gdy użytkownik nabył dodatek, zrealizowając kod promocyjny).

Przykład zapytania

W poniższych przykładach przedstawiono kilka żądań dotyczących uzyskiwania danych o nabyciu dodatków. Zastąp wartości inAppProductId i applicationId odpowiednim identyfikatorem sklepu dla Twojego dodatku lub aplikacji.

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

Ciało odpowiedzi

Wartość Typ Opis
Wartość układ Tablica obiektów zawierających zagregowane dane dotyczące nabywania rozszerzeń. Aby uzyskać więcej informacji na temat danych w każdym obiekcie, zobacz sekcję wartości dodane przy zakupie poniżej.
@nextLink sznurek Jeśli istnieją dodatkowe strony danych, ten ciąg zawiera identyfikator URI, którego można użyć do żądania następnej strony danych. Na przykład ta wartość jest zwracana, jeśli parametr górny żądania jest ustawiony na 10000, ale dla zapytania istnieje więcej niż 10000 wierszy danych dotyczących nabycia dodatków.
Łączna liczba int (integer) Całkowita liczba wierszy w wyniku danych dla zapytania.

Wartości nabycia dodatków

Elementy w tablicy Value zawierają następujące wartości.

Wartość Typ Opis
termin sznurek Pierwsza data w zakresie dat dotyczących pozyskania danych. Jeśli żądanie określiło jeden dzień, ta wartość to ta data. Jeśli w żądaniu określono tydzień, miesiąc lub inny zakres dat, ta wartość jest pierwszą datą w tym zakresie dat.
IdentyfikatorProduktuAplikacji sznurek Identyfikator sklepu dodatku, dla którego pobierasz dane dotyczące nabycia.
NazwaProduktuwAplikacji sznurek Nazwa wyświetlana tego dodatku. Ta wartość pojawia się w danych odpowiedzi tylko wtedy, gdy parametr poziomu agregacji jest ustawiony na dzień, chyba że określono pole inAppProductName w parametrze grupowania .
applicationId (identyfikator aplikacji) sznurek Identyfikator sklepu aplikacji, dla której chcesz pobrać dane dotyczące nabycia dodatku.
Nazwa aplikacji sznurek Nazwa wyświetlana aplikacji.
typ urządzenia sznurek Typ urządzenia, które zakończyło proces pozyskiwania. Aby zapoznać się z listą obsługiwanych ciągów, zobacz sekcję pól filtru powyżej.
nazwaZamówienia sznurek Nazwa zamówienia.
klient sklepu sznurek Wersja sklepu, w którym miało miejsce nabycie. Aby zapoznać się z listą obsługiwanych ciągów, zobacz sekcję pól filtru powyżej.
Wersja systemu operacyjnego sznurek Wersja systemu operacyjnego, na której miało miejsce pozyskiwanie. Aby zapoznać się z listą obsługiwanych ciągów, zobacz sekcję pól filtru powyżej.
rynek sznurek Kod kraju ISO 3166 rynku, na którym miało miejsce nabycie.
płeć sznurek Płeć użytkownika, który dokonał przejęcia. Aby zapoznać się z listą obsługiwanych ciągów, zobacz sekcję pól filtru powyżej.
grupa wiekowa sznurek Grupa wiekowa użytkownika, który dokonał przejęcia. Aby zapoznać się z listą obsługiwanych ciągów, zobacz sekcję pól filtru powyżej.
typ nabycia sznurek Typ nabycia (bezpłatna, płatna itd.). Aby zapoznać się z listą obsługiwanych ciągów, zobacz sekcję pól filtru powyżej.
ilość nabycia liczba całkowita Liczba przejęć, które wystąpiły.

Przykład żądania i odpowiedzi

Poniższy fragment kodu przedstawia przykładowe żądanie i treść odpowiedzi JSON dla tego żądania.

Przykładowe żądanie

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Przykładowa odpowiedź

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NBLGGAAGZDQ",
            "date": "2022-07-29",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 18.12,
            "purchasePriceLocalAmount": 18.12,
            "purchaseTaxUSDAmount": 1.13,
            "purchaseTaxLocalAmount": 1.13
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Episode 4",
            "addonProductId": "9NAAAAAAAAAQ",
            "date": "2017-01-07",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 4.147206,
            "purchasePriceLocalAmount": 3.99,
            "purchaseTaxUSDAmount": 0.686004,
            "purchaseTaxLocalAmount": 0.66
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NALGGGZ5QDQ",
            "date": "2018-04-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.99,
            "purchasePriceLocalAmount": 1.99,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Strategy Guide Episode 4",
            "addonProductId": "9NBLGGGZ5QDQ",
            "date": "2021-11-25",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.31902922876179,
            "purchasePriceLocalAmount": 150.0,
            "purchaseTaxUSDAmount": 0.114315866492689,
            "purchaseTaxLocalAmount": 13.0
        },
    ],
    "TotalCount": 4,
    "DataFreshnessTimestamp": "2022-07-29T05:54:00"
}