REST Resource: monetization.subscriptions.basePlans.offers

Zasób: SubscriptionOffer

jedną tymczasową ofertę,

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. Niezmienna. Nazwa pakietu aplikacji, do której należy subskrypcja nadrzędna.
productId

string

Wymagane. Niezmienna. Identyfikator abonamentu nadrzędnego, do którego należy ta oferta.
basePlanId

string

Wymagane. Niezmienna. Identyfikator abonamentu podstawowego, którego rozszerzeniem jest ta oferta.
offerId

string

Wymagane. Niezmienna. Unikalny identyfikator tej oferty subskrypcji. Musi być niepowtarzalna w ramach planu podstawowego.
state

enum (State)

Tylko dane wyjściowe. bieżący 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 nie jest aktywny.
phases[]

object (SubscriptionOfferPhase)

Wymagane. Etapy oferty subskrypcji. Musi zawierać co najmniej 1 i maksymalnie 2 elementy. Użytkownicy zawsze będą przechodzić wszystkie te etapy w określonej kolejności.
targeting

object (SubscriptionOfferTargeting)

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

object (RegionalSubscriptionOfferConfig)

Wymagane. Konfiguracja tej oferty dostosowanej do regionu. Musi zawierać co najmniej 1 wpis.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

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

object (OfferTag)

Lista do 20 tagów niestandardowych określonych dla tej oferty i zwróconych do aplikacji za pomocą biblioteki rozliczeniowej.

Stan

Obecny stan oferty subskrypcji.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna, której nigdy nie należy 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. Dostęp do usługi nie zostanie utracony przez dotychczasowych użytkowników.

SubscriptionOfferPhase

Pojedyncza faza oferty subskrypcji.

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

integer

Wymagane. Liczba powtórzeń tego etapu. Jeśli ta faza oferty nie jest bezpłatna, za każde odnowienie użytkownikowi zostanie naliczona cena tej fazy oferty.
duration

string

Wymagane. Czas trwania pojedynczego powtórzenia tego etapu. W formacie ISO 8601.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Wymagane. Konfiguracja tej fazy oferty dostosowana do regionu. Lista musi zawierać dokładnie 1 pozycję dla każdego regionu, w którym oferta subskrypcji ma konfigurację regionalną.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

informacje o cenach w przypadku nowych lokalizacji, w których usługa Google Play może być dostępna;

RegionalSubscriptionOfferPhaseConfig

Konfiguracja pojedynczej fazy oferty subskrypcji w pojedynczym 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. Niezmienna. Region, w którym obowiązuje ta konfiguracja.
Pole unii price_override. Cena zastępcza dla tej fazy. Wymagane. price_override może być tylko jednym z tych elementów:
price

object (Money)

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

number

Ułamek ceny abonamentu podstawowego proporcjonalnie do czasu trwania etapu, za który użytkownik płaci. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 PLN za 1 rok, rabat w wysokości 50% na okres 3 miesięcy odpowiadałby cenie 1, 50 PLN. Rabat musi być podany jako ułamek większy od 0 i mniejszy od 1. Otrzymana cena zostanie zaokrąglona do najbliższej jednostki rozliczeniowej (np. centy w przypadku USD). Rabat względny jest uznawany za nieprawidłowy, jeśli cena po rabacie jest mniejsza niż minimalna cena dozwolona w danym regionie.
absoluteDiscount

object (Money)

Bezwzględna kwota pieniędzy odjęta od ceny abonamentu podstawowego proporcjonalnie do czasu trwania etapu, za który użytkownik płaci. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 PLN za 1 rok, rabat bezwzględny w wysokości 1 PLN na okres 3 miesięcy odpowiadałby cenie 2 PLN. Wynikowa cena nie może być niższa niż minimalna cena dozwolona w tym regionie.
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Ustaw, aby określić, że ta oferta jest bezpłatna.

RegionalSubscriptionOfferPhaseFreePriceOverride

Ten typ nie ma pól.

Reprezentuje konfigurację zastąpienia bezpłatnej ceny w przypadku pojedynczego etapu oferty subskrypcji.

OtherRegionsSubscriptionOfferPhaseConfig

Konfiguracja nowych lokalizacji, w których Google Play może uruchomić ofertę.

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 unii price_override. Cena zastępcza dla tej fazy. Wymagane. price_override może być tylko jednym z tych elementów:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Cena bezwzględna, jaką użytkownik płaci w ramach danej fazy oferty. Cena nie może być niższa niż minimalna cena dozwolona w przypadku nowych lokalizacji, w których usługa Google Play może być dostępna.
relativeDiscount

number

Ułamek ceny abonamentu podstawowego proporcjonalnie do czasu trwania etapu, za który użytkownik płaci. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 PLN za 1 rok, rabat w wysokości 50% na okres 3 miesięcy odpowiadałby cenie 1, 50 PLN. Rabat musi być podany jako ułamek większy od 0 i mniejszy od 1. Otrzymana cena zostanie zaokrąglona do najbliższej jednostki rozliczeniowej (np. centy w przypadku USD). Rabat względny jest uważany za nieprawidłowy, jeśli cena po rabacie jest mniejsza niż minimalna dozwolona cena w dowolnych nowych lokalizacjach, w których może być dostępny Sklep Play.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Bezwzględna kwota pieniędzy odjęta od ceny abonamentu podstawowego proporcjonalnie do czasu trwania etapu, za który użytkownik płaci. Jeśli na przykład cena abonamentu podstawowego w tym regionie wynosi 12 PLN za 1 rok, rabat bezwzględny w wysokości 1 PLN na okres 3 miesięcy odpowiadałby cenie 2 PLN. Wynikająca z tego cena nie może być niższa niż minimalna cena dozwolona w przypadku nowych lokalizacji, w których usługa Google Play może być dostępna.
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Ustaw, aby określić, że ta oferta jest bezpłatna.

OtherRegionsSubscriptionOfferPhasePrices

informacje o cenach w przypadku nowych lokalizacji, w których usługa Google Play może być dostępna;

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

object (Money)

Wymagane. Cena w USD do użycia w przypadku nowych lokalizacji, w których usługa Google Play może zostać uruchomiona.
eurPrice

object (Money)

Wymagane. Cena w EUR do użycia w przypadku nowych lokalizacji, w których usługa Google Play może zostać uruchomiona.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

Ten typ nie ma pól.

Reprezentuje konfigurację zastąpienia bezpłatnej ceny dla nowych lokalizacji, które Google Play może wprowadzić w ramach pojedynczej fazy oferty.

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 unii rule. Pozostaw to pole puste, aby zakwalifikować się do skorzystania z oferty określonej przez dewelopera. rule może być tylko jednym z tych elementów:
acquisitionRule

object (AcquisitionTargetingRule)

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

object (UpgradeTargetingRule)

Reguła kierowania oferty na użytkowników, którzy przechodzą na wyższy abonament.

AcquisitionTargetingRule

Reprezentuje regułę kierowania w postaci: użytkownik nigdy wcześniej nie miał {zakres}.

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

object (TargetingRuleScope)

Wymagane. Zakres subskrypcji uwzględnianych przez tę regułę. Dozwolone są tylko opcje „ta subskrypcja” i „dowolna subskrypcja w aplikacji”.

TargetingRuleScope

Określa zakres subskrypcji, które reguła kierowania może dopasowywać do ofert kierowanych do użytkowników na podstawie ich wcześniejszych lub bieżących 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 unii scope.

scope może być tylko jednym z tych elementów:
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 obejmuje wszystkie subskrypcje w aplikacji nadrzędnej.
specificSubscriptionInApp

string

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

TargetingRuleScopeThisSubscription

Ten typ nie ma pól.

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

TargetingRuleScopeAnySubscriptionInApp

Ten typ nie ma pól.

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

UpgradeTargetingRule

Reprezentuje regułę kierowania o tym kształcie: użytkownik ma obecnie {scope} [z okresem rozliczeniowym {billing_period}].

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

boolean

ograniczyć tę ofertę do 1 raza na użytkownika; Jeśli ma wartość prawda, użytkownik nie może ponownie skorzystać z tej oferty, jeśli kiedykolwiek ją subskrybował.
scope

object (TargetingRuleScope)

Wymagane. Zakres subskrypcji uwzględnianych przez tę regułę. Dozwolone są tylko opcje „ta subskrypcja” i „konkretna subskrypcja w aplikacji”.
billingPeriodDuration

string

Okres rozliczeniowy określony w formacie ISO 8601, na który użytkownik musi mieć obecnie subskrypcję, aby kwalifikować się do skorzystania z tej reguły. Jeśli nie zostanie określone, dopasowywane są użytkownicy, którzy subskrybują dowolny okres rozliczeniowy.

RegionalSubscriptionOfferConfig

Konfiguracja oferty subskrypcji w jednym regionie.

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

string

Wymagane. Niezmienna. Kod regionu, którego dotyczy ta konfiguracja, zgodnie ze standardem ISO 3166-2, np. „PL”.
newSubscriberAvailability

boolean

Określa, czy oferta subskrypcji w określonym regionie jest dostępna dla nowych subskrybentów. Jeśli ta wartość zostanie ustawiona na „false”, subskrypcje obecnych subskrybentów nie zostaną anulowane. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość „False”.

OtherRegionsSubscriptionOfferConfig

Konfiguracja nowych lokalizacji, w których Google Play może być dostępna, zgodnie z określoną ofertą subskrypcji.

Zapis JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Pola
otherRegionsNewSubscriberAvailability

boolean

Czy oferta subskrypcji w nowych lokalizacjach, które Google Play może wprowadzić w przyszłości. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość „False”.

Metody

activate

 Aktywuje ofertę subskrypcji.

batchGet

 Czyta co najmniej 1 ofertę subskrypcji.

batchUpdate

 Aktualizuje grupę ofert subskrypcji.

batchUpdateStates

 Aktualizuje zbiorczy stan oferty 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.