REST Resource: monetization.onetimeproducts.purchaseOptions.offers

Zasób: OneTimeProductOffer

Pojedyncza oferta produktu kupowanego raz.

Zapis JSON
{
  "packageName": string,
  "productId": string,
  "purchaseOptionId": string,
  "offerId": string,
  "state": enum (State),
  "regionalPricingAndAvailabilityConfigs": [
    {
      object (RegionalPricingAndAvailabilityConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  },

  // Union field offer_type can be only one of the following:
  "preOrderOffer": {
    object (OneTimeProductPreOrderOffer)
  },
  "discountedOffer": {
    object (OneTimeProductDiscountedOffer)
  }
  // End of list of possible types for union field offer_type.
}
Pola
packageName

string

Wymagane. Niezmienne. Nazwa pakietu aplikacji, do której należy produkt nadrzędny.

productId

string

Wymagane. Niezmienne. Identyfikator produktu nadrzędnego, do którego należy ta oferta.

purchaseOptionId

string

Wymagane. Niezmienne. Identyfikator opcji zakupu, której ta oferta jest rozszerzeniem.

offerId

string

Wymagane. Niezmienne. Identyfikator tej oferty produktu. Musi być unikalny w obrębie opcji zakupu. Musi zaczynać się od cyfry lub małej litery i może zawierać tylko małe litery (a–z), cyfry (0–9) i łączniki (-). Maksymalna długość to 63 znaki.

state

enum (State)

Tylko dane wyjściowe. Bieżący stan tej oferty. Tego pola nie można zmienić, aktualizując zasób. Zamiast tego używaj dedykowanych punktów końcowych.

regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

Zestaw informacji o regionalnych cenach i dostępności tej oferty. Nie może zawierać zduplikowanych wpisów z tym samym kodem regionu.

offerTags[]

object (OfferTag)

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

regionsVersion

object (RegionsVersion)

Tylko dane wyjściowe. Wersja konfiguracji regionów, która została użyta do wygenerowania oferty produktu kupowanego raz.

Pole unii offer_type. Typ tej oferty. Musisz ustawić dokładnie jedną wartość. offer_type może mieć tylko jedną z tych wartości:
preOrderOffer

object (OneTimeProductPreOrderOffer)

oferta w przedsprzedaży;

discountedOffer

object (OneTimeProductDiscountedOffer)

oferta z rabatem;

Stan

Bieżący stan oferty.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna, której nigdy nie należy używać.
DRAFT Oferta nie jest i nigdy nie była dostępna dla użytkowników.
ACTIVE Oferta jest dostępna dla użytkowników, o ile spełniają oni jej warunki.
CANCELLED Ten stan dotyczy zamówień w przedsprzedaży. Oferta zostanie anulowana i nie będzie dostępna dla użytkowników. Wszystkie zamówienia oczekujące powiązane z tą ofertą zostały anulowane.
INACTIVE Ten stan dotyczy tylko ofert z rabatem. Oferta jest już niedostępna dla użytkowników.

OneTimeProductPreOrderOffer

Konfiguracja specyficzna dla ofert w przedsprzedaży.

Zapis JSON
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
Pola
startTime

string (Timestamp format)

Wymagane. Czas, w którym zamówienie w przedsprzedaży będzie dostępne.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Wymagane. Czas, w którym zamówienie w przedsprzedaży przestanie być dostępne.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

releaseTime

string (Timestamp format)

Wymagane. Czas, w którym produkt powiązany z zamówieniem w przedsprzedaży zostanie udostępniony, a zamówienia w przedsprzedaży zostaną zrealizowane.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

priceChangeBehavior

enum (PreOrderPriceChangeBehavior)

Wymagane. Niezmienne. Określa, jak zmiany cen wpływają na istniejące zamówienia w przedsprzedaży.

PreOrderPriceChangeBehavior

Określa, jak zmiany cen wpływają na istniejące zamówienia w przedsprzedaży.

Wartości w polu enum
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED Nieokreślone zachowanie zmiany ceny. Nie można używać.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST Kupujący zapłaci niższą kwotę pomiędzy początkową ceną w momencie zakupu w przedsprzedaży a ostateczną ceną w dniu premiery.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY Kupujący otrzyma produkt w cenie, w jakiej zamówił go w przedsprzedaży, niezależnie od zmian cen, które mogły nastąpić po złożeniu zamówienia.

OneTimeProductDiscountedOffer

Konfiguracja dotycząca ofert z rabatem.

Zapis JSON
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
Pola
startTime

string (Timestamp format)

Godzina, od której oferta będzie dostępna.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Czas, w którym oferta przestanie być dostępna.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

redemptionLimit

string (int64 format)

Opcjonalnie. Określa, ile razy można wykorzystać tę ofertę. Jeśli ta opcja jest nieustawiona lub ma wartość 0, pozwala na nieograniczone wykorzystanie ofert. W pozostałych przypadkach musi to być liczba z zakresu od 1 do 50 włącznie.

RegionalPricingAndAvailabilityConfig

Konfiguracja regionalnej ceny i dostępności w przypadku oferty produktu jednorazowego.

Zapis JSON
{
  "regionCode": string,
  "availability": enum (Availability),

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

string

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

availability

enum (Availability)

Wymagane. Dostępność w tym regionie.

Pole unii price_override. Cena zastępcza tej oferty. Musisz ustawić dokładnie jedną wartość. price_override może mieć tylko jedną z tych wartości:
noOverride

object (OneTimeProductOfferNoPriceOverrideOptions)

Zostanie użyta cena zdefiniowana w opcji zakupu dla tego regionu.

relativeDiscount

number

Ułamek ceny opcji zakupu, którą użytkownik płaci za tę ofertę. Jeśli na przykład cena opcji zakupu w tym regionie wynosi 12 PLN, rabat 50% odpowiada cenie 6 PLN. Rabat musi być określony jako ułamek większy od 0 i mniejszy od 1. Wynikowa cena zostanie zaokrąglona do najbliższej jednostki rozliczeniowej (np. centów w przypadku USD). Rabat względny jest uznawany za nieprawidłowy, jeśli cena po rabacie jest niższa niż minimalna cena dopuszczalna w tym regionie.

absoluteDiscount

object (Money)

Wartość bezwzględna rabatu, który jest odejmowany od ceny opcji zakupu.

Powinna mieścić się w zakresie od 0 do ceny opcji zakupu.

OneTimeProductOfferNoPriceOverrideOptions

Ten typ nie ma pól.

Opcje ofert produktów kupowanych raz bez zastąpienia ceny regionalnej.

Dostępność

Dostępność oferty.

Wartości w polu enum
AVAILABILITY_UNSPECIFIED Nieokreślona dostępność. Nie można używać.
AVAILABLE Oferta jest dostępna dla użytkowników.
NO_LONGER_AVAILABLE Oferta jest już niedostępna dla użytkowników. Tej wartości można użyć tylko wtedy, gdy dostępność została wcześniej ustawiona jako AVAILABLE.

Metody

activate

Aktywuje ofertę produktu kupowanego raz.

batchDelete

Usuwa co najmniej jedną ofertę produktu kupowanego raz.

batchGet

Odczytuje co najmniej jedną ofertę dotyczącą produktu kupowanego raz.

batchUpdate

Tworzy lub aktualizuje co najmniej jedną ofertę produktu kupowanego raz.

batchUpdateStates

Aktualizuje stan pakietu ofert produktów kupowanych raz.

cancel

Anuluje ofertę produktu kupowanego raz.

deactivate

Dezaktywuje ofertę produktu kupowanego raz.

list

Zawiera listę wszystkich ofert w danej aplikacji, produkcie lub opcji zakupu.