REST Resource: monetization.subscriptions

Zasób: subskrypcja

Pojedyncza subskrypcja na aplikację.

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

string

Stałe. Nazwa pakietu aplikacji nadrzędnej.

productId

string

Stałe. Unikalny identyfikator produktu. Unikalny w obrębie aplikacji nadrzędnej. Identyfikatory produktów mogą składać się z małych liter (a–z), cyfr (0–9), podkreśleń (_) i kropek (.). Musi zaczynać się małą literą lub cyfrą i mieć od 1 do 40 znaków (włącznie).

basePlans[]

object (BasePlan)

Zestaw abonamentów podstawowych tej subskrypcji. Reprezentuje ceny i czas trwania subskrypcji, jeśli nie mają zastosowania żadne inne oferty.

listings[]

object (SubscriptionListing)

To pole jest 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. Wycofano: archiwizacja subskrypcji nie jest obsługiwana.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Szczegółowe informacje o podatkach i zgodności z przepisami.

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

string

To pole jest wymagane. Stałe. Unikalny identyfikator tego abonamentu podstawowego. Musi być unikalny w obrębie subskrypcji i zgodny ze standardem RFC-1034. Oznacza to, że 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, np. 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. Użyj dedykowanych punktów końcowych.

regionalConfigs[]

object (RegionalBasePlanConfig)

Informacje dotyczące tego abonamentu podstawowego zależne od regionu.

offerTags[]

object (OfferTag)

Lista maksymalnie 20 tagów niestandardowych określonych na potrzeby tego abonamentu podstawowego, które są zwracane do aplikacji za pomocą biblioteki płatności. Oferty subskrypcji w ramach tego abonamentu podstawowego również otrzymają te tagi ofert w bibliotece płatności.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informacje o cenach dla nowych lokalizacji Google Play może zostać wprowadzone w przyszłości. Jeśli go pominiesz, abonament podstawowy 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ć dokładnie jeden. base_plan_type może być 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)

Określ, kiedy abonament podstawowy nie będzie automatycznie odnawiany na koniec 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. Na tym etapie można 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 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

To pole jest wymagane. Okres subskrypcji określony w formacie ISO 8601. Listę akceptowanych okresów rozliczeniowych znajdziesz w Centrum pomocy.

gracePeriodDuration

string

Okres prolongaty subskrypcji, podany w formacie ISO 8601. Akceptowane wartości to P0D (zero dni), P3D (3 dni), P7D (7 dni), P14D (14 dni) i P30D (30 dni). Jeśli nie podasz żadnej wartości, na podstawie długości okresu cyklicznego zostanie użyta wartość domyślna.

accountHoldDuration

string

Opcjonalnie. Okres zawieszenia konta subskrypcji, podany w formacie ISO 8601. Akceptowane wartości muszą być w zakresie DAYS i mieścić się w zakresie 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 subskrybowania tego abonamentu podstawowego na platformach Google Play. Jeśli nie podasz żadnej wartości, domyślna wartość to RESUBSKRYBUJ_STATE_ACTIVE.

prorationMode

enum (SubscriptionProrationMode)

Tryb proporcjonalny abonamentu podstawowego określa, co się dzieje, gdy użytkownik przechodzi na ten abonament z innego abonamentu podstawowego. Jeśli nie określono inaczej, domyślnie jest 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żna oznaczyć jako zgodny ze starszą wersją w przypadku danej subskrypcji.

legacyCompatibleSubscriptionOfferId

string

Identyfikator oferty subskrypcji zgodny ze starszą wersją.

Zgodna wstecznie oferta subskrypcji jest zwracana przez wycofaną metodę 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 mieć żadnej oferty subskrypcji ze zgodnością ze starszą wersją, ustaw to pole jako puste ciąg znaków.

ResubscribeState

Stan ponownej subskrypcji abonamentu podstawowego.

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

SubscriptionProrationMode

Tryb proporcjonalny używany do odnawiania abonamentów podstawowych.

Wartości w polu enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Nieokreślony tryb.
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 opłatą za nowy abonament podstawowy natychmiast i w całości. Każdy pozostały okres obecnej subskrypcji zostanie wykorzystany do przedłużenia nowego abonamentu.

PrepaidBasePlanType

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

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

string

To pole jest 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żania tego przedpłaconego abonamentu podstawowego na platformach Google Play. Jeśli nie zostanie określony, domyślnie przyjmuje się wartość TIME_EXTENSION_ACTIVE.

TimeExtension

Przedłużenie czasu korzystania z abonamentu podstawowego.

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

RegionalBasePlanConfig

Konfiguracja abonamentu podstawowego specyficzna dla regionu.

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

string

To pole jest wymagane. Kod regionu, do którego odnosi się ta konfiguracja, zgodnie z normą ISO 3166-2, np. „US”.

newSubscriberAvailability

boolean

Określa, czy abonament podstawowy w wybranym regionie jest dostępny dla nowych subskrybentów. Jeśli ta wartość będzie ustawiona na false, subskrypcja obecnych subskrybentów nie zostanie anulowana. 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. Należy ją ustawić, jeśli abonament podstawowy jest dostępny dla nowych subskrybentów. Wartość musi być ustawiona w walucie powiązanej z określonym regionem.

OtherRegionsBasePlanConfig

Informacje o cenach dla nowych lokalizacji, w których Google Play może wprowadzić usługę.

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

object (Money)

To pole jest wymagane. Cena w USD przeznaczona do użycia w nowych lokalizacjach, w których Google Play może wprowadzić swoją ofertę.

eurPrice

object (Money)

To pole jest wymagane. Cena w euro do wykorzystania w nowych lokalizacjach, w których Google Play może wprowadzić usługę.

newSubscriberAvailability

boolean

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

SubscriptionListing

Widoczne dla klientów metadane subskrypcji.

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

string

To pole jest wymagane. Język tej informacji podany w dokumencie BCP-47, np. „en-US”.

title

string

To pole jest wymagane. Tytuł subskrypcji w języku strony aplikacji. Zwykły tekst.

benefits[]

string

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

description

string

Opis subskrypcji w języku podanym na stronie. Maksymalna długość to 80 znaków. Zwykły tekst.

Metody

archive
(deprecated)

Wycofano: archiwizacja subskrypcji nie jest obsługiwana.

batchGet

Odczytywanie co najmniej 1 subskrypcji.

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ę.