REST Resource: monetization.subscriptions

Zasób: subskrypcja

Jedna subskrypcja aplikacji.

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

string

Niezmienne. Nazwa pakietu aplikacji nadrzędnej.

productId

string

Niezmienne. Unikalny identyfikator produktu. Unikalny w aplikacji nadrzędnej. Identyfikatory produktów mogą składać się z małych liter (a–z), cyfr (0–9), podkreśleń (_) i kropek (.). Muszą zaczynać się od małej litery lub cyfry i mają od 1 do 40 znaków (włącznie).

basePlans[]

object (BasePlan)

Zestaw abonamentów podstawowych dla tej subskrypcji. Określa ceny i czas trwania subskrypcji, jeśli nie mają zastosowania inne oferty.

listings[]

object (SubscriptionListing)

Wymagany. Lista zlokalizowanych wizytówek tej subskrypcji. Musi zawierać co najmniej wpis dla domyślnego języka aplikacji nadrzędnej.

archived

boolean

Tylko dane wyjściowe. Określa, czy ta subskrypcja jest zarchiwizowana. Zarchiwizowane subskrypcje nie są już dostępne dla żadnego subskrybenta, nie można ich zaktualizować ani zwrócić w odpowiedzi na żądania listy, chyba że zostanie przekazana flaga zarchiwizowanego programu.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Szczegóły dotyczące podatków i zgodności z przepisami.

Abonament podstawowy

Pojedynczy 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)
  }
  // End of list of possible types for union field base_plan_type.
}
Pola
basePlanId

string

Wymagany. Niezmienne. Unikalny identyfikator abonamentu podstawowego. Musi być unikalny w obrębie 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 (-). 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 abonamenty podstawowe można dezaktywować. Nieaktywne abonamenty podstawowe można anulować. Tego pola nie można zmienić przez aktualizację zasobu. Zamiast tego użyj specjalnych punktów końcowych.

regionalConfigs[]

object (RegionalBasePlanConfig)

Informacje dotyczące tego abonamentu podstawowego obowiązujące w poszczególnych regionach.

offerTags[]

object (OfferTag)

Lista maksymalnie 20 tagów niestandardowych określonych w przypadku tego abonamentu podstawowego i zwrócona do aplikacji przez bibliotekę płatności. Oferty subskrypcji tego abonamentu podstawowego również otrzymają te tagi ofert w bibliotece płatności.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

W przyszłości wprowadzimy informacje o cenach wszystkich nowych lokalizacji w Google Play. W przypadku ich pominięcia abonament podstawowy nie będzie automatycznie dostępny w żadnych nowych lokalizacjach, które Play może uruchomić w przyszłości.

Pole sumy: base_plan_type. Typ tego abonamentu podstawowego. Należy podać dokładnie jedną wartość. base_plan_type może mieć tylko jedną z tych wartości:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Określ, kiedy abonament podstawowy ma być automatycznie odnawiany w regularnych odstępach czasu.

prepaidBasePlanType

object (PrepaidBasePlanType)

Określ, kiedy abonament podstawowy nie odnawia się automatycznie po zakończeniu okresu rozliczeniowego.

Stan

Obecny stan abonamentu podstawowego.

Wartości w polu enum
STATE_UNSPECIFIED Nieokreślony stan.
DRAFT Abonament podstawowy jest obecnie w wersji roboczej i nie został aktywowany. W tym momencie można je 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 subskrybentów.

Typ odnowienia abonamentu podstawowego

Reprezentuje abonament podstawowy, który jest automatycznie odnawiany po zakończeniu okresu subskrypcji.

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

string

Wymagany. Okres subskrypcji określony w formacie ISO 8601. Listę dozwolonych okresów rozliczeniowych znajdziesz w Centrum pomocy.

gracePeriodDuration

string

Okres prolongaty subskrypcji podany w formacie ISO 8601. Dopuszczalne wartości to P0D (zero dni), P3D (3 dni), P7D (7 dni), P14D (14 dni) i P30D (30 dni). Jeśli jej nie określisz, użyjemy domyślnej wartości na podstawie czasu trwania okresu cyklicznego.

resubscribeState

enum (ResubscribeState)

Określa, czy użytkownicy powinni mieć możliwość ponownego odnowienia tego abonamentu podstawowego w usługach Google Play. Jeśli nie zostanie podany, wartość domyślna to RESUB_STATE_ACTIVE

prorationMode

enum (SubscriptionProrationMode)

Tryb podziału na abonament podstawowy określa, co się dzieje, gdy użytkownik przechodzi z abonamentu na inny. 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 do wycofanej metody querySkuDetailsAsync() Biblioteki płatności w Google Play.

W ramach danej subskrypcji można oznaczyć tylko 1 odnowiony abonament podstawowy.

legacyCompatibleSubscriptionOfferId

string

Identyfikator oferty subskrypcji, która jest zgodna ze starszą wersją.

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

Tylko 1 ofertę subskrypcji można oznaczyć jako zgodną ze starszą wersją abonamentu podstawowego.

Aby nie oferować oferty subskrypcji jako zgodnej ze starszymi wersjami, ustaw to pole jako pusty ciąg znaków.

Stan ponownej subskrypcji

Stan ponownej subskrypcji abonamentu podstawowego.

Wartości w polu enum
RESUBSCRIBE_STATE_UNSPECIFIED Nieokreślony stan.
RESUBSCRIBE_STATE_ACTIVE Subskrypcja jest aktywna.
RESUBSCRIBE_STATE_INACTIVE Ponowne subskrybowanie jest nieaktywne.

Tryb subskrypcji

Tryb proporcjonalnie 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ą płatnością za nowy abonament podstawowy natychmiast. Wszystkie pozostałe okresy subskrypcji zostaną przedłużone o nowy okres.

Typ abonamentu przedpłaconego

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

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

string

Wymagany. Okres subskrypcji określony w formacie ISO 8601. Listę dozwolonych okresów rozliczeniowych znajdziesz w Centrum pomocy.

timeExtension

enum (TimeExtension)

Określa, czy użytkownicy mogą przedłużyć ten przedpłacony abonament podstawowy na platformach Google Play. Jeśli nie zostanie podany, domyślna wartość to TIME_EXTENSION_ACTIVE.

Rozszerzenie

Rozszerzenie czasowe abonamentu podstawowego.

Wartości w polu enum
TIME_EXTENSION_UNSPECIFIED Nieokreślony stan.
TIME_EXTENSION_ACTIVE Rozszerzenie czasowe 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ć abonamentu przedpłaconego ani z niego korzystać.

RegionalnaKonfiguracjaPlanuPodstaw

Konfiguracja abonamentu podstawowego charakterystycznego dla regionu.

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

string

Wymagany. Kod regionu, którego dotyczy ta konfiguracja, zgodny 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. Dotychczasowi subskrybenci nie będą musieli anulować subskrypcji, jeśli ta wartość będzie ustawiona na „fałsz”. Jeśli nie określisz tego ustawienia, zostanie domyślnie ustawiona wartość fałsz.

price

object (Money)

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

OtherRegionsBasePlanConfig (Inne ustawienia regionów podstawowych)

Informacje o cenach wszystkich nowych lokalizacji, w których możemy uruchomić Google Play.

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

object (Money)

Wymagany. Cena w USD używana w przypadku wszystkich nowych lokalizacji, w których Google Play może zostać wprowadzona.

eurPrice

object (Money)

Wymagany. Cena w euro będzie używana w przypadku wszystkich nowych lokalizacji, w których może być dostępna usługa Google Play.

newSubscriberAvailability

boolean

Czy abonament podstawowy jest dostępny dla nowych subskrybentów w nowych lokalizacjach, w których może zostać uruchomiony Google Play. Jeśli nie określisz tego ustawienia, zostanie domyślnie ustawiona wartość fałsz.

ListaWydań

Metadane subskrypcji widoczne dla klientów.

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

string

Wymagany. Język tej pozycji określony za pomocą BCP-47, np. „pl-PL”.

title

string

Wymagany. Tytuł tej subskrypcji w języku tej strony. Zwykły tekst.

benefits[]

string

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

description

string

Opis tej subskrypcji w języku tej listy. Maksymalna długość: 80 znaków. Zwykły tekst.

Metody

archive

Archiwizuje subskrypcję.

create

Tworzy nową subskrypcję.

delete

Usunięcie subskrypcji.

get

Odczytuje pojedynczą subskrypcję.

list

Wyświetla listę wszystkich subskrypcji w danej aplikacji.

patch

Aktualizuje istniejącą subskrypcję.