- Zasób: Subscription
- BasePlan
- Stan
- AutoRenewingBasePlanType
- ResubscribeState
- SubscriptionProrationMode
- PrepaidBasePlanType
- TimeExtension
- InstallmentsBasePlanType
- RenewalType
- RegionalBasePlanConfig
- OtherRegionsBasePlanConfig
- SubscriptionListing
- Metody
Zasób: Subscription
Pojedyncza subskrypcja aplikacji.
Zapis JSON |
---|
{ "packageName": string, "productId": string, "basePlans": [ { object ( |
Pola | |
---|---|
packageName |
Niezmienne. Nazwa pakietu aplikacji nadrzędnej. |
productId |
Niezmienne. Unikalny identyfikator produktu. Musi być unikalny w aplikacji nadrzędnej. Identyfikatory produktów muszą składać się z małych liter (a–z), cyfr (0–9), podkreśleń (_) i kropek (.). Musi zaczynać się od małej litery lub cyfry i mieć od 1 do 40 znaków (włącznie). |
basePlans[] |
Zestaw abonamentów podstawowych dla tego abonamentu. Przedstawia ceny i czas trwania subskrypcji, jeśli nie obowiązują inne oferty. |
listings[] |
Wymagane. Lista zlokalizowanych informacji o tej subskrypcji. Musi zawierać co najmniej wpis dla języka domyślnego aplikacji nadrzędnej. |
archived |
Tylko dane wyjściowe. Wycofano: archiwizowanie subskrypcji nie jest obsługiwane. |
taxAndComplianceSettings |
Szczegóły dotyczące podatków i zgodności z przepisami. |
restrictedPaymentCountries |
Opcjonalnie. Kraje, w których zakup tej subskrypcji jest ograniczony do form płatności zarejestrowanych w tym samym kraju. Jeśli to pole jest puste, nie są stosowane żadne ograniczenia dotyczące lokalizacji płatności. |
BasePlan
jeden abonament podstawowy subskrypcji;
Zapis JSON |
---|
{ "basePlanId": string, "state": enum ( |
Pola | |
---|---|
basePlanId |
Wymagane. Niezmienne. Unikalny identyfikator tego abonamentu podstawowego. Musi być unikalna w obrębie subskrypcji i zgodna z RFC-1034. Oznacza to, że identyfikator może zawierać tylko małe litery (a–z), cyfry (0–9) i łączniki (-), a jego maksymalna długość to 63 znaki. |
state |
Tylko dane wyjściowe. Stan abonamentu podstawowego, czyli czy jest aktywny. Wersje robocze i nieaktywne abonamenty podstawowe można aktywować lub usuwać. Aktywne subskrypcje podstawowe można dezaktywować. Nieaktywne abonamenty podstawowe można anulować. Tego pola nie można zmienić, aktualizując zasób. Zamiast tego używaj dedykowanych punktów końcowych. |
regionalConfigs[] |
Informacje dotyczące poszczególnych regionów w przypadku tego abonamentu podstawowego. |
offerTags[] |
Lista maksymalnie 20 tagów niestandardowych określonych dla tego abonamentu podstawowego, które są zwracane do aplikacji za pomocą biblioteki płatności. Oferty subskrypcji dla tego abonamentu podstawowego również otrzymają te tagi ofert w bibliotece rozliczeniowej. |
otherRegionsConfig |
informacje o cenach w nowych lokalizacjach, w których Google Play może być dostępny w przyszłości; Jeśli ten parametr zostanie pominięty, abonament podstawowy nie będzie automatycznie dostępny w nowych lokalizacjach, w których Google Play może w przyszłości uruchomić usługę. |
Pole unii base_plan_type . Typ tego abonamentu podstawowego. Musisz ustawić dokładnie jedną wartość. Po utworzeniu planu podstawowego nie można zmienić jego typu. base_plan_type może mieć tylko jedną z tych wartości: |
|
autoRenewingBasePlanType |
Ustaw, kiedy abonament podstawowy ma być automatycznie odnawiany w regularnych odstępach czasu. |
prepaidBasePlanType |
Ustaw, kiedy abonament podstawowy nie odnawia się automatycznie na koniec okresu rozliczeniowego. |
installmentsBasePlanType |
Ustawienie dla ratalnych abonamentów podstawowych, w przypadku których użytkownik zobowiązuje się do dokonania określonej liczby płatności. |
Stan
Bieżący stan abonamentu podstawowego.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Nieokreślony stan. |
DRAFT |
Abonament podstawowy jest obecnie w stanie wersji roboczej i nie został jeszcze aktywowany. Możesz go teraz bezpiecznie usunąć. |
ACTIVE |
Abonament podstawowy jest aktywny i dostępny dla nowych subskrybentów. |
INACTIVE |
Abonament podstawowy jest nieaktywny i dostępny tylko dla obecnych subskrybentów. |
AutoRenewingBasePlanType
Reprezentuje abonament podstawowy, który odnawia się automatycznie po zakończeniu okresu subskrypcji.
Zapis JSON |
---|
{ "billingPeriodDuration": string, "gracePeriodDuration": string, "accountHoldDuration": string, "resubscribeState": enum ( |
Pola | |
---|---|
billingPeriodDuration |
Wymagane. Niezmienne. Okres subskrypcji podany w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu planu podstawowego nie można zmienić czasu trwania. |
gracePeriodDuration |
Okres prolongaty subskrypcji podany w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w zakresie od P0D do mniejszej z wartości 30D i okresu rozliczeniowego abonamentu podstawowego. Jeśli nie zostanie określona, zostanie użyta wartość domyślna na podstawie okresu rozliczeniowego. Suma wartości gracePeriodDuration i accountHoldDuration musi wynosić od P30D do P60D dni. |
accountHoldDuration |
Opcjonalnie. Okres zawieszenia konta w ramach subskrypcji podany w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w zakresie od P0D do P60D. Jeśli nie określisz tu żadnej wartości, zostanie użyte ustawienie domyślne (P30D). Suma wartości gracePeriodDuration i accountHoldDuration musi wynosić od P30D do P60D dni. |
resubscribeState |
Określa, czy użytkownicy powinni mieć możliwość ponownej subskrypcji tego abonamentu podstawowego w Google Play. Jeśli nie zostanie podany, domyślnie przyjmuje wartość RESUBSCRIBE_STATE_ACTIVE. |
prorationMode |
Tryb proporcjonalnego rozliczania abonamentu podstawowego określa, co się stanie, gdy użytkownik przejdzie na ten abonament z innego abonamentu podstawowego. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna CHARGE_ON_NEXT_BILLING_DATE. |
legacyCompatible |
Określa, czy odnawiany abonament podstawowy jest zgodny wstecznie. Zgodny wstecznie abonament podstawowy jest zwracany do wycofanej metody querySkuDetailsAsync() Biblioteki płatności w Google Play. W przypadku danej subskrypcji tylko jeden odnawiany abonament podstawowy może być oznaczony jako zgodny ze starszą wersją. |
legacyCompatibleSubscriptionOfferId |
Identyfikator oferty subskrypcji zgodnej ze starszymi wersjami. Zgodna wstecznie oferta subskrypcji jest zwracana do wycofanej metody querySkuDetailsAsync() Biblioteki płatności w Google Play. W przypadku danego odnawianego abonamentu podstawowego tylko 1 ofertę subskrypcji można oznaczyć jako zgodną ze starszą wersją. Aby nie mieć oferty subskrypcji zgodnej ze starszymi wersjami, ustaw to pole jako pusty ciąg znaków. |
ResubscribeState
Stan ponownej subskrypcji abonamentu podstawowego.
Wartości w polu enum | |
---|---|
RESUBSCRIBE_STATE_UNSPECIFIED |
Nieokreślony stan. |
RESUBSCRIBE_STATE_ACTIVE |
Odnawianie subskrypcji jest aktywne. |
RESUBSCRIBE_STATE_INACTIVE |
Ponowna subskrypcja jest nieaktywna. |
SubscriptionProrationMode
Tryb proporcjonalnego rozliczania używany do odnawiania 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 płatnością za nowy abonament podstawowy na koniec bieżącego okresu rozliczeniowego. |
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY |
Użytkownicy zostaną od razu obciążeni pełną opłatą za nowy abonament podstawowy. Pozostały okres dotychczasowej subskrypcji zostanie wykorzystany do przedłużenia czasu trwania nowego abonamentu. |
PrepaidBasePlanType
Reprezentuje abonament podstawowy, który nie jest automatycznie odnawiany po zakończeniu okresu obowiązywania i musi zostać odnowiony ręcznie przez użytkownika.
Zapis JSON |
---|
{
"billingPeriodDuration": string,
"timeExtension": enum ( |
Pola | |
---|---|
billingPeriodDuration |
Wymagane. Niezmienne. Okres subskrypcji podany w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu planu podstawowego nie można zmienić czasu trwania. |
timeExtension |
Czy użytkownicy powinni mieć możliwość przedłużenia tego abonamentu podstawowego w Google Play. Jeśli nie zostanie podany, domyślnie przyjmuje wartość TIME_EXTENSION_ACTIVE. |
TimeExtension
Przedłużenie czasu trwania abonamentu podstawowego.
Wartości w polu enum | |
---|---|
TIME_EXTENSION_UNSPECIFIED |
Nieokreślony stan. |
TIME_EXTENSION_ACTIVE |
Przedłużenie czasu jest aktywne. Użytkownicy mogą doładować lub przedłużyć abonament przedpłacony. |
TIME_EXTENSION_INACTIVE |
Przedłużenie czasu jest nieaktywne. Użytkownicy nie mogą doładować ani przedłużyć abonamentu przedpłaconego. |
InstallmentsBasePlanType
Oznacza ratalny 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 ( |
Pola | |
---|---|
billingPeriodDuration |
Wymagane. Niezmienne. Okres subskrypcji podany w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu planu podstawowego nie można zmienić czasu trwania. |
committedPaymentsCount |
Wymagane. Niezmienne. Liczba płatności, do których użytkownik się zobowiązał. Po utworzeniu planu podstawowego nie można go zmienić. |
renewalType |
Wymagane. Niezmienne. Typ odnowienia abonamentu podstawowego w przypadku płatności ratalnych. Określa zachowanie po zakończeniu początkowego okresu zobowiązania. Po utworzeniu planu podstawowego nie można zmienić typu odnowienia. |
gracePeriodDuration |
Okres prolongaty subskrypcji podany w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w zakresie od P0D do mniejszej z wartości 30D i okresu rozliczeniowego abonamentu podstawowego. Jeśli nie zostanie określona, zostanie użyta wartość domyślna na podstawie okresu rozliczeniowego. Suma wartości gracePeriodDuration i accountHoldDuration musi wynosić od P30D do P60D dni. |
accountHoldDuration |
Opcjonalnie. Okres zawieszenia konta w ramach subskrypcji podany w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w zakresie od P0D do P60D. Jeśli nie określisz tu żadnej wartości, zostanie użyte ustawienie domyślne (P30D). Suma wartości gracePeriodDuration i accountHoldDuration musi wynosić od P30D do P60D dni. |
resubscribeState |
Określa, czy użytkownicy powinni mieć możliwość ponownej subskrypcji tego abonamentu podstawowego w Google Play. Jeśli nie zostanie podany, domyślnie przyjmuje wartość RESUBSCRIBE_STATE_ACTIVE. |
prorationMode |
Tryb proporcjonalnego rozliczania abonamentu podstawowego określa, co się stanie, gdy użytkownik przejdzie na ten abonament z innego abonamentu podstawowego. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna CHARGE_ON_NEXT_BILLING_DATE. |
RenewalType
Typ odnowienia abonamentu podstawowego w przypadku płatności ratalnych. Określa zachowanie po zakończeniu początkowego okresu zobowiązania. Po utworzeniu planu podstawowego nie można zmienić typu odnowienia.
Wartości w polu enum | |
---|---|
RENEWAL_TYPE_UNSPECIFIED |
Nieokreślony stan. |
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT |
Odnowienie następuje okresowo na czas trwania okresu rozliczeniowego bez zobowiązania. |
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT |
Odnowienie zobowiązania na okres o tej samej długości co okres początkowy. |
RegionalBasePlanConfig
Konfiguracja abonamentu podstawowego w określonym regionie.
Zapis JSON |
---|
{
"regionCode": string,
"newSubscriberAvailability": boolean,
"price": {
object ( |
Pola | |
---|---|
regionCode |
Wymagane. Kod regionu, którego dotyczy ta konfiguracja, zgodnie z normą ISO 3166-2, np. „US”. |
newSubscriberAvailability |
Określa, czy abonament podstawowy w danym regionie jest dostępny dla nowych subskrybentów. Jeśli ta wartość jest ustawiona na „false”, subskrypcje obecnych subskrybentów nie zostaną anulowane. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość „false”. |
price |
Cena abonamentu podstawowego w określonym regionie. Musi być ustawiona, 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 w nowych lokalizacjach, w których może pojawić się usługa Google Play;
Zapis JSON |
---|
{ "usdPrice": { object ( |
Pola | |
---|---|
usdPrice |
Wymagane. Cena w USD, która będzie używana w przypadku nowych lokalizacji, w których może pojawić się Google Play. |
eurPrice |
Wymagane. Cena w EUR, która będzie używana w przypadku nowych lokalizacji, w których Play może wprowadzić usługę. |
newSubscriberAvailability |
Czy abonament podstawowy jest dostępny dla nowych subskrybentów w nowych lokalizacjach, w których może pojawić się usługa Google Play. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość „false”. |
SubscriptionListing
Metadane subskrypcji widoczne dla klienta.
Zapis JSON |
---|
{ "languageCode": string, "title": string, "benefits": [ string ], "description": string } |
Pola | |
---|---|
languageCode |
Wymagane. Język tej wizytówki zdefiniowany zgodnie ze standardem BCP-47, np. „en-US”. |
title |
Wymagane. Tytuł tej subskrypcji w języku tej oferty. Zwykły tekst. |
benefits[] |
Lista korzyści wyświetlana użytkownikowi na platformach takich jak Sklep Play i w procesach przywracania w języku tej strony aplikacji. Zwykły tekst. Lista uporządkowana z maksymalnie 4 korzyściami. |
description |
Opis tej subskrypcji w języku tej oferty. Maksymalna długość to 80 znaków. Zwykły tekst. |
Metody |
|
---|---|
(deprecated) |
Wycofano: archiwizowanie subskrypcji nie jest obsługiwane. |
|
Odczytuje co najmniej 1 subskrypcję. |
|
Aktualizuje grupę subskrypcji. |
|
Tworzy nową subskrypcję. |
|
Usuwa subskrypcję. |
|
Odczytuje pojedynczą subskrypcję. |
|
Wyświetla wszystkie subskrypcje w danej aplikacji. |
|
Aktualizuje istniejącą subskrypcję. |