REST Resource: monetization.subscriptions

Zasób: subscription (subskrypcja)

Pojedyncza subskrypcja na aplikację.

Zapis JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Pola
packageName

string

Stały. Nazwa pakietu aplikacji nadrzędnej.
productId

string

Stały. Unikalny identyfikator danego produktu. Unikalny w ramach aplikacji nadrzędnej. Identyfikatory produktów mogą zawierać tylko małe litery (a–z), cyfry (0–9), podkreślenia (_) i kropki (.). Musi zaczynać się od małej litery lub cyfry i mieć od 1 do 40 znaków (włącznie).
basePlans[]

object (BasePlan)

Zestaw abonamentów podstawowych tej subskrypcji. Określa ceny i czas trwania subskrypcji, jeśli nie ma żadnych innych ofert.
listings[]

object (SubscriptionListing)

Wymagane. Lista zlokalizowanych informacji o tej subskrypcji. Musi zawierać co najmniej wpis w domyślnym języku aplikacji nadrzędnej.
archived
(deprecated)

boolean

Tylko dane wyjściowe. Wycofano: archiwizacja subskrypcji nie jest obsługiwana.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Informacje o podatkach i zgodności z przepisami.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Opcjonalnie: Kraje, w których zakup tej subskrypcji jest ograniczony do form płatności zarejestrowanych w tym samym kraju. Jeśli pole jest puste, nie są stosowane żadne ograniczenia lokalizacji płatności.

BasePlan

1 abonament podstawowy na subskrypcję.

Zapis JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Pola
basePlanId

string

Wymagane. Stały. Unikalny identyfikator tego abonamentu podstawowego. Musi być unikalna w ramach subskrypcji i być zgodna ze standardem RFC-1034. Oznacza to, że ten identyfikator może zawierać tylko małe litery (a–z), cyfry (0–9) i łączniki (-), a jego długość nie może przekraczać 63 znaków.
state

enum (State)

Tylko dane wyjściowe. Stan abonamentu podstawowego, tj. czy jest aktywny. Wersje robocze i nieaktywne abonamenty podstawowe można aktywować lub usunąć. Aktywne abonamenty podstawowe można dezaktywować. Nieaktywne abonamenty podstawowe można anulować. Tego pola nie można zmienić przez aktualizację zasobu. Zamiast tego używaj dedykowanych punktów końcowych.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informacje dotyczące tego abonamentu podstawowego w różnych regionach.
offerTags[]

object (OfferTag)

Lista maksymalnie 20 tagów niestandardowych określonych dla tego abonamentu podstawowego i zwróconych do aplikacji za pomocą biblioteki płatności. Oferty subskrypcji tego abonamentu podstawowego będą też zawierać te tagi ofert w bibliotece płatności.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informacje o cenach we wszystkich nowych lokalizacjach, które Google Play może udostępnić w przyszłości. Jeśli go pominiesz, abonament Base Plan nie będzie automatycznie dostępny w żadnych nowych lokalizacjach, które Google Play może wprowadzić w przyszłości.
Pole sumy base_plan_type. Typ tego abonamentu podstawowego. Musisz ustawić tylko jedną opcję. base_plan_type może mieć tylko jedną z tych wartości:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Określ, kiedy abonament podstawowy automatycznie odnawia się w regularnych odstępach czasu.
prepaidBasePlanType

object (PrepaidBasePlanType)

Ustaw, kiedy abonament podstawowy nie będzie automatycznie odnawiany po zakończeniu okresu rozliczeniowego.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Jest ustawiony dla abonamentów podstawowych rat, w ramach których użytkownik zobowiązuje się do zrealizowania określonej liczby płatności.

Stan

Bieżący stan abonamentu podstawowego.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony.
DRAFT Abonament podstawowy jest obecnie w wersji roboczej i nie został jeszcze aktywowany. Można go bezpiecznie usunąć.
ACTIVE Abonament podstawowy jest aktywny i dostępny dla nowych subskrybentów.
INACTIVE Abonament podstawowy jest nieaktywny i jest dostępny tylko dla obecnych subskrybentów.

AutoRenewingBasePlanType

Reprezentuje abonament podstawowy, który jest automatycznie odnawiany na koniec okresu subskrypcji.

Zapis JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Pola
billingPeriodDuration

string

Wymagane. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy.
gracePeriodDuration

string

Okres prolongaty subskrypcji określony w formacie ISO 8601. Akceptowane wartości to P0D (0 dni), P3D (3 dni), P7D (7 dni), P14D (14 dni) i P30D (30 dni). Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna na podstawie czasu trwania okresu cyklicznego.
accountHoldDuration

string

Opcjonalnie: Okres zawieszenia konta subskrypcji określony w formacie ISO 8601. Akceptowane wartości muszą należeć do zakresu od DAYS do P30D (30 dni). Jeśli nie podasz żadnej wartości, domyślną wartością będzie P30D (30 dni).
resubscribeState

enum (ResubscribeState)

Określa, czy użytkownicy powinni mieć możliwość ponownego wykupienia abonamentu podstawowego na platformach w Google Play. Jeśli nie zostanie podany, przyjmuje domyślnie wartość RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Tryb proporcjonalnego abonamentu podstawowego określa, co się stanie, gdy użytkownik przejdzie na ten abonament z innego abonamentu podstawowego. Jeśli nie określono inaczej, domyślna wartość to CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Określa, czy odnawiany abonament podstawowy jest zgodny wstecznie.

Zgodny wstecznie abonament podstawowy jest zwracany przez wycofaną metodę querySkuDetailsAsync() Biblioteki płatności w Google Play.

Tylko 1 odnawiany abonament podstawowy może w przypadku danej subskrypcji oznaczyć jako zgodny ze starszą wersją.
legacyCompatibleSubscriptionOfferId

string

Identyfikator oferty subskrypcji, który jest zgodny ze starszą wersją.

Oferta subskrypcji zgodnej wstecznie jest zwracana przez wycofaną metodę querySkuDetailsAsync() Biblioteki płatności w Google Play.

Tylko 1 oferta subskrypcji może zostać oznaczona jako zgodna ze starszą wersją w przypadku danego odnawianego abonamentu podstawowego.

Aby żadna oferta subskrypcji nie była zgodna ze starszą wersją, ustaw to pole jako pusty ciąg znaków.

ResubscribeState

Stan odnowienia abonamentu podstawowego.

Wartości w polu enum
RESUBSCRIBE_STATE_UNSPECIFIED Stan nieokreślony.
RESUBSCRIBE_STATE_ACTIVE Ponowne subskrybowanie jest aktywne.
RESUBSCRIBE_STATE_INACTIVE Ponowne subskrybowanie jest nieaktywne.

SubscriptionProrationMode

Tryb proporcjonalny używany przy odnawianiu abonamentów podstawowych.

Wartości w polu enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Tryb nieokreślony.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Użytkownicy zostaną obciążeni opłatą za nowy abonament podstawowy na koniec bieżącego okresu rozliczeniowego.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Użytkownicy zostaną obciążeni pełną płatnością za nowy abonament podstawowy od razu i w całości. Pozostały okres dotychczasowej subskrypcji zostanie wykorzystany do przedłużenia okresu nowego abonamentu.

PrepaidBasePlanType

Reprezentuje abonament podstawowy, który nie jest automatycznie odnawiany po zakończeniu abonamentu podstawowego i musi zostać odnowiony ręcznie przez użytkownika.

Zapis JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Pola
billingPeriodDuration

string

Wymagane. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy.
timeExtension

enum (TimeExtension)

Określa, czy użytkownicy powinni mieć możliwość przedłużenia tego przedpłaconego abonamentu podstawowego na platformach w Google Play. Jeśli nie zostanie określona, domyślna wartość to TIME_EXTENSION_ACTIVE.

TimeExtension

Wydłużenie czasu korzystania z abonamentu podstawowego.

Wartości w polu enum
TIME_EXTENSION_UNSPECIFIED Stan nieokreślony.
TIME_EXTENSION_ACTIVE Rozszerzenie czasu jest aktywne. Użytkownicy mogą doładować lub przedłużyć abonament przedpłacony.
TIME_EXTENSION_INACTIVE Rozszerzenie czasu jest nieaktywne. Użytkownicy nie mogą doładowywać ani przedłużać abonamentu przedpłaconego.

InstallmentsBasePlanType

Reprezentuje abonament podstawowy, w ramach którego użytkownik zobowiązuje się do dokonania określonej liczby płatności.

Zapis JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Pola
billingPeriodDuration

string

Wymagane. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy.
committedPaymentsCount

integer

Wymagane. Liczba płatności, do których zobowiązał się użytkownik.
renewalType

enum (RenewalType)

Wymagane. Typ odnowienia abonamentu podstawowego. Określa zachowanie na koniec początkowego zobowiązania.
gracePeriodDuration

string

Okres prolongaty subskrypcji określony w formacie ISO 8601. Akceptowane wartości to P0D (0 dni), P3D (3 dni), P7D (7 dni), P14D (14 dni) i P30D (30 dni). Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna na podstawie czasu trwania okresu cyklicznego.
accountHoldDuration

string

Opcjonalnie: Okres zawieszenia konta subskrypcji, określony wyłącznie w dniach i w formacie ISO 8601. Akceptowane wartości to od P0D (zero dni) do P30D (30 dni). Jeśli nie podasz żadnej wartości, domyślną wartością będzie P30D (30 dni).
resubscribeState

enum (ResubscribeState)

Określa, czy użytkownicy powinni mieć możliwość ponownego wykupienia abonamentu podstawowego na platformach w Google Play. Jeśli nie zostanie podany, przyjmuje domyślnie wartość RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Tryb proporcjonalnego abonamentu podstawowego określa, co się stanie, gdy użytkownik przejdzie na ten abonament z innego abonamentu podstawowego. Jeśli nie określono inaczej, domyślna wartość to CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Typ odnowienia abonamentu podstawowego. Określa zachowanie na koniec początkowego zobowiązania.

Wartości w polu enum
RENEWAL_TYPE_UNSPECIFIED Stan nieokreślony.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Odnawiana okresowo na okres rozliczeniowy bez zobowiązania.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Odnawia się z zobowiązaniem na taki sam czas trwania jak abonament początkowy.

RegionalBasePlanConfig

Konfiguracja abonamentu podstawowego specyficznego dla regionu.

Zapis JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Pola
regionCode

string

Wymagane. Kod regionu, którego dotyczy ta konfiguracja, zgodnie z normą ISO 3166-2, np. „PL”.
newSubscriberAvailability

boolean

Określa, czy abonament podstawowy w określonym regionie jest dostępny dla nowych subskrybentów. Jeśli ta wartość ma wartość Fałsz, obecni subskrybenci nie anulują subskrypcji. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość false (fałsz).
price

object (Money)

Cena abonamentu podstawowego w określonym regionie. Musisz go ustawić, jeśli abonament podstawowy jest dostępny dla nowych subskrybentów. Musi być ustawiona w walucie powiązanej z określonym regionem.

OtherRegionsBasePlanConfig

Informacje o cenach we wszystkich nowych lokalizacjach, w których można wprowadzić Google Play.

Zapis JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Pola
usdPrice

object (Money)

Wymagane. Cena w USD do wykorzystania we wszystkich nowych lokalizacjach, w których Google Play może wprowadzić aplikację.
eurPrice

object (Money)

Wymagane. Cena w EUR do wykorzystania we wszystkich nowych lokalizacjach, w których będzie można wprowadzić Google Play.
newSubscriberAvailability

boolean

Informacja o tym, czy abonament podstawowy jest dostępny dla nowych subskrybentów w nowych lokalizacjach, w których może pojawić się Google Play. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość false (fałsz).

SubscriptionListing

Metadane subskrypcji widoczne dla klientów.

Zapis JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Pola
languageCode

string

Wymagane. Język informacji, zgodnie z definicją podaną w dokumencie BCP-47, np. „pl-PL”.
title

string

Wymagane. Tytuł tej subskrypcji w języku podanym na stronie z informacjami o aplikacji. Zwykły tekst.
benefits[]

string

Lista korzyści wyświetlana użytkownikowi na platformach takich jak Sklep Play i w ramach procesu przywracania w języku tej strony z informacjami o aplikacji. Zwykły tekst. Uporządkowana lista zawierająca maksymalnie 4 korzyści.
description

string

Opis tej subskrypcji w języku podanym na stronie z informacjami o aplikacji. Maksymalna długość – 80 znaków. Zwykły tekst.

RestrictedPaymentCountries

Kraje, w których zakup tego produktu jest ograniczony do form płatności zarejestrowanych w tym samym kraju. Jeśli pole jest puste, nie są stosowane żadne ograniczenia lokalizacji płatności.

Zapis JSON 
{
  "regionCodes": [
    string
  ]
}
Pola
regionCodes[]

string

Wymagane. Kody regionów, na które nakładane są ograniczenia płatności, zgodnie z normą ISO 3166-2, np. „PL”.

Metody

archive
(deprecated)

 Wycofano: archiwizacja subskrypcji nie jest obsługiwana.

batchGet

 Odczytuje co najmniej jedną subskrypcję.

batchUpdate

 Aktualizuje grupę subskrypcji.

create

 Tworzy nową subskrypcję.

delete

 Usuwa subskrypcję.

get

 Czyta pojedynczą subskrypcję.

list

 Wyświetla listę wszystkich subskrypcji w ramach danej aplikacji.

patch

 Aktualizuje istniejącą subskrypcję.