REST Resource: purchases.subscriptions

Zasób: SubscriptionPurchase

Zasób SubscriptionPurchase pokazuje stan zakupu subskrypcji użytkownika.

Zapis JSON
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Pola
kind

string

Ten typ reprezentuje obiekt subscriptionPurchase w usłudze androidpublisher.

startTimeMillis

string (int64 format)

Czas przyznania subskrypcji w milisekundach od początku epoki.

expiryTimeMillis

string (int64 format)

Czas, po którym subskrypcja wygaśnie (w milisekundach od początku epoki).

autoResumeTimeMillis

string (int64 format)

Czas, kiedy nastąpi automatyczne wznowienie subskrypcji (w milisekundach od początku epoki). To ustawienie ma zastosowanie tylko wtedy, gdy użytkownik poprosił o wstrzymanie subskrypcji.

autoRenewing

boolean

Określa, czy subskrypcja jest automatycznie odnawiana po upływie terminu wygaśnięcia.

priceCurrencyCode

string

Kod waluty w standardzie ISO 4217. Jeśli na przykład cena jest podana w funtach brytyjskich, parametr priceCurrencyCode to "GBP".

priceAmountMicros

string (int64 format)

Cena subskrypcji – w przypadku krajów bez podatku podatek nie zawiera podatku. W krajach z podatkiem cena zawiera podatek. Cena jest wyrażona w mikrojednostkach, w których 1 000 000 jest mikrojednostką waluty. Jeśli na przykład cena subskrypcji to 1, 99 EUR, priceAmountMicros to 1990000.

introductoryPriceInfo

object (IntroductoryPriceInfo)

Informacje o cenie początkowej subskrypcji. Jest to możliwe tylko w przypadku zakupu subskrypcji z ceną początkową.

To pole nie wskazuje, że obecnie trwa okres obowiązywania ceny początkowej.

countryCode

string

Kod kraju/regionu zgodnie z normą ISO 3166-1 alfa-2 użytkownika w momencie przyznania subskrypcji.

developerPayload

string

Ciąg znaków określony przez dewelopera, który zawiera dodatkowe informacje o zamówieniu.

paymentState

integer

Stan płatności za subskrypcję. Możliwe wartości: 0 Płatność oczekująca 1. Płatność otrzymana 2. Bezpłatny okres próbny 3. Oczekuje na odroczone przejście na niższą lub wyższą wersję

Nie istnieje w przypadku anulowania subskrypcji, które wygasły.

cancelReason

integer

Przyczyna anulowania lub nieodnawiania subskrypcji. Możliwe wartości: 0 Użytkownik anulował subskrypcję 1. Subskrypcja została anulowana przez system, na przykład z powodu problemu z płatnością 2. Subskrypcja została zastąpiona nową subskrypcją 3. Subskrypcja została anulowana przez dewelopera

userCancellationTimeMillis

string (int64 format)

Czas anulowania subskrypcji przez użytkownika w milisekundach od początku epoki. Wartość podawana tylko w przypadku anulowania (Przyczyna 0).

cancelSurveyResult

object (SubscriptionCancelSurveyResult)

Informacje podane przez użytkownika, gdy przeprowadził proces anulowania subskrypcji (ankieta z informacją o anulowaniu subskrypcji).

orderId

string

Identyfikator zamówienia, z którego ostatnio dokonano zakupu powiązanego z subskrypcją. Jeśli subskrypcja została anulowana z powodu odrzucenia płatności, będzie to identyfikator zamówienia z odrzuconej płatności.

linkedPurchaseToken

string

Token zakupu pierwotnego, jeśli jedna z tych subskrypcji to 0. Ponowna rejestracja anulowanej, niewygasłej subskrypcji 1. Przechodzenie na wyższą lub niższą wersję subskrypcji

Załóżmy na przykład, że użytkownik pierwotnie się zarejestrował, a Ty otrzymujesz token zakupu X, więc anuluje on subskrypcję i przechodzi przez proces ponownej rejestracji (przed wygaśnięciem subskrypcji), a Ty otrzymujesz token zakupu Y, a następnie użytkownik przenosi subskrypcję i otrzymujesz token zakupu Z. Jeśli wywołasz ten interfejs API za pomocą tokena zakupu Z, w tym polu zostanie ustawiona wartość Y. Jeśli wywołasz ten interfejs API za pomocą tokena zakupu Y, w tym polu zostanie ustawiona wartość X. Jeśli wywołasz ten interfejs API za pomocą tokena zakupu X, to pole nie zostanie ustawione.

purchaseType

integer

Rodzaj zakupu subskrypcji. To pole jest ustawione tylko wtedy, gdy zakupu nie dokonano za pomocą standardowego procesu rozliczeń w aplikacji. Możliwe wartości: 0 Testowy (np. zakupiony za pomocą konta do testowania licencji) 1. Promocja (np. kupiony za pomocą kodu promocyjnego)

priceChange

object (SubscriptionPriceChange)

Najnowsze dostępne informacje o zmianie cen. Ta funkcja działa tylko wtedy, gdy do nadchodzącej zmiany ceny subskrypcji nie została jeszcze zastosowana.

Jeśli subskrypcja zostanie odnowiona z nową ceną lub zostanie anulowana, żadne informacje o zmianie ceny nie zostaną zwrócone.

profileName

string

Nazwa profilu użytkownika, który dokonał subskrypcji. Widoczny tylko w przypadku zakupów dokonanych za pomocą usługi „Subskrybuj z Google”.

emailAddress

string

Adres e-mail użytkownika podczas zakupu subskrypcji. Widoczny tylko w przypadku zakupów dokonanych za pomocą usługi „Subskrybuj z Google”.

givenName

string

Nazwa użytkownika, która została kupiona podczas zakupu subskrypcji. Widoczny tylko w przypadku zakupów dokonanych za pomocą usługi „Subskrybuj z Google”.

familyName

string

Nazwisko użytkownika, który wykupił subskrypcję. Widoczny tylko w przypadku zakupów dokonanych za pomocą usługi „Subskrybuj z Google”.

profileId

string

Identyfikator profilu Google użytkownika podczas kupowania subskrypcji. Widoczny tylko w przypadku zakupów dokonanych za pomocą usługi „Subskrybuj z Google”.

acknowledgementState

integer

Stan potwierdzenia subskrypcji. Możliwe wartości: 0 Jeszcze trzeba potwierdzić. 1. Potwierdzono

externalAccountId

string

Identyfikator konta użytkownika w usłudze zewnętrznej. To ustawienie jest dostępne tylko wtedy, gdy w ramach procesu zakupu subskrypcji nastąpiło połączenie konta.

promotionType

integer

Typ promocji zastosowanej do tego zakupu. To pole jest ustawione tylko wtedy, gdy do zakupu została zastosowana promocja. Możliwe wartości: 0 Kod jednorazowy 1. Kod słowny

promotionCode

string

Kod promocyjny zastosowany przy tym zakupie. To pole jest ustawione tylko wtedy, gdy podczas zakupu subskrypcji zastosowano skrócony kod promocyjny.

obfuscatedExternalAccountId

string

Zaciemniona wersja identyfikatora, która jest jednoznacznie powiązana z kontem użytkownika w Twojej aplikacji. Prezentowana w przypadku tych zakupów: * Jeśli konto zostało połączone w ramach procesu zakupu subskrypcji. * Została określona za pomocą parametru https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid podczas zakupu.

obfuscatedExternalProfileId

string

Zniekształcona wersja identyfikatora jednoznacznie powiązana z profilem użytkownika w aplikacji. Jest widoczna tylko wtedy, gdy została określona za pomocą parametru https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid podczas zakupu.

Cena dla nowych użytkowników

Zawiera informacje o cenie początkowej subskrypcji.

Zapis JSON
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
Pola
introductoryPriceCurrencyCode

string

Kod waluty w standardzie ISO 4217 dla ceny subskrypcji dla nowych użytkowników. Jeśli na przykład cena jest podana w funtach brytyjskich, parametr priceCurrencyCode to "GBP".

introductoryPriceAmountMicros

string (int64 format)

Cena początkowa subskrypcji bez podatku. Waluta jest taka sama jak priceCurrencyCode. Cena jest wyrażona w mikrojednostkach, w których 1 000 000 jest mikrojednostką waluty. Jeśli na przykład cena subskrypcji to 1, 99 EUR, priceAmountMicros to 1990000.

introductoryPricePeriod

string

Okres obowiązywania ceny początkowej w formacie ISO 8601. Typowe wartości to między innymi „"P1W&quot” (tydzień), "P1M" (1 miesiąc), "P3M" (3 miesiące) i „P6M" (6 miesięcy)” oraz „"P1Y" rok”.

introductoryPriceCycles

integer

Liczba okresów rozliczeniowych, w których obowiązuje cena początkowa.

Wynik anulowania subskrypcji

Informacje podane przez użytkownika, gdy przeprowadził proces anulowania subskrypcji (ankieta z informacją o anulowaniu subskrypcji).

Zapis JSON
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
Pola
cancelSurveyReason

integer

Powód anulowania wybrany przez użytkownika w ankiecie. Możliwe wartości: 0 Inne 1. Nie używam tej usługi zbyt często 2. Problemy techniczne 3. Chodzi o koszty. 4. Udało mi się znaleźć lepszą aplikację

userInputCancelReason

string

Dostosowana przyczyna anulowania podana przez użytkownika. Ten element jest dostępny tylko wtedy, gdy parametr cancellationPrzyczyna ma wartość 0.

Zmiana ceny subskrypcji

Zawierają informacje o zmianie ceny subskrypcji, które mogą służyć do kontrolowania ścieżki użytkownika prowadzącej do zmiany ceny w aplikacji. Może to być forma poproszenia użytkownika o potwierdzenie lub dostosowanie doświadczenia pod kątem pomyślnej konwersji.

Zapis JSON
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
Pola
newPrice

object (Price)

Nowa cena, za którą subskrypcja zostanie odnowiona, jeśli użytkownik zaakceptuje zmianę ceny.

state

integer

Bieżący stan zmiany ceny. Możliwe wartości: 0 Zaległe: stan oczekującej zmiany ceny oczekującej na zgodę użytkownika. W takiej sytuacji możesz poprosić użytkownika o potwierdzenie za pomocą interfejsu In-App API. 1. Zaakceptowana: stan akceptowanej zmiany ceny, z której subskrypcja może zostać odnowiona, chyba że zostanie anulowana. Zmiana ceny zacznie obowiązywać w przyszłości, gdy subskrypcja będzie odnawiana. Pamiętaj, że zmiana może nie nastąpić przy odnowieniu subskrypcji.

Metody

acknowledge

Potwierdza zakup subskrypcji.

cancel

Anulowanie zakupu subskrypcji użytkownika.

defer

Odkłada zakup subskrypcji użytkownika na określony czas.

get

Sprawdza, czy subskrypcja subskrypcji użytkownika jest prawidłowa, i zwraca czas wygaśnięcia.

refund

Zwrot środków za subskrypcję użytkownika, ale pozostanie on ważny do czasu jego wygaśnięcia i będzie się powtarzać.

revoke

Zwrot środków i anulowanie zakupu subskrypcji użytkownika.