REST Resource: monetization.subscriptions.basePlans.offers

Zasób: subscriptionOffer

Jedna, tymczasowa oferta

Zapis JSON 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
Pola
packageName

string

Wymagane. Stały. Nazwa pakietu aplikacji, do której należy subskrypcja nadrzędna.
productId

string

Wymagane. Stały. Identyfikator subskrypcji nadrzędnej, do której należy ta oferta.
basePlanId

string

Wymagane. Stały. Identyfikator abonamentu podstawowego, do którego ta oferta jest rozszerzeniem.
offerId

string

Wymagane. Stały. Unikalny identyfikator tej oferty subskrypcji. Musi być niepowtarzalna w ramach abonamentu podstawowego.
state

enum (State)

Tylko dane wyjściowe. Obecny stan tej oferty. Można je zmienić za pomocą działań aktywacji i dezaktywacji. Uwaga: stan abonamentu podstawowego zastępuje ten stan, więc aktywna oferta może być niedostępna, jeśli abonament podstawowy nie jest aktywny.
phases[]

object (SubscriptionOfferPhase)

Wymagane. Etapy tej oferty subskrypcji. Musi zawierać co najmniej jeden wpis, ale nie więcej niż pięć. Użytkownicy zawsze będą otrzymywać wszystkie te etapy w określonej kolejności. Po utworzeniu etapów nie można ich dodawać, usuwać ani zmieniać ich kolejności.
targeting

object (SubscriptionOfferTargeting)

Wymagania, które użytkownicy muszą spełnić, aby kwalifikować się do skorzystania z tej oferty. Określa wymagania, które Google Play oceni, aby zdecydować, czy oferta powinna zostać zwrócona. Deweloperzy mogą samodzielnie filtrować te oferty.
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Wymagane. Konfiguracja tej oferty w zależności od regionu. Musi zawierać co najmniej 1 wpis.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Konfiguracja wszystkich nowych lokalizacji, które Google Play może wprowadzić w przyszłości.
offerTags[]

object (OfferTag)

Lista maksymalnie 20 tagów niestandardowych określonych dla tej oferty, które są zwracane do aplikacji przez bibliotekę płatności.

Stan

Obecny stan oferty subskrypcji.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna i nigdy nie należy jej używać.
DRAFT Oferta subskrypcji nie jest i nigdy nie była dostępna dla użytkowników.
ACTIVE Oferta subskrypcji jest dostępna dla nowych i obecnych użytkowników.
INACTIVE Oferta subskrypcji nie jest dostępna dla nowych użytkowników. Obecni użytkownicy zachowają dostęp.

SubscriptionOfferPhase

Jeden etap oferty subskrypcji.

Zapis JSON 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Pola
recurrenceCount

integer

Wymagane. Liczba powtórzeń tej fazy. Jeśli ta faza oferty nie jest bezpłatna, każde powtórzenie obciąża użytkownika ceną tego etapu oferty.
duration

string

Wymagane. Czas trwania pojedynczego powtórzenia tej fazy. Podana w formacie ISO 8601.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Wymagane. Konfiguracja tego etapu oferty w zależności od regionu. Ta lista musi zawierać dokładnie 1 wpis dla każdego regionu, dla którego oferta subskrypcji ma konfigurację regionalną.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Informacje o cenach we wszystkich nowych lokalizacjach, w których można wprowadzić Google Play.

RegionalSubscriptionOfferPhaseConfig

Konfiguracja dla pojedynczego etapu oferty subskrypcji w 1 regionie.

Zapis JSON 
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
Pola
regionCode

string

Wymagane. Stały. Region, do którego ma zastosowanie ta konfiguracja.
Pole sumy price_override. Zastąpienie ceny na tym etapie. Wymagane. price_override może mieć tylko jedną z tych wartości:
price

object (Money)

Bezwzględna cena, jaką użytkownik płaci w ramach tego etapu oferty. Cena nie może być niższa od minimalnej ceny dozwolonej w tym regionie.
relativeDiscount

number

Część ceny abonamentu podstawowego proporcjonalna do czasu trwania etapu, który użytkownik płaci za ten etap oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez 1 rok, to 50% zniżki za fazę trwającego 3 miesiące odpowiada cenie 1, 50 USD. Rabat musi być określony jako ułamek większy od 0 i mniejszy niż 1. Wynikowa cena zostanie zaokrąglona do najbliższej jednostki podlegającej rozliczeniu (np. centy w przypadku dolarów amerykańskich). Względny rabat jest uznawany za nieprawidłowy, jeśli obniżona cena będzie niższa niż cena minimalna dozwolona w tym regionie.
absoluteDiscount

object (Money)

Bezwzględna kwota pieniędzy odjęta od ceny abonamentu podstawowego proporcjonalnie do czasu trwania, który użytkownik płaci w ramach tego etapu oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez 1 rok, to rabat bezwzględny w wysokości 1 USD za 3 miesiące odpowiada cenie 2 USD. Cena nie może być niższa od minimalnej ceny dozwolonej w tym regionie.
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Ustaw, aby wskazać, że tę ofertę można uzyskać bezpłatnie.

RegionalSubscriptionOfferPhaseFreePriceOverride

Ten typ nie zawiera pól.

Przedstawia konfigurację zastąpienia ceny bezpłatnej dla pojedynczego etapu oferty subskrypcji

OtherRegionsSubscriptionOfferPhaseConfig

Konfiguracja dla wszystkich nowych lokalizacji, w których Google Play może wprowadzić w ramach pojedynczej oferty.

Zapis JSON 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
Pola
Pole sumy price_override. Zastąpienie ceny na tym etapie. Wymagane. price_override może mieć tylko jedną z tych wartości:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Bezwzględna cena, jaką użytkownik płaci w ramach tego etapu oferty. Cena nie może być niższa od ceny minimalnej dozwolonej we wszystkich nowych lokalizacjach, w których może być wprowadzana Google Play.
relativeDiscount

number

Część ceny abonamentu podstawowego proporcjonalna do czasu trwania etapu, który użytkownik płaci za ten etap oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez 1 rok, to 50% zniżki za fazę trwającego 3 miesiące odpowiada cenie 1, 50 USD. Rabat musi być określony jako ułamek większy od 0 i mniejszy niż 1. Wynikowa cena zostanie zaokrąglona do najbliższej jednostki podlegającej rozliczeniu (np. centy w przypadku dolarów amerykańskich). Względny rabat jest uznawany za nieprawidłowy, jeśli obniżona cena będzie niższa od ceny minimalnej dozwolonej w jakiejkolwiek nowej lokalizacji, w której może pojawić się Google Play.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Bezwzględna kwota pieniędzy odjęta od ceny abonamentu podstawowego proporcjonalnie do czasu trwania, który użytkownik płaci w ramach tego etapu oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez 1 rok, to rabat bezwzględny w wysokości 1 USD za 3 miesiące odpowiada cenie 2 USD. Otrzymana cena nie może być niższa od ceny minimalnej dozwolonej we wszystkich nowych lokalizacjach, w których Google Play może wprowadzić aplikację.
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Ustaw, aby wskazać, że tę ofertę można uzyskać bezpłatnie.

OtherRegionsSubscriptionOfferPhasePrices

Informacje o cenach we wszystkich nowych lokalizacjach, w których można wprowadzić Google Play.

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

object (Money)

Wymagane. Cena w USD do wykorzystania we wszystkich nowych lokalizacjach, w których Google Play może wprowadzić aplikację.
eurPrice

object (Money)

Wymagane. Cena w EUR do wykorzystania we wszystkich nowych lokalizacjach, w których będzie można wprowadzić Google Play.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

Ten typ nie zawiera pól.

Przedstawia konfigurację bezpłatnego zastąpienia ceny we wszystkich nowych lokalizacjach, które Google Play może uruchomić w ramach pojedynczego etapu oferty.

SubscriptionOfferTargeting

Określa regułę, którą musi spełnić użytkownik, by otrzymać tę ofertę.

Zapis JSON 
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
Pola
Pole sumy rule. Aby skorzystać z oferty określonej przez dewelopera, pozostaw to pole puste. rule może mieć tylko jedną z tych wartości:
acquisitionRule

object (AcquisitionTargetingRule)

Reguła kierowania oferty na pozyskiwanie nowych użytkowników.
upgradeRule

object (UpgradeTargetingRule)

Reguła kierowania oferty dotycząca przejścia na wyższą wersję dotychczasowych abonamentów.

AcquisitionTargetingRule

Reprezentuje regułę kierowania taką jak: użytkownik nigdy nie miał zakresu {scope}.

Zapis JSON 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Pola
scope

object (TargetingRuleScope)

Wymagane. Zakres subskrypcji uwzględnianych przez tę regułę. Zezwala tylko na „tę subskrypcję” i „dowolna subskrypcja w aplikacji”.

TargetingRuleScope

Określa zakres subskrypcji, które reguła kierowania może dopasować, aby kierować oferty do użytkowników na podstawie wcześniejszych lub obecnych uprawnień.

Zapis JSON 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
Pola

Pole sumy scope.

scope może mieć tylko jedną z tych wartości:
thisSubscription

object (TargetingRuleScopeThisSubscription)

Zakres bieżącej reguły kierowania to subskrypcja, w której zdefiniowano tę ofertę.
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

Zakres bieżącej reguły kierowania to dowolna subskrypcja w aplikacji nadrzędnej.
specificSubscriptionInApp

string

Zakres bieżącej reguły kierowania to subskrypcja o określonym identyfikatorze. Musi to być subskrypcja w tej samej aplikacji nadrzędnej.

TargetingRuleScopeThisSubscription

Ten typ nie zawiera pól.

Reprezentuje zakres reguły kierowania odpowiadający subskrypcjom, w których zdefiniowano tę ofertę.

TargetingRuleScopeAnySubscriptionInApp

Ten typ nie zawiera pól.

Reprezentuje zakres reguły kierowania odpowiadający dowolnej subskrypcji w aplikacji nadrzędnej.

UpgradeTargetingRule

Reprezentuje regułę kierowania w postaci: Użytkownik ma obecnie zakres {scope} [z okresem rozliczeniowym {billing_period}].

Zapis JSON 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Pola
oncePerUser

boolean

Ogranicz tę ofertę do jednego na użytkownika. Jeśli ma wartość Prawda, użytkownik nigdy nie będzie mógł skorzystać z tej oferty, jeśli kiedykolwiek ją zasubskrybował.
scope

object (TargetingRuleScope)

Wymagane. Zakres subskrypcji uwzględnianych przez tę regułę. Zezwala tylko na „tę subskrypcję” i „konkretna subskrypcja w aplikacji”.
billingPeriodDuration

string

Konkretny okres rozliczeniowy podany w formacie ISO 8601, który użytkownik musi obecnie subskrybować, aby kwalifikować się do zastosowania tej reguły. Jeśli nie określono okresu rozliczeniowego, użytkownicy, którzy zasubskrybowali dowolny okres rozliczeniowy, będą dopasowywani.

RegionalSubscriptionOfferConfig

Konfiguracja oferty subskrypcji w 1 regionie.

Zapis JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Pola
regionCode

string

Wymagane. Stały. Kod regionu, którego dotyczy ta konfiguracja, zgodnie z normą ISO 3166-2, np. „PL”.
newSubscriberAvailability

boolean

Określa, czy oferta subskrypcji w danym regionie jest dostępna dla nowych subskrybentów. Jeśli ta wartość ma wartość Fałsz, obecni subskrybenci nie zostaną anulowane. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość false (fałsz).

OtherRegionsSubscriptionOfferConfig

Konfiguracja dla wszystkich nowych lokalizacji, które Google Play może uruchamiać w określonych lokalizacjach w ramach oferty subskrypcji.

Zapis JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Pola
otherRegionsNewSubscriberAvailability

boolean

Informacja o tym, czy oferta subskrypcji w nowych lokalizacjach może zostać udostępniona w przyszłości w Google Play. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość false (fałsz).

Metody

activate

 Aktywuje ofertę subskrypcji.

batchGet

 Odczytuje co najmniej 1 ofertę subskrypcji.

batchUpdate

 Aktualizuje grupę ofert subskrypcji.

batchUpdateStates

 Aktualizuje grupę stanów ofert subskrypcji.

create

 Tworzy nową ofertę subskrypcji.

deactivate

 Dezaktywuje ofertę subskrypcji.

delete

 Usuwa ofertę subskrypcji.

get

 Odczytuje jedną ofertę

list

 Wyświetla listę wszystkich ofert w ramach danej subskrypcji.

patch

 Aktualizuje istniejącą ofertę subskrypcji.