REST Resource: monetization.onetimeproducts.purchaseOptions.offers

Ressource: OneTimeProductOffer

Ein einzelnes Angebot für ein Einmalkaufprodukt.

JSON-Darstellung 
{
  "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.
}
Felder
packageName

string

Erforderlich. Nicht veränderbar. Der Paketname der App, zu der das übergeordnete Produkt gehört.
productId

string

Erforderlich. Nicht veränderbar. Die ID des übergeordneten Produkts, zu dem dieses Angebot gehört.
purchaseOptionId

string

Erforderlich. Nicht veränderbar. Die ID der Kaufoption, auf die sich dieses Angebot bezieht.
offerId

string

Erforderlich. Nicht veränderbar. Die ID dieses Produktangebots. Muss innerhalb der Kaufoption eindeutig sein. Der Text muss mit einer Zahl oder einem Kleinbuchstaben beginnen und darf nur Kleinbuchstaben (a–z), Zahlen (0–9) und Bindestriche (-) enthalten. Die maximale Länge beträgt 63 Zeichen.
state

enum (State)

Nur Ausgabe. Der aktuelle Status dieses Angebots. Dieses Feld kann nicht durch Aktualisieren der Ressource geändert werden. Verwenden Sie stattdessen die entsprechenden Endpunkte.
regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

Eine Reihe von regionalen Preis- und Verfügbarkeitsinformationen für dieses Angebot. Es dürfen keine doppelten Einträge mit demselben „regionCode“ vorhanden sein.
offerTags[]

object (OfferTag)

Optional. Liste mit bis zu 20 benutzerdefinierten Tags, die für dieses Angebot angegeben und über die Abrechnungsbibliothek an die App zurückgegeben werden.
regionsVersion

object (RegionsVersion)

Nur Ausgabe. Die Version der Regionskonfiguration, die zum Generieren des Angebots für das Einmalkaufprodukt verwendet wurde.
Union-Feld offer_type. Der Typ dieses Angebots. Genau eines muss festgelegt werden. Für offer_type ist nur einer der folgenden Werte zulässig:
preOrderOffer

object (OneTimeProductPreOrderOffer)

Ein Vorbesteller-Angebot.
discountedOffer

object (OneTimeProductDiscountedOffer)

Ein ermäßigtes Angebot.

Bundesland

Der aktuelle Status des Angebots.

Enums
STATE_UNSPECIFIED Standardwert, sollte niemals verwendet werden.
DRAFT Das Angebot ist und war für Nutzer nie verfügbar.
ACTIVE Das Angebot ist für Nutzer verfügbar, solange die Bedingungen erfüllt sind.
CANCELLED Dieser Status ist spezifisch für Vorbestellungen. Das Angebot wurde gekündigt und ist für Nutzer nicht mehr verfügbar. Alle ausstehenden Bestellungen im Zusammenhang mit diesem Angebot wurden storniert.
INACTIVE Dieser Status gilt nur für Angebote mit Rabatt. Das Angebot ist für Nutzer nicht mehr verfügbar.

OneTimeProductPreOrderOffer

Konfiguration speziell für Vorbesteller-Angebote.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
Felder
startTime

string (Timestamp format)

Erforderlich. Zeitpunkt, zu dem die Vorbestellung verfügbar ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
endTime

string (Timestamp format)

Erforderlich. Uhrzeit, zu der die Vorbestellung nicht mehr möglich ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
releaseTime

string (Timestamp format)

Erforderlich. Uhrzeit, zu der das mit der Vorbestellung verknüpfte Produkt veröffentlicht und die Vorbestellungen ausgeführt werden.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
priceChangeBehavior

enum (PreOrderPriceChangeBehavior)

Erforderlich. Nicht veränderbar. Gibt an, wie sich Preisänderungen auf bestehende Vorbestellungen auswirken.

PreOrderPriceChangeBehavior

Gibt an, wie sich Preisänderungen auf bestehende Vorbestellungen auswirken.

Enums
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED Nicht angegebenes Verhalten bei Preisänderungen. Darf nicht verwendet werden.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST Dem Käufer wird der niedrigere der beiden Preise berechnet: der ursprüngliche Preis zum Zeitpunkt der Vorbestellung oder der endgültige Angebotspreis am Veröffentlichungsdatum.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY Der Käufer erhält den Artikel zum Preis der Vorbestellung, unabhängig von Preisänderungen, die nach der Vorbestellung erfolgt sind.

OneTimeProductDiscountedOffer

Konfiguration für Angebote mit Rabatt.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
Felder
startTime

string (Timestamp format)

Zeitpunkt, zu dem das Angebot verfügbar ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Uhrzeit, zu der das Angebot nicht mehr verfügbar ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
redemptionLimit

string (int64 format)

Optional. Wie oft dieses Angebot eingelöst werden kann. Wenn der Wert nicht festgelegt oder auf 0 gesetzt ist, sind unbegrenzte Einlösungen von Angeboten möglich. Andernfalls muss es eine Zahl zwischen 1 und 50 (einschließlich) sein.

RegionalPricingAndAvailabilityConfig

Konfiguration regionaler Preise und Verfügbarkeit für ein Einmalkaufprodukt-Angebot.

JSON-Darstellung 
{
  "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.
}
Felder
regionCode

string

Erforderlich. Regionscode, für den diese Konfiguration gilt, wie in ISO 3166-2 definiert, z.B. „US“.
availability

enum (Availability)

Erforderlich. Die Verfügbarkeit für diese Region.
Union-Feld price_override. Die Preisüberschreibung dieses Angebots. Genau eines muss festgelegt werden. Für price_override ist nur einer der folgenden Werte zulässig:
noOverride

object (OneTimeProductOfferNoPriceOverrideOptions)

Es wird der in der Kaufoption für diese Region definierte Preis verwendet.
relativeDiscount

number

Der Bruchteil des Preises der Kaufoption, den der Nutzer für dieses Angebot bezahlt. Wenn der Preis der Kaufoption für diese Region beispielsweise 12 $beträgt, entspricht ein Rabatt von 50% einem Preis von 6 $. Der Rabatt muss als Bruch angegeben werden, der größer als 0 und kleiner als 1 ist. Der resultierende Preis wird auf die nächste abrechenbare Einheit gerundet (z.B. Cent für US-Dollar). Der relative Rabatt gilt als ungültig, wenn der Rabattpreis unter dem in dieser Region zulässigen Mindestpreis liegt.
absoluteDiscount

object (Money)

Der absolute Wert des Rabatts, der vom Preis der Kaufoption abgezogen wird.

Er sollte zwischen 0 und dem Preis der Kaufoption liegen.

OneTimeProductOfferNoPriceOverrideOptions

Dieser Typ hat keine Felder.

Optionen für Angebote für Einmalkaufprodukte ohne regionale Preisüberschreibung.

Verfügbarkeit

Die Verfügbarkeit des Angebots.

Enums
AVAILABILITY_UNSPECIFIED Nicht angegebene Verfügbarkeit Darf nicht verwendet werden.
AVAILABLE Das Angebot ist für Nutzer verfügbar.
NO_LONGER_AVAILABLE Das Angebot ist für Nutzer nicht mehr verfügbar. Dieser Wert kann nur verwendet werden, wenn die Verfügbarkeit zuvor auf AVAILABLE festgelegt wurde.

Methoden

activate

 Aktiviert ein Angebot für ein Einmalkaufprodukt.

batchDelete

 Löscht ein oder mehrere Einmalkaufangebote.

batchGet

 Liest ein oder mehrere Einmalkaufproduktangebote.

batchUpdate

 Erstellt oder aktualisiert ein oder mehrere Angebote für Einmalkaufprodukte.

batchUpdateStates

 Aktualisiert den Status einer Reihe von Einmalkaufproduktangeboten.

cancel

 Storniert ein Angebot für ein Einmalkaufprodukt.

deactivate

 Deaktiviert ein Angebot für ein Einmalkaufprodukt.

list

 Listet alle Angebote für eine bestimmte App, ein bestimmtes Produkt oder eine bestimmte Kaufoption auf.

Fehlercodes

Die Vorgänge dieser Ressource geben die folgenden HTTP-Fehlercodes zurück:

Fehlercode Grund Beschreibung Auflösung