REST Resource: purchases.subscriptions

Zasób: SubscriptionPurchase

Zasób subscriptionPurchase wskazuje stan zakupu subskrypcji przez 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 rodzaj 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 wygaśnięcia subskrypcji (w milisekundach od początku epoki).
autoResumeTimeMillis

string (int64 format)

Czas automatycznego wznowienia subskrypcji (w milisekundach od początku epoki). Widoczny tylko wtedy, gdy użytkownik poprosił o wstrzymanie subskrypcji.
autoRenewing

boolean

Określa, czy subskrypcja będzie automatycznie odnawiana po osiągnięciu bieżącego czasu.
priceCurrencyCode

string

Kod waluty ISO 4217 ceny subskrypcji. Jeśli na przykład cena jest podana w funtach brytyjskich, priceCurrencyCode to „GBP”.
priceAmountMicros

string (int64 format)

Cena subskrypcji. W krajach, w których nie ma podatku, cena nie zawiera podatku. W krajach, w których nie ma podatku, cena zawiera podatek. Cena jest wyrażona w mikrojednostkach, gdzie milion mikrojednostek odpowiada jednej jednostce waluty. Jeśli np.cena subskrypcji wynosi 1, 99 EUR, cena priceMicros to 1990 000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Informacje o cenie początkowej subskrypcji. Ta informacja jest widoczna tylko wtedy, gdy subskrypcja została kupiona po cenie początkowej.

To pole nie wskazuje, że subskrypcja jest obecnie w okresie początkowym.
countryCode

string

Kod kraju/regionu rozliczenia według normy ISO 3166-1 alfa-2 użytkownika w momencie przyznawania subskrypcji.
developerPayload

string

Określony przez dewelopera ciąg tekstowy zawierający dodatkowe informacje o zamówieniu.
paymentState

integer

Stan płatności za subskrypcję. Możliwe wartości to: 0. Oczekująca płatność: 1. Płatność otrzymana 2. Bezpłatny okres próbny 3. Oczekuje na odroczoną zmianę/zmianę wersji

Nie występuje w przypadku anulowanych, wygasłych subskrypcji.
cancelReason

integer

Powód anulowania lub nieodnawiania się automatycznie. Możliwe wartości to: 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). Występuje tylko wtedy, gdy cancelReason ma wartość 0.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

Informacje podane przez użytkownika podczas procesu anulowania subskrypcji (ankieta dotycząca powodów anulowania).
orderId

string

Identyfikator ostatniego zamówienia cyklicznego powiązanego z zakupem subskrypcji. 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 źródłowego zakupu, jeśli ta subskrypcja jest jedną z tych: 0. ponowna rejestracja anulowanej, ale nieaktywnej subskrypcji; 1. Przechodzenie na wyższą lub niższą wersję usługi

Załóżmy na przykład, że użytkownik pierwotnie zarejestrował się i otrzymujesz token zakupu X. Wtedy użytkownik anuluje rejestrację i przechodzi przez proces ponownej rejestracji (przed wygaśnięciem subskrypcji). Otrzymasz token zakupu Y, a na koniec użytkownik przejdzie na wyższą wersję subskrypcji, a Ty otrzymasz token zakupu Z. Jeśli wywołujesz ten interfejs API, używając tokena zakupu Z, to pole zostanie ustawione na Y. Jeśli wywołujesz ten interfejs API przy użyciu tokena zakupu Y, to pole zostanie ustawione na X. Jeśli wywołujesz ten interfejs API, używając tokena zakupu X, to pole nie zostanie ustawione.
purchaseType

integer

Typ zakupu subskrypcji. To pole ustawia się tylko wtedy, gdy zakupu nie dokonano za pomocą standardowego procesu rozliczeń w aplikacji. Możliwe wartości to: 0. Testowy (np. kupiony na koncie do testowania licencji) 1. promocja (np. zakup za pomocą kodu promocyjnego),
priceChange

object (SubscriptionPriceChange)

Najnowsze dostępne informacje o zmianie cen. Ten parametr jest dostępny tylko wtedy, gdy nadejdzie zmiana ceny subskrypcji, która nie została jeszcze zastosowana.

Po odnowieniu subskrypcji z nową ceną lub po anulowaniu subskrypcji informacje o zmianie ceny nie zostaną zwrócone.
profileName

string

Nazwa profilu użytkownika, gdy użytkownik kupił subskrypcję. Widoczny tylko w przypadku zakupów dokonywanych przy użyciu funkcji „Subskrybuj z Google”.
emailAddress

string

Adres e-mail użytkownika, który kupił subskrypcję. Widoczny tylko w przypadku zakupów dokonywanych przy użyciu funkcji „Subskrybuj z Google”.
givenName

string

Imię i nazwisko użytkownika w chwili zakupu subskrypcji. Widoczny tylko w przypadku zakupów dokonywanych przy użyciu funkcji „Subskrybuj z Google”.
familyName

string

Imię i nazwisko użytkownika, w którym zakupiono subskrypcję. Widoczny tylko w przypadku zakupów dokonywanych przy użyciu funkcji „Subskrybuj z Google”.
profileId

string

Identyfikator profilu Google użytkownika, w którym zakupiono subskrypcję. Widoczny tylko w przypadku zakupów dokonywanych przy użyciu funkcji „Subskrybuj z Google”.
acknowledgementState

integer

Stan potwierdzenia usługi objętej subskrypcją. Możliwe wartości to: 0. 1. Potwierdzono
externalAccountId

string

Identyfikator konta użytkownika w usłudze innej firmy. Widoczny tylko wtedy, gdy konto zostało połączone w ramach zakupu subskrypcji.
promotionType

integer

Typ promocji zastosowanej do tego zakupu. To pole jest ustawiane tylko wtedy, gdy podczas zakupu subskrypcji ma zastosowanie promocja. Możliwe wartości to: 0. Kod jednorazowy 1. Kod słowny
promotionCode

string

Kod promocyjny zastosowany przy tym zakupie. To pole jest ustawiane tylko wtedy, gdy podczas zakupu subskrypcji stosowana jest promocja dotycząca kodu promocyjnego.
obfuscatedExternalAccountId

string

Zaciemniona wersja identyfikatora, który jest jednoznacznie powiązany z kontem użytkownika w Twojej aplikacji. Widoczne w przypadku tych zakupów: * Jeśli połączenie konta nastąpiło w ramach zakupu subskrypcji. * Został określony przy użyciu identyfikatora https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid podczas zakupu.
obfuscatedExternalProfileId

string

Zaciemniona wersja identyfikatora, który jest jednoznacznie powiązany z profilem użytkownika w Twojej aplikacji. Widoczny tylko wtedy, gdy podczas zakupu został określony za pomocą parametru https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid.

IntroductoryPriceInfo

Zawiera informacje o cenie początkowej subskrypcji.

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

string

Kod waluty ISO 4217 ceny subskrypcji dla nowych użytkowników. Jeśli na przykład cena jest podana w funtach brytyjskich, 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, gdzie milion mikrojednostek odpowiada jednej jednostce waluty. Jeśli np.cena subskrypcji wynosi 1, 99 EUR, cena priceMicros to 1990 000.
introductoryPricePeriod

string

Okres obowiązywania ceny dla nowych subskrybentów określony w formacie ISO 8601. Typowe wartości to między innymi „P1W” (tydzień), „P1M” (1 miesiąc), „P3M” (3 miesiące), „P6M” (sześć miesięcy) i „P1Y” (jeden rok).
introductoryPriceCycles

integer

Liczba okresu rozliczeniowego, w którym oferowane są ceny dla nowych subskrybentów.

SubscriptionCancelSurveyResult

Informacje podane przez użytkownika podczas procesu anulowania subskrypcji (ankieta dotycząca powodów anulowania).

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

integer

Powód anulowania wybrany przez użytkownika w ankiecie. Możliwe wartości to: 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

Niestandardowa przyczyna anulowania danych wejściowych użytkownika. Występuje tylko wtedy, gdy cancelReason ma wartość 0.

SubscriptionPriceChange

Zawiera informacje o zmianie ceny subskrypcji, które mogą służyć do kontrolowania ścieżki użytkownika w związku ze zmianą ceny w aplikacji. Może to być prośba o potwierdzenie od użytkownika lub dostosowywanie procesu pod kątem skutecznej konwersji.

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

object (Price)

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

integer

Obecny stan zmiany ceny. Możliwe wartości to: 0. Oczekujące: stan oczekującej zmiany ceny przez użytkownika. W tym stanie możesz opcjonalnie poprosić użytkownika o potwierdzenie za pomocą interfejsu API w aplikacji. 1. Zaakceptowana: stan akceptowanej zmiany ceny, z którą subskrypcja będzie odnawiana, chyba że zostanie anulowana. Zmiana ceny zacznie obowiązywać w przyszłości w momencie odnowienia subskrypcji. Pamiętaj, że ta zmiana może nie pojawić się przy kolejnym odnowieniu subskrypcji.

Metody

acknowledge

 Potwierdza zakup subskrypcji.

cancel

 anuluje zakup subskrypcji użytkownika.

defer

 Opóźnia zakup subskrypcji przez użytkownika do określonego terminu w przyszłości.

get

 Sprawdza, czy subskrypcja użytkownika jest ważna, i zwraca datę ważności.

refund

 Zwraca środki za zakup subskrypcji, ale subskrypcja jest ważna do momentu jej wygaśnięcia i będzie dalej powtarzana.

revoke

 Zwraca środki za zakup subskrypcji i natychmiast anuluje zakup subskrypcji.