REST Resource: monetization.subscriptions

Zasób: Subskrypcja

Pojedyncza subskrypcja aplikacji.

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

string

Niezmienna. Nazwa pakietu aplikacji nadrzędnej.
productId

string

Niezmienna. Unikalny identyfikator produktu. Unikalny w ramach aplikacji nadrzędnej. Identyfikator produktu musi składać się z małej litery (a–z), cyfr (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 dla tego abonamentu. Określa ceny i czas trwania subskrypcji, jeśli nie obowiązują żadne inne oferty.
listings[]

object (SubscriptionListing)

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

boolean

Tylko dane wyjściowe. Nieaktualne: archiwizowanie subskrypcji nie jest obsługiwane.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Szczegóły dotyczące podatków 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 obowiązują żadne ograniczenia dotyczące lokalizacji płatności.

BasePlan

Pojedynczy abonament podstawowy w ramach subskrypcji.

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. Niezmienna. Unikalny identyfikator tego abonamentu podstawowego. Musi być niepowtarzalny w ramach subskrypcji i zgodny z RFC-1034. Oznacza to, że identyfikator może zawierać tylko małe litery (a–z), cyfry (0–9) i myślniki (-), a jego maksymalna długość to 63 znaki.
state

enum (State)

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

object (RegionalBasePlanConfig)

Informacje dotyczące tego abonamentu podstawowego w danym regionie.
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 abonamentu podstawowego również otrzymają te tagi ofert w bibliotece rozliczeniowej.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

informacje o cenach w przypadku nowych lokalizacji, które Google Play może wprowadzić w przyszłości; Jeśli go pominiesz, abonament podstawowy nie będzie automatycznie dostępny w przyszłości w nowych lokalizacjach, które Google Play może wprowadzić.
Pole unii base_plan_type. Typ tego abonamentu podstawowego. Musisz ustawić dokładnie 1 z nich. Po utworzeniu abonamentu podstawowego nie można zmienić jego typu. base_plan_type może być tylko jednym z tych elementów:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Ustaw, kiedy abonament podstawowy ma być automatycznie odnawiany w regularnych odstępach czasu.
prepaidBasePlanType

object (PrepaidBasePlanType)

Ustaw, gdy abonament podstawowy nie jest automatycznie odnawiany na koniec okresu rozliczeniowego.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Ustawione w przypadku abonamentów podstawowych z ratami, w których użytkownik zobowiązuje się do 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 wersji roboczej i nie został jeszcze aktywowany. W tej chwili możesz go 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 automatycznie odnawia się po zakończeniu okresu subskrypcji.

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

string

Wymagane. Niezmienna. Okres subskrypcji określony w formacie ISO 8601. Listę dozwolonych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu planu podstawowego jego długości nie można już zmienić.
gracePeriodDuration

string

Okres próbny subskrypcji podany w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w przedziale od P0D do mniejszej z wartości 30D i okresu rozliczeniowego abonamentu podstawowego.

Jeśli nie podasz tej wartości, zostanie użyta wartość domyślna na podstawie okresu rozliczeniowego.

Łączna długość okresu prolongaty i okresu zawieszenia konta musi wynosić od 30 do 60 dni.
accountHoldDuration

string

Opcjonalnie: Okres wstrzymania subskrypcji na koncie, określony 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 podasz żadnej opcji, domyślną wartością będzie P30D.

Łączna długość okresu prolongaty i okresu zawieszenia konta musi wynosić od 30 do 60 dni.
resubscribeState

enum (ResubscribeState)

Określ, czy użytkownicy powinni mieć możliwość ponownej subskrypcji tego abonamentu podstawowego w Google Play. Jeśli nie zostanie podany, domyślnie przyjmuje się wartość RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Tryb podziału abonamentu podstawowego określa, co się stanie, gdy użytkownik przełączy się na ten abonament z innego abonamentu podstawowego. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

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 można oznaczyć jako zgodny ze starszą wersją tylko jeden odnawiany abonament podstawowy.
legacyCompatibleSubscriptionOfferId

string

Identyfikator oferty subskrypcji, który jest zgodny ze starszymi wersjami.

Zgodna wstecznie oferta subskrypcji jest zwracana do wycofanej metody querySkuDetailsAsync() Biblioteki płatności w Google Play.

W przypadku danego abonamentu podstawowego z odnawianiem można oznaczyć jako zgodny ze starszą wersją tylko jedną ofertę subskrypcji.

Aby nie mieć oferty subskrypcji zgodnej ze starszymi wersjami, pozostaw to pole puste.

ResubscribeState

Stan ponownego subskrybowania abonamentu podstawowego.

Wartości w polu enum
RESUBSCRIBE_STATE_UNSPECIFIED Nieokreślony stan.
RESUBSCRIBE_STATE_ACTIVE Funkcja odnawiania subskrypcji jest aktywna.
RESUBSCRIBE_STATE_INACTIVE Opcja ponownej subskrypcji jest nieaktywna.

SubscriptionProrationMode

Tryb podziału 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ą obciążeni pełną opłatą za nowy abonament podstawowy natychmiast. Pozostały okres obowiązywania obecnej subskrypcji zostanie wykorzystany do przedłużenia okresu rozliczeniowego nowego abonamentu.

PrepaidBasePlanType

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

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

string

Wymagane. Niezmienna. Okres subskrypcji określony w formacie ISO 8601. Listę dozwolonych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu planu podstawowego jego długości nie można już zmienić.
timeExtension

enum (TimeExtension)

Określ, czy użytkownicy powinni mieć możliwość przedłużenia tego abonamentu podstawowego z przedpłatą w Google Play. Jeśli nie zostanie podany, domyślnie przyjmuje się 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 Rozszerzenie czasu jest aktywne. Użytkownicy mogą doładować lub przedłużyć abonament przedpłacony.
TIME_EXTENSION_INACTIVE Rozszerzenie czasowe jest nieaktywne. Użytkownicy nie mogą doładować ani przedłużyć abonamentu przedpłaconego.

InstallmentsBasePlanType

Reprezentuje ratalny abonament podstawowy, w którym użytkownik zobowiązuje się do 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. Niezmienna. Okres subskrypcji określony w formacie ISO 8601. Listę dozwolonych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu planu podstawowego jego długości nie można już zmienić.
committedPaymentsCount

integer

Wymagane. Niezmienna. Liczba płatności, które użytkownik musi uiścić. Po utworzeniu planu podstawowego nie można go zmienić.
renewalType

enum (RenewalType)

Wymagane. Niezmienna. Typ odnowienia abonamentu podstawowego w ratach. Określa zachowanie po zakończeniu początkowego okresu zobowiązania. Po utworzeniu planu podstawowego nie można zmienić typu odnowienia.
gracePeriodDuration

string

Okres próbny subskrypcji podany w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w przedziale od P0D do mniejszej z wartości 30D i okresu rozliczeniowego abonamentu podstawowego.

Jeśli nie podasz tej wartości, zostanie użyta wartość domyślna na podstawie okresu rozliczeniowego.

Łączna długość okresu prolongaty i okresu zawieszenia konta musi wynosić od 30 do 60 dni.
accountHoldDuration

string

Opcjonalnie: Okres wstrzymania subskrypcji na koncie, określony 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 podasz żadnej opcji, domyślną wartością będzie P30D.

Łączna długość okresu prolongaty i okresu zawieszenia konta musi wynosić od 30 do 60 dni.
resubscribeState

enum (ResubscribeState)

Określ, czy użytkownicy powinni mieć możliwość ponownej subskrypcji tego abonamentu podstawowego w Google Play. Jeśli nie zostanie podany, domyślnie przyjmuje się wartość RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Tryb podziału abonamentu podstawowego określa, co się stanie, gdy użytkownik przełączy się na ten abonament z innego abonamentu podstawowego. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Typ odnowienia abonamentu podstawowego w ratach. 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 Odnawia się okresowo na czas trwania okresu rozliczeniowego bez zobowiązań.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT odnowi zobowiązanie o tym samym czasie trwania co pierwotne;

RegionalBasePlanConfig

Konfiguracja abonamentu podstawowego w danym regionie.

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

string

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

boolean

Informacja o tym, czy abonament podstawowy w określonym regionie jest dostępny dla nowych subskrybentów. Jeśli ta wartość zostanie 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

object (Money)

Cena abonamentu podstawowego w określonym regionie. Musi być ustawiony, 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 przypadku nowych lokalizacji, w których usługa Google Play może być dostępna;

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

object (Money)

Wymagane. Cena w USD do użycia w przypadku nowych lokalizacji, w których usługa Google Play może zostać uruchomiona.
eurPrice

object (Money)

Wymagane. Cena w EUR do użycia w przypadku nowych lokalizacji, w których usługa Google Play może zostać uruchomiona.
newSubscriberAvailability

boolean

czy abonament podstawowy jest dostępny dla nowych subskrybentów w nowych lokalizacjach, w których Google Play może być dostępny. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość „False”.

SubscriptionListing

Metadane subskrypcji widoczne dla konsumentów.

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

string

Wymagane. Język tej strony zdefiniowany zgodnie ze standardem BCP-47, np. „pl-PL”.
title

string

Wymagane. Tytuł tej subskrypcji w języku, w którym jest wyświetlana. Zwykły tekst.
benefits[]

string

Lista korzyści wyświetlana użytkownikowi na platformach takich jak Sklep Play oraz w procesach przywracania w języku tej strony aplikacji. Zwykły tekst. Uporządkowana lista maksymalnie 4 korzyści.
description

string

Opis tej subskrypcji w języku, w którym jest wyświetlana strona. Maksymalna długość to 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 obowiązują żadne ograniczenia dotyczące lokalizacji płatności.

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

string

Wymagane. kody regionów, na które mają być nałożone ograniczenia płatności, zdefiniowane zgodnie ze standardem ISO 3166-2, np. „US”.

Metody

archive
(deprecated)

 Nieaktualne: archiwizowanie subskrypcji nie jest obsługiwane.

batchGet

 Czyta co najmniej 1 subskrypcję.

batchUpdate

 Zmienia grupę subskrypcji.

create

 Tworzy nową subskrypcję.

delete

 usuwa subskrypcję.

get

 Czyta jedną subskrypcję.

list

 Wyświetla wszystkie subskrypcje danej aplikacji.

patch

 Aktualizuje istniejącą subskrypcję.