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

Stały Nazwa pakietu aplikacji nadrzędnej.

productId

string

Stały Unikalny identyfikator produktu. Unikalny w aplikacji nadrzędnej. Identyfikatory mogą 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 mają od 1 do 40 znaków (włącznie).

basePlans[]

object (BasePlan)

Zestaw abonamentów podstawowych tej subskrypcji. Określa ceny i czas trwania subskrypcji, jeśli nie ma żadnych innych ofert.

listings[]

object (SubscriptionListing)

Wymagane. apks.list zlokalizowanych wizytówek tej subskrypcji. Musi zawierać co najmniej jeden wpis w domyślnym języku aplikacji nadrzędnej.

archived

boolean

Tylko dane wyjściowe. Określa, czy subskrypcja jest zarchiwizowana. Zarchiwizowane subskrypcje nie są już dostępne dla żadnego subskrybenta, nie można ich aktualizować i nie są zwracane w żądaniach listy, chyba że zostanie przekazana flaga zarchiwizowanego programu.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

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

abonament podstawowy

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

string

Wymagany. Stały Niepowtarzalny identyfikator tego abonamentu podstawowego. Musi być niepowtarzalna w subskrypcji i zgodna 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ść wynosi 63 znaki.

state

enum (State)

Tylko dane wyjściowe. Stan abonamentu podstawowego, czyli czy jest aktywny. Wersje robocze i nieaktywne subskrypcje podstawowe można aktywować lub usunąć. Aktywne abonamenty podstawowe mogą być nieaktywne. Nieaktywne abonamenty podstawowe można anulować. Tego pola nie można zmienić, aktualizując zasób. Zamiast tego użyj specjalnych punktów końcowych.

regionalConfigs[]

object (RegionalBasePlanConfig)

Informacje dotyczące regionu w przypadku tego abonamentu podstawowego.

offerTags[]

object (OfferTag)

Plik apks.list zawierający maksymalnie 20 tagów niestandardowych określonych w przypadku tego abonamentu podstawowego i wyświetlony w aplikacji za pomocą biblioteki płatności. Oferty subskrypcji dla tego abonamentu podstawowego otrzymają też te tagi ofert w bibliotece płatności.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

W przyszłości udostępnimy nowe ceny nowych lokalizacji w Google Play. Jeśli ją pominiesz, abonament podstawowy nie będzie automatycznie dostępny w przyszłości w nowych lokalizacjach.

Pole związkowe base_plan_type. Typ tego abonamentu podstawowego. Należy ustawić 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.

prepaidBasePlanType

object (PrepaidBasePlanType)

Określ, kiedy abonament podstawowy nie jest automatycznie odnawiany na koniec okresu rozliczeniowego.

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ł aktywowany. Tutaj możesz bezpiecznie go 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.

Typ abonamentu podstawowego odnawianego automatycznie

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 podany w formacie ISO 8601. Listę dopuszczalnych 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), P1DD (14 dni) i P30D (30 dni). Jeśli zasada nie zostanie określona, używana będzie wartość domyślna na podstawie czasu trwania okresu.

resubscribeState

enum (ResubscribeState)

Określa, czy użytkownicy powinni mieć możliwość ponownego odnowienia tego abonamentu podstawowego na platformach Google Play. Jeśli nie zostanie podany, wartość domyślna to RESUBSCRIBE_STATE_ACTIVE.

prorationMode

enum (SubscriptionProrationMode)

Tryb proporcjonalny na potrzeby 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ślną wartością będzie CHARGE_ON_NEXT_Billing_DATE.

legacyCompatible

boolean

Określa, czy odnawiany abonament podstawowy jest wstecznie zgodny.

Zgodność abonamentu podstawowego jest wstecznie zwracana przez wycofaną metodę querySkuDetailsAsync() Biblioteki płatności w Google Play.

Tylko 1 odnowiony abonament podstawowy może być oznaczony jako zgodny z daną subskrypcją.

legacyCompatibleSubscriptionOfferId

string

Identyfikator oferty subskrypcji, która jest zgodna ze starszymi wersjami.

Oferta subskrypcji zgodna wstecznie jest zwracana przez wycofaną metodę querySkuDetailsAsync() Biblioteki płatności w Google Play. Dla danego odnowienia abonamentu podstawowego można oznaczyć tylko jedną ofertę subskrypcji. Aby żadna oferta subskrypcji nie była zgodna ze starszą wersją, 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 Subskrypcja jest nieaktywna.

Tryb subskrypcji

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 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 płatnością za nowy abonament podstawowy natychmiast i w całości. Pozostały czas z dotychczasowej subskrypcji zostanie przedłużony przez nowy okres rozliczeniowy.

Typ abonamentu przedpłaconego

Reprezentuje abonament podstawowy, który nie jest automatycznie odnawiany na koniec abonamentu podstawowego i musi zostać przedłużony ręcznie przez użytkownika.

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

string

Wymagany. Okres subskrypcji podany w formacie ISO 8601. Listę dopuszczalnych 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, wartość domyślna 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ć abonament przedpłacony lub ją przedłużyć.
TIME_EXTENSION_INACTIVE Rozszerzenie czasu jest nieaktywne. Użytkownicy nie mogą doładować ani przedłużyć abonamentu przedpłaconego.

Regionalna konfiguracja abonamentu podstawowego

Konfiguracja abonamentu podstawowego zależnego od regionu.

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

string

Wymagany. Kod regionu, którego dotyczy ta konfiguracja, zgodnie z normą ISO 3166-2, np. "US".

newSubscriberAvailability

boolean

Określa, czy abonament podstawowy w danym regionie jest dostępny dla nowych subskrybentów. Jeśli obecna wartość jest ustawiona jako fałsz, subskrypcja nie zostanie anulowana. Jeśli nie zostanie podana, wartością domyślną będzie false (fałsz).

price

object (Money)

Cena abonamentu podstawowego w wybranym regionie. Wartość musi być ustawiona, jeśli abonament podstawowy jest dostępny dla nowych subskrybentów. Musi być ustawiony w walucie połączonej z określonym regionem.

OtherRegionsBasePlanConfig

Informacje o cenach wszystkich nowych lokalizacji, w których może zostać uruchomiony Google Play.

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

object (Money)

Wymagany. Cena w dolarach amerykańskich do wykorzystania w każdej nowej lokalizacji, w której aplikacja może być dostępna w Google Play.

eurPrice

object (Money)

Wymagany. Cena w euro do wykorzystania w nowych lokalizacjach, w których aplikacja może być dostępna w Google Play.

newSubscriberAvailability

boolean

Określa, czy abonament podstawowy jest dostępny dla nowych subskrybentów we wszystkich nowych lokalizacjach, w których może zostać uruchomiony Google Play. Jeśli nie zostanie podana, wartością domyślną będzie false (fałsz).

Lista subskrypcji

Metadane subskrypcji widoczne dla klientów.

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

string

Wymagany. Język tej listy, zgodnie z definicją BCP-47, np. "en-US".

title

string

Wymagany. Tytuł tej subskrypcji jest podany w języku, którego dotyczą informacje. Zwykły tekst.

benefits[]

string

Lista korzyści wyświetlanych użytkownikowi na platformach takich jak Sklep Play i w procedurze przywracania (w języku informacji o aplikacji). Zwykły tekst. Lista zamówionych maks. 4 korzyści.

description

string

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

Metody

archive

Archiwizuje subskrypcję.

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