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

Wartość niezmienna. Nazwa pakietu aplikacji nadrzędnej.
productId

string

Wartość niezmienna. Unikalny identyfikator produktu. Unikalny w obrębie aplikacji nadrzędnej. Identyfikatory produktów muszą 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 mieć od 1 do 40 znaków (włącznie).
basePlans[]

object (BasePlan)

Zestaw abonamentów podstawowych dla tej subskrypcji. Reprezentuje 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 dotyczący domyślnego języka aplikacji nadrzędnej.
archived
(deprecated)

boolean

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

object (SubscriptionTaxAndComplianceSettings)

Szczegółowe 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ą nakładane żadne ograniczenia dotyczące lokalizacji płatności.

BasePlan

Pojedynczy abonament podstawowy 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. Wartość niezmienna. Unikalny identyfikator tego abonamentu podstawowego. Musi być unikalny w ramach subskrypcji i zgodny z RFC-1034. Oznacza to, że ten identyfikator może zawierać tylko małe litery (a–z), cyfry (0–9) i łączniki (-) oraz może mieć maksymalnie 63 znaki.
state

enum (State)

Tylko dane wyjściowe. Stan abonamentu podstawowego, czyli informacja o tym, 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 dedykowanych punktów końcowych.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informacje dotyczące poszczególnych regionów dla tego abonamentu podstawowego.
offerTags[]

object (OfferTag)

Lista maksymalnie 20 tagów niestandardowych określonych dla tego abonamentu podstawowego i zwracanych do aplikacji przez bibliotekę płatności. Oferty subskrypcji w ramach tego abonamentu podstawowego również otrzymają te tagi oferty w Bibliotece płatności.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

informacje o cenach w nowych lokalizacjach, które Google Play może wprowadzić w przyszłości. Jeśli pominiesz tę opcję, abonament podstawowy nie będzie automatycznie dostępny w nowych lokalizacjach, które Google Play może w przyszłości obsługiwać.
Pole zbiorcze base_plan_type. Typ abonamentu podstawowego. Musisz ustawić dokładnie jedną z nich. Po utworzeniu abonamentu podstawowego nie można zmienić jego typu. base_plan_type może mieć tylko jedną z tych wartości:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

Ustaw, gdy abonament podstawowy nie odnawia się automatycznie na koniec okresu rozliczeniowego.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Ustaw w przypadku ratalnych abonamentów podstawowych, w ramach 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 Stan nieokreślony.
DRAFT Abonament podstawowy jest obecnie w stanie wersji roboczej i nie został aktywowany. 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ę 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. Wartość niezmienna. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu abonamentu podstawowego nie można zmienić czasu trwania.
gracePeriodDuration

string

Okres prolongaty subskrypcji określony 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, użyta zostanie wartość domyślna na podstawie okresu rozliczeniowego.

Łącznie okres prolongaty i okres zawieszenia konta muszą trwać od 30 do 60 dni.
accountHoldDuration

string

Opcjonalnie: Niestandardowy okres zawieszenia konta w przypadku subskrypcji, określony w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w zakresie od P0D do P60D.

Puste pole oznacza zalecane zawieszenie konta, które jest obliczane jako 60 dni minus okres prolongaty.

Łącznie okres prolongaty i okres zawieszenia konta muszą trwać od 30 do 60 dni.
resubscribeState

enum (ResubscribeState)

Określa, czy użytkownicy powinni mieć możliwość ponownej subskrypcji tego abonamentu podstawowego na platformach Google Play. Jeśli nie zostanie określony, domyślnie przyjmuje wartość RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Tryb proporcjonalny 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ślnie jest to 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.

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

string

Identyfikator oferty subskrypcji zgodnej ze starszymi wersjami.

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

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

Aby nie ustawiać oferty subskrypcji jako 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 Stan nieokreślony.
RESUBSCRIBE_STATE_ACTIVE Ponowna subskrypcja jest aktywna.
RESUBSCRIBE_STATE_INACTIVE Ponowna subskrypcja jest nieaktywna.

SubscriptionProrationMode

Tryb proporcjonalny 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 opłatą za nowy abonament podstawowy na koniec bieżącego okresu rozliczeniowego.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Użytkownicy zostaną natychmiast obciążeni pełną opłatą za nowy abonament podstawowy. Pozostały okres ich obecnej subskrypcji zostanie wykorzystany do przedłużenia czasu trwania nowego abonamentu.

PrepaidBasePlanType

Reprezentuje abonament podstawowy, który nie odnawia się automatycznie po zakończeniu okresu obowiązywania i musi zostać odnowiony ręcznie przez użytkownika.

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

string

Wymagane. Wartość niezmienna. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu abonamentu podstawowego nie można zmienić czasu trwania.
timeExtension

enum (TimeExtension)

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

TimeExtension

Przedłużenie abonamentu podstawowego.

Wartości w polu enum
TIME_EXTENSION_UNSPECIFIED Stan nieokreślony.
TIME_EXTENSION_ACTIVE Dodatkowy czas jest aktywny. Użytkownicy mogą doładować lub przedłużyć abonament przedpłacony.
TIME_EXTENSION_INACTIVE Dodatkowy czas jest nieaktywny. Użytkownicy nie mogą doładować ani przedłużyć abonamentu przedpłaconego.

InstallmentsBasePlanType

Reprezentuje ratalny abonament podstawowy, w ramach którego 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. Wartość niezmienna. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy. Po utworzeniu abonamentu podstawowego nie można zmienić czasu trwania.
committedPaymentsCount

integer

Wymagane. Wartość niezmienna. Liczba płatności, do których zobowiązał się użytkownik. Po utworzeniu abonamentu podstawowego nie można go zmienić.
renewalType

enum (RenewalType)

Wymagane. Wartość niezmienna. Typ odnowienia abonamentu podstawowego na raty. Określa działanie po zakończeniu początkowego zobowiązania. Po utworzeniu abonamentu podstawowego nie można zmienić typu odnowienia.
gracePeriodDuration

string

Okres prolongaty subskrypcji określony 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, użyta zostanie wartość domyślna na podstawie okresu rozliczeniowego.

Łącznie okres prolongaty i okres zawieszenia konta muszą trwać od 30 do 60 dni.
accountHoldDuration

string

Opcjonalnie: Niestandardowy okres zawieszenia konta w przypadku subskrypcji, określony w formacie ISO 8601. Akceptowane wartości muszą być podane w dniach i mieścić się w zakresie od P0D do P60D.

Puste pole oznacza zalecane zawieszenie konta, które jest obliczane jako 60 dni minus okres prolongaty.

Łącznie okres prolongaty i okres zawieszenia konta muszą trwać od 30 do 60 dni.
resubscribeState

enum (ResubscribeState)

Określa, czy użytkownicy powinni mieć możliwość ponownej subskrypcji tego abonamentu podstawowego na platformach Google Play. Jeśli nie zostanie określony, domyślnie przyjmuje wartość RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Tryb proporcjonalny 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ślnie jest to CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Typ odnowienia abonamentu podstawowego na raty. Określa działanie po zakończeniu początkowego zobowiązania. Po utworzeniu abonamentu podstawowego nie można zmienić typu odnowienia.

Wartości w polu enum
RENEWAL_TYPE_UNSPECIFIED Stan nieokreślony.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Odnawia się okresowo przez czas trwania okresu rozliczeniowego bez zobowiązania.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Odnawia się ze zobowiązaniem o tym samym czasie trwania co początkowe.

RegionalBasePlanConfig

Konfiguracja abonamentu podstawowego dla konkretnego regionu.

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-1 alfa-2, np. „PL”.
newSubscriberAvailability

boolean

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

object (Money)

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

OtherRegionsBasePlanConfig

informacje o cenach w nowych lokalizacjach, w których Google Play może zostać uruchomiony;

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

object (Money)

Wymagane. Cena w USD, która będzie obowiązywać we wszystkich nowych lokalizacjach, w których Google Play może zostać uruchomiony.
eurPrice

object (Money)

Wymagane. Cena w EUR, która będzie obowiązywać w nowych lokalizacjach, w których Google Play może zostać uruchomiony.
newSubscriberAvailability

boolean

Czy abonament podstawowy jest dostępny dla nowych subskrybentów w nowych lokalizacjach, w których Google Play może zostać uruchomiony. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość false.

SubscriptionListing

Metadane subskrypcji widoczne dla konsumenta.

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

string

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

string

Wymagane. Tytuł tej subskrypcji w języku tej strony. 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. Zwykły tekst. Lista uporządkowana zawierająca maksymalnie 4 korzyści.
description

string

Opis tej subskrypcji w języku tej strony. Maksymalna długość – 200 znaków. Zwykły tekst.

Metody

archive
(deprecated)

 Wycofane: archiwizowanie subskrypcji nie jest obsługiwane.

batchGet

 Odczytuje co najmniej 1 subskrypcję.

batchUpdate

 Aktualizuje grupę subskrypcji.

create

 Tworzy nową subskrypcję.

delete

 Usuwa subskrypcję.

get

 Odczytuje pojedynczą subskrypcję.

list

 Wyświetla listę wszystkich subskrypcji w danej aplikacji.

patch

 Aktualizuje istniejącą subskrypcję.

Kody błędów

Operacje tego zasobu zwracają te kody błędów HTTP:

Kod błędu Przyczyna Opis Rozdzielczość