REST Resource: monetization.subscriptions.basePlans.offers

Zasób: SubscriptionOffer

Pojedyncza, 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

To pole jest wymagane. Stałe. Nazwa pakietu aplikacji, do której należy subskrypcja nadrzędna.
productId

string

To pole jest wymagane. Stałe. Identyfikator subskrypcji nadrzędnej, do której należy ta oferta.
basePlanId

string

To pole jest wymagane. Stałe. Identyfikator abonamentu podstawowego, do którego przedłużenia jest ta oferta.
offerId

string

To pole jest wymagane. Stałe. 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ń Aktywuj i Dezaktywuj. Uwaga: stan abonamentu podstawowego zastępuje ten stan, więc aktywna oferta może być niedostępna, jeśli abonament podstawowy jest nieaktywny.
phases[]

object (SubscriptionOfferPhase)

To pole jest wymagane. Etapy tej oferty subskrypcji. Musi zawierać co najmniej 1 wpis, ale nie może przekraczać 5. Użytkownicy zawsze będą otrzymywać wszystkie te etapy w określonej kolejności. Po utworzeniu etapów nie można ich dodać, usunąć ani zmienić ich kolejności.
targeting

object (SubscriptionOfferTargeting)

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

object (RegionalSubscriptionOfferConfig)

To pole jest wymagane. Konfiguracja tej oferty zależna od regionu. Musi zawierać co najmniej 1 wpis.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Konfigurowanie nowych lokalizacji w Google Play może zostać wprowadzone w przyszłości.
offerTags[]

object (OfferTag)

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

Stan

Obecny stan oferty subskrypcji.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna nie powinna być nigdy używana.
DRAFT Oferta subskrypcji nie była 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. Istniejący użytkownicy zachowają do niej dostęp.

SubscriptionOfferPhase

Jeden etap oferty subskrypcji.

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

integer

To pole jest wymagane. Liczba powtórzeń tej fazy. Jeśli ten etap oferty nie jest bezpłatny, za każdym razem, gdy cykliczne płatności będą pobierane, użytkownik będzie obciążany ceną tego etapu oferty.
duration

string

To pole jest wymagane. Czas trwania pojedynczego powtarzania tego etapu. Podany w formacie ISO 8601.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

To pole jest wymagane. Zależna od regionu konfiguracja tego etapu oferty. Ta lista musi zawierać dokładnie 1 wpis w każdym regionie, dla którego oferta subskrypcji ma konfigurację regionalną.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

RegionalSubscriptionOfferPhaseConfig

Konfiguracja pojedynczego etapu oferty subskrypcji w jednym 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
  }
  // End of list of possible types for union field price_override.
}
Pola
regionCode

string

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

object (Money)

Cena bezwzględna, jaką płaci użytkownik na tym etapie oferty. Cena nie może być niższa niż minimalna cena dozwolona w tym regionie.
relativeDiscount

number

Odsetek ceny abonamentu podstawowego obliczony proporcjonalnie do czasu trwania tego etapu, który użytkownik opłaca w tym okresie oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez okres 1 roku, rabat w wysokości 50% na etapie 3 miesięcy będzie odpowiadać cenie 1, 50 USD. Rabat musi być określony jako ułamek ściśle większy od 0 i ściśle mniejszy niż 1. Wynikowa cena zostanie zaokrąglona do najbliższej jednostki podlegającej rozliczeniu (np. grosza za PLN). Rabat względny jest uznawany za nieprawidłowy, jeśli obniżona cena okaże się mniejsza niż cena minimalna dozwolona w tym regionie.
absoluteDiscount

object (Money)

Bezwzględna kwota odejmowana od ceny abonamentu podstawowego, proporcjonalna do czasu, jaki użytkownik płaci w ramach tego etapu oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez okres 1 roku, rabat bezwzględny w wysokości 1 USD w fazie 3 miesięcy będzie odpowiadać cenie 2 USD. Ostateczna cena nie może być niższa od ceny minimalnej dozwolonej w tym regionie.
free

object

Określ, czy ta oferta jest dostępna bezpłatnie.

OtherRegionsSubscriptionOfferPhaseConfig

Konfigurowanie nowych lokalizacji, w których Google Play może wprowadzić w ramach pojedynczego etapu oferty.

Zapis JSON 
{

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

object (OtherRegionsSubscriptionOfferPhasePrices)

Cena bezwzględna, jaką płaci użytkownik na tym etapie oferty. Cena nie może być niższa niż minimalna dozwolona cena w każdej nowej lokalizacji, w której Google Play może wprowadzić aplikację na rynek.
relativeDiscount

number

Odsetek ceny abonamentu podstawowego obliczony proporcjonalnie do czasu trwania tego etapu, który użytkownik opłaca w tym okresie oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez okres 1 roku, rabat w wysokości 50% na etapie 3 miesięcy będzie odpowiadać cenie 1, 50 USD. Rabat musi być określony jako ułamek ściśle większy od 0 i ściśle mniejszy niż 1. Wynikowa cena zostanie zaokrąglona do najbliższej jednostki podlegającej rozliczeniu (np. grosza za PLN). Rabat względny jest uznawany za nieważny, jeśli obniżona cena okaże się niższa od ceny minimalnej w dowolnej nowej lokalizacji, w której Google Play może udostępnić aplikację.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Bezwzględna kwota odejmowana od ceny abonamentu podstawowego, proporcjonalna do czasu, jaki użytkownik płaci w ramach tego etapu oferty. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 USD przez okres 1 roku, rabat bezwzględny w wysokości 1 USD w fazie 3 miesięcy będzie odpowiadać cenie 2 USD. Ostateczna cena nie może być niższa od ceny minimalnej dozwolonej w przypadku nowych lokalizacji, w których Google Play może wprowadzić aplikację.
free

object

Określ, czy ta oferta jest dostępna bezpłatnie.

OtherRegionsSubscriptionOfferPhasePrices

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

Zapis JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
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ę.

SubscriptionOfferTargeting

Określa regułę, którą musi spełnić użytkownik, aby 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 być 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ę istniejących abonamentów użytkowników.

AcquisitionTargetingRule

Reprezentuje regułę kierowania w formacie: użytkownik nigdy wcześniej nie miał zakresu {scope}.

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

object (TargetingRuleScope)

To pole jest wymagane. Zakres subskrypcji uwzględnianych przez tę regułę. Zezwala tylko na „tę subskrypcję” i „dowolną subskrypcję w aplikacji”.

TargetingRuleScope

Określa zakres subskrypcji, który reguła kierowania może dopasować, aby kierować oferty na 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 być 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 subskrypcji. Musi to być subskrypcja w tej samej aplikacji nadrzędnej.

TargetingRuleScopeThisSubscription

Ten typ nie ma żadnych pól.

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

TargetingRuleScopeAnySubscriptionInApp

Ten typ nie ma żadnych pól.

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

UpgradeTargetingRule

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

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

boolean

Ogranicz tę ofertę do jednego użytkownika. Jeśli zasada ma wartość Prawda, użytkownik, który kiedykolwiek skorzystał z tej oferty, nie będzie mógł ponownie skorzystać z tej oferty.
scope

object (TargetingRuleScope)

To pole jest wymagane. Zakres subskrypcji uwzględnianych przez tę regułę. Zezwala tylko na „tę subskrypcję” i „konkretną subskrypcję w aplikacji”.
billingPeriodDuration

string

Określony czas trwania okresu rozliczeniowego podany w formacie ISO 8601, który użytkownik musi mieć w danym momencie subskrypcji, aby kwalifikować się do zastosowania tej reguły. Jeśli go nie podasz, uwzględnimy użytkowników, którzy subskrybują dowolny okres rozliczeniowy.

RegionalSubscriptionOfferConfig

Konfiguracja oferty subskrypcji w jednym regionie.

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

string

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

boolean

Określa, czy oferta subskrypcji w wybranym regionie jest dostępna dla nowych subskrybentów. Jeśli ta wartość jest 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).

OtherRegionsSubscriptionOfferConfig

Konfigurację nowych lokalizacji, które Google Play może wprowadzić w określonych warunkach subskrypcji.

Zapis JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Pola
otherRegionsNewSubscriberAvailability

boolean

Czy oferta subskrypcji w jakichkolwiek nowych lokalizacjach może zostać wprowadzona w przyszłości. 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 oferty subskrypcji.

create

 Tworzy nową ofertę subskrypcji.

deactivate

 Dezaktywuje ofertę subskrypcji.

delete

 Usuwa ofertę subskrypcji.

get

 Czyta 1 ofertę

list

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

patch

 Aktualizuje istniejącą ofertę subskrypcji.