Udostępnij przez

Zakup dodatków do subskrypcji

Użyj tej metody w interfejsie API analityki Microsoft Store, aby uzyskać zagregowane dane pozyskiwania dla subskrypcji dodatków dla aplikacji w określonym zakresie dat i z innymi opcjonalnymi filtrami.

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/subscriptions

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

Parametr Typ Opis Wymagane
applicationId (identyfikator aplikacji) sznurek Identyfikator sklepu Store aplikacji, dla której chcesz pobrać dane pozyskiwania dodatku subskrypcji. Tak
IdentyfikatorProduktuSubskrypcji sznurek Identyfikator sklepu dodatku subskrypcji, dla którego chcesz pobrać dane pozyskiwania. Jeśli nie określisz tej wartości, ta metoda zwraca dane pozyskiwania dla wszystkich dodatków subskrypcji dla określonej aplikacji. Nie.
data rozpoczęcia termin Data początkowa w zakresie dat dotyczących pozyskiwania danych o nabyciu dodatku subskrypcji. Wartość domyślna to bieżąca data. Nie.
data zakończenia termin Data końcowa w zakresie dat dotyczących pozyskiwania danych dotyczących nabycia dodatku subskrypcji. 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 100. 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=100 i skip=0 pobiera pierwsze 100 wierszy danych, top=100 i skip=100 pobiera kolejne 100 wierszy danych itd. Nie.
filtr sznurek Co najmniej jedno lub więcej wyrażeń filtrujących zawartość odpowiedzi. Każda instrukcja może używać operatorów eq lub ne, a instrukcje można łączyć przy użyciu i lub lub. W instrukcjach filter można określić następujące ciągi (odpowiadają one wartościom w treści odpowiedzi):
  • daty
  • subscriptionProductName (nazwa_produktu)
  • applicationName (nazwa_aplikacji)
  • skuId (identyfikator klienta)
  • rynek
  • typ urządzenia

Oto przykładowy parametr filtru : filter=date eq "2017-07-08".

 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 wynikowych dla każdego pozyskiwania dodatku subskrypcji. Składnia to orderby=field [order],field [order],.... Parametr field może być jednym z następujących ciągów:
  • daty
  • subscriptionProductName (nazwa_produktu)
  • applicationName (nazwa_aplikacji)
  • skuId (identyfikator klienta)
  • rynek
  • typ urządzenia

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.
grupowanie sznurek Instrukcja, która stosuje agregację danych tylko do określonych pól. Możesz określić następujące pola:
  • daty
  • subscriptionProductName (nazwa_produktu)
  • applicationName (nazwa_aplikacji)
  • skuId (identyfikator klienta)
  • rynek
  • typ urządzenia

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

 Nie.

Przykład zapytania

W poniższym przykładzie pokazano, jak uzyskać dane na temat pozyskiwania dodatkowych opcji subskrypcji. Zastąp wartość applicationId odpowiednim identyfikatorem sklepu dla aplikacji.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

Ciało odpowiedzi

Wartość Typ Opis
Wartość układ Tablica obiektów, które zawierają dane zbiorcze dotyczące nabycia dodatków do subskrypcji. Aby uzyskać więcej informacji na temat danych w każdym obiekcie, zobacz poniżej sekcję wartości pozyskiwania subskrypcji.
@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 limitu żądania jest ustawiony na 100, ale dla zapytania istnieje więcej niż 100 wierszy danych dotyczących pozyskania dodatków do subskrypcji.
Łączna liczba int (integer) Całkowita liczba wierszy w wyniku danych dla zapytania.

Wartości pozyskiwania subskrypcji

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.
IdentyfikatorProduktuSubskrypcji sznurek Identyfikator sklepu dodatku subskrypcji, dla którego pobierasz dane pozyskiwania.
NazwaProduktuSubskrypcji sznurek Nazwa wyświetlana dodatku subskrypcji.
applicationId (identyfikator aplikacji) sznurek Identyfikator aplikacji sklepu, dla której pobierasz dane dotyczące pozyskiwania dodatków subskrypcyjnych.
Nazwa aplikacji sznurek Nazwa wyświetlana aplikacji.
skuId (identyfikator klienta) sznurek Identyfikator jednostki SKU dodatku subskrypcji, dla którego pobierasz dane pozyskiwania.
typ urządzenia sznurek Jeden z następujących ciągów określający typ urządzenia, które zakończyło akwizycję:
  • Komputer osobisty
  • Telefon
  • Console-Xbox jeden
  • SeriaConsole-Xbox X
  • Iot
  • Holograficzne
  • Nieznane
rynek sznurek Kod kraju ISO 3166 rynku, na którym miało miejsce nabycie.
kod waluty sznurek Kod waluty w formacie ISO 4217 dla sprzedaży brutto przed podatkami.
sprzedaż brutto przed opodatkowaniem liczba całkowita Sprzedaż brutto w walucie lokalnej określonej przez wartość currencyCode.
całkowitaLiczbaAktywnych liczba całkowita Liczba wszystkich aktywnych subskrypcji w określonym przedziale czasu. Jest to odpowiednik sumy wartości goodStandingActiveCount, pendingGraceActiveCount, graceActiveCounti lockedActiveCount.
całkowitaLiczbaOdejść liczba całkowita Łączna liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu. Jest to równoważne do sumy wartości billingChurnCount, nonRenewalChurnCount, refundChurnCount, chargebackChurnCount, earlyChurnCountoraz otherChurnCount.
nowaIlość liczba całkowita Liczba nowych przejęć subskrypcji w określonym przedziale czasu, w tym wersje próbne.
renewCount (liczba renew) liczba całkowita Liczba odnowień subskrypcji w określonym przedziale czasu, w tym odnawianie inicjowane przez użytkownika i automatyczne odnawianie.
LiczbaAktywnychWWDobrejPozycji liczba całkowita Liczba subskrypcji, które były aktywne w określonym przedziale czasu i gdzie data wygaśnięcia to >= wartość endDate w zapytaniu.
LiczbaAktywnychCzasówOczekiwania liczba całkowita Liczba subskrypcji, które były aktywne w określonym przedziale czasu, ale wystąpiło niepowodzenie rozliczeń, i gdzie data wygaśnięcia subskrypcji jest >= wartość końcowej daty zapytania.
graceActiveCount (liczba łask) liczba całkowita Liczba subskrypcji, które były aktywne w określonym przedziale czasu, ale wystąpiła awaria rozliczeń i gdzie:
  • Data wygaśnięcia subskrypcji jest < wartości endDate dla zapytania.
  • Koniec okresu prolongaty to >jest wartością endDate.
zablokowanaAktywnaIlość liczba całkowita Liczba subskrypcji, które znajdowały się w łączenia (czyli subskrypcja zbliża się do wygaśnięcia, a firma Microsoft próbuje uzyskać środki w celu automatycznego odnowienia subskrypcji) w określonym przedziale czasu i gdzie:
  • Data wygaśnięcia subskrypcji jest < wartości endDate dla zapytania.
  • Koniec okresu prolongaty to <jest wartością endDate.
billingChurnCount (liczba rezygnacji) liczba całkowita Liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu z powodu niepowodzenia przetwarzania opłaty rozliczeniowej i miejsca, w którym subskrypcje były wcześniej w trakcie uruchamiania.
Liczba rezygnujących bez przedłużenia liczba całkowita Liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu, ponieważ nie zostały odnowione.
liczba rezygnacji z refundacji liczba całkowita Liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu, ponieważ zostały zwrócone.
chargebackChurnCount (liczba rezygnacji) liczba całkowita Liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu z tytułu zwrotu płatności.
earlyChurnCount (liczba rezygnacji) liczba całkowita Liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu, gdy były w dobrej kondycji.
liczba innych rezygnacji liczba całkowita Liczba subskrypcji, które zostały dezaktywowane w określonym przedziale czasu z innych powodów.

Przykład żądania i odpowiedzi

Poniższe fragmenty kodu przedstawiają przykładowe żądanie i treść odpowiedzi JSON dla tego żądania.

Przykładowe żądanie

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

Przykładowa odpowiedź

{
    "Value": [
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "grossSalesBeforeTax": 3460656.260391250,
            "totalActiveCount": 20211321,
            "totalChurnCount": 5605,
            "newCount": 3810366,
            "renewCount": 12102044,
            "goodStandingActiveCount": 17893664,
            "pendingGraceActiveCount": 2255792,
            "graceActiveCount": 61833,
            "lockedActiveCount": 32,
            "billingChurnCount": 4,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 2717,
            "otherChurnCount": 2884
        },
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Unknown",
            "grossSalesBeforeTax": 2342.580615228,
            "totalActiveCount": 50550,
            "totalChurnCount": 7,
            "newCount": 8312,
            "renewCount": 31446,
            "goodStandingActiveCount": 44047,
            "pendingGraceActiveCount": 6503,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 5,
            "otherChurnCount": 2
        }
    ],
    "TotalCount": 2
}

Przykładowe żądanie

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>

Przykładowa odpowiedź

{
    "Value": [
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "IT",
            "deviceType": "Console-Xbox One",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 2,
            "renewCount": 0,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "NO",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 13,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "CA",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 152,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 270,
            "goodStandingActiveCount": 133,
            "pendingGraceActiveCount": 19,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        }
    ],
    "TotalCount": 3
}

 

 

  • Last updated on