REST Resource: monetization.subscriptions.basePlans.offers

Ressource: SubscriptionOffer

Ein einzelnes, zeitlich begrenztes Angebot

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

string

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

string

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

string

Erforderlich. Nicht veränderbar. Die ID des Basis-Abos, zu dem dieses Angebot eine Erweiterung ist.
offerId

string

Erforderlich. Nicht veränderbar. Die eindeutige ID dieses Aboangebots. Darf innerhalb des Basisplans nicht mehrmals vorkommen.
state

enum (State)

Nur Ausgabe. Der aktuelle Status dieses Angebots. Kann mit den Aktionen „Aktivieren“ und „Deaktivieren“ geändert werden. Hinweis: Der Status des Basis-Abos hat Vorrang vor diesem Status. Ein aktives Angebot ist also möglicherweise nicht verfügbar, wenn das Basis-Abo nicht aktiv ist.
phases[]

object (SubscriptionOfferPhase)

Erforderlich. Die Phasen dieses Aboangebots. Muss mindestens einen und höchstens zwei Einträge enthalten. Nutzer erhalten alle diese Phasen immer in der angegebenen Reihenfolge.
targeting

object (SubscriptionOfferTargeting)

Die Voraussetzungen, die Nutzer erfüllen müssen, um für dieses Angebot infrage zu kommen. Stellt die Anforderungen dar, die Google Play anhand der Informationen in der Anfrage prüft, um zu entscheiden, ob ein Angebot zurückgegeben werden soll. Entwickler können diese Angebote selbst weiter filtern.
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Erforderlich. Die regionsspezifische Konfiguration dieses Angebots. Muss mindestens einen Eintrag enthalten.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Die Konfiguration für alle neuen Standorte, die Google Play in Zukunft möglicherweise einführt.
offerTags[]

object (OfferTag)

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

Status

Der aktuelle Status des Aboangebots.

Enums
STATE_UNSPECIFIED Standardwert, sollte nicht verwendet werden.
DRAFT Das Aboangebot ist nicht und war nie für Nutzer verfügbar.
ACTIVE Das Aboangebot gilt für neue und bestehende Nutzer.
INACTIVE Das Aboangebot ist nicht für neue Nutzer verfügbar. Bestehende Nutzer behalten den Zugriff.

SubscriptionOfferPhase

Eine einzelne Phase eines Aboangebots.

JSON-Darstellung 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Felder
recurrenceCount

integer

Erforderlich. Die Anzahl der Wiederholungen dieser Phase. Wenn diese Angebotsphase nicht kostenlos ist, wird dem Nutzer bei jeder Wiederholung der Preis für diese Angebotsphase in Rechnung gestellt.
duration

string

Erforderlich. Die Dauer einer einzelnen Wiederholung dieser Phase. Muss im ISO 8601-Format angegeben werden.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Erforderlich. Die regionsspezifische Konfiguration dieser Angebotsphase. Diese Liste muss genau einen Eintrag für jede Region enthalten, für die das Aboangebot eine regionale Konfiguration hat.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Preisinformationen für alle neuen Standorte, an denen Google Play eingeführt werden könnte.

RegionalSubscriptionOfferPhaseConfig

Konfiguration für eine einzelne Phase eines Aboangebots in einer einzelnen Region.

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

string

Erforderlich. Nicht veränderbar. Die Region, auf die diese Konfiguration angewendet wird.
Union-Feld price_override. Die Preisüberschreibung für diese Phase. Erforderlich. Für price_override ist nur einer der folgenden Werte zulässig:
price

object (Money)

Der absolute Preis, den der Nutzer für diese Angebotsphase bezahlt. Der Preis darf nicht unter dem für diese Region zulässigen Mindestpreis liegen.
relativeDiscount

number

Der anteilig berechnete Preis für ein Basis-Abo, der dem Nutzer für diese Angebotsphase in Rechnung gestellt wird. Wenn der Preis für ein Basis-Abo für diese Region beispielsweise 12 € für einen Zeitraum von einem Jahr beträgt, entspricht ein Rabatt von 50% für einen Zeitraum von drei Monaten einem Preis von 1, 50 €. 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 (z.B. Cent für US-Dollar) gerundet. Der relative Rabatt gilt als ungültig, wenn der ermäßigte Preis unter dem in dieser Region zulässigen Mindestpreis liegt.
absoluteDiscount

object (Money)

Der absolute Geldbetrag, der dem Preis für das Basis-Abo anteilig über die Angebotsdauer abgezogen wird und den der Nutzer für diese Angebotsphase bezahlt. Wenn der Preis für das Basis-Abo für diese Region beispielsweise 12 $für einen Zeitraum von einem Jahr beträgt, entspricht ein absoluter Rabatt von 1 $für einen Zeitraum von 3 Monaten einem Preis von 2 $. Der daraus resultierende Preis darf nicht unter dem für diese Region zulässigen Mindestpreis liegen.
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Hiermit wird angegeben, dass dieses Angebot kostenlos ist.

RegionalSubscriptionOfferPhaseFreePriceOverride

Dieser Typ hat keine Felder.

Stellt die Konfiguration für die Preisüberschreibung für eine einzelne Phase eines Aboangebots dar

OtherRegionsSubscriptionOfferPhaseConfig

Konfiguration für alle neuen Standorte, in denen Google Play für eine einzelne Angebotsphase eingeführt werden kann.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld price_override. Die Preisüberschreibung für diese Phase. Erforderlich. Für price_override ist nur einer der folgenden Werte zulässig:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Der absolute Preis, den der Nutzer für diese Angebotsphase bezahlt. Der Preis darf nicht unter dem zulässigen Mindestpreis für neue Standorte liegen, an denen Google Play möglicherweise eingeführt wird.
relativeDiscount

number

Der anteilig berechnete Preis für ein Basis-Abo, der dem Nutzer für diese Angebotsphase in Rechnung gestellt wird. Wenn der Preis für ein Basis-Abo für diese Region beispielsweise 12 € für einen Zeitraum von einem Jahr beträgt, entspricht ein Rabatt von 50% für einen Zeitraum von drei Monaten einem Preis von 1, 50 €. 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 (z.B. Cent für US-Dollar) gerundet. Der relative Rabatt gilt als ungültig, wenn der ermäßigte Preis unter dem zulässigen Mindestpreis in allen neuen Ländern und Regionen liegt, in denen der Play Store eingeführt werden könnte.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Der absolute Geldbetrag, der dem Preis für das Basis-Abo anteilig über die Angebotsdauer abgezogen wird und den der Nutzer für diese Angebotsphase bezahlt. Wenn der Preis für das Basis-Abo für diese Region beispielsweise 12 $für einen Zeitraum von einem Jahr beträgt, entspricht ein absoluter Rabatt von 1 $für einen Zeitraum von 3 Monaten einem Preis von 2 $. Der daraus resultierende Preis darf nicht unter dem zulässigen Mindestpreis für neue Standorte liegen, an denen Google Play eingeführt werden könnte.
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Hiermit wird angegeben, dass dieses Angebot kostenlos ist.

OtherRegionsSubscriptionOfferPhasePrices

Preisinformationen für alle neuen Standorte, an denen Google Play eingeführt werden könnte.

JSON-Darstellung 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
Felder
usdPrice

object (Money)

Erforderlich. Preis in US-Dollar, der für alle neuen Standorte verwendet werden soll, an denen Google Play eingeführt wird.
eurPrice

object (Money)

Erforderlich. Preis in Euro, der für alle neuen Standorte verwendet werden soll, an denen Google Play eingeführt wird.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

Dieser Typ hat keine Felder.

Stellt die Konfiguration für die Preisüberschreibung für alle neuen Standorte dar, die Google Play für eine einzelne Angebotsphase einführen kann.

SubscriptionOfferTargeting

Hier wird die Regel definiert, die ein Nutzer erfüllen muss, um dieses Angebot zu erhalten.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld rule. Lassen Sie das Feld leer, wenn die Teilnahmeberechtigung für das Angebot vom Entwickler festgelegt wird. Für rule ist nur einer der folgenden Werte zulässig:
acquisitionRule

object (AcquisitionTargetingRule)

Angebotsausrichtungsregel für die Kundenakquisition.
upgradeRule

object (UpgradeTargetingRule)

Angebots-Targeting-Regel für das Upgrade bestehender Abos von Nutzern.

AcquisitionTargetingRule

Stellt eine Ausrichtungsregel vom Typ „Nutzer hatte {scope} noch nie“ dar.

JSON-Darstellung 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Felder
scope

object (TargetingRuleScope)

Erforderlich. Der Geltungsbereich der Abos, die von dieser Regel berücksichtigt werden. Nur „dieses Abo“ und „beliebiges Abo in der App“ sind zulässig.

TargetingRuleScope

Hier wird der Umfang der Abos definiert, die mit einer Ausrichtungsregel abgeglichen werden können, um Angebote auf Nutzer mit früheren oder aktuellen Berechtigungen auszurichten.

JSON-Darstellung 
{

  // 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.
}
Felder

Union-Feld scope.

Für scope ist nur einer der folgenden Werte zulässig:
thisSubscription

object (TargetingRuleScopeThisSubscription)

Der Geltungsbereich der aktuellen Ausrichtungsregel ist das Abo, in dem dieses Angebot definiert ist.
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

Der Geltungsbereich der aktuellen Targeting-Regel umfasst alle Abos in der übergeordneten App.
specificSubscriptionInApp

string

Der Geltungsbereich der aktuellen Targeting-Regel ist das Abo mit der angegebenen Abo-ID. Es muss sich um ein Abo innerhalb derselben übergeordneten App handeln.

TargetingRuleScopeThisSubscription

Dieser Typ hat keine Felder.

Stellt den Geltungsbereich der Ausrichtungsregel dar, der den Abos entspricht, in denen dieses Angebot definiert ist.

TargetingRuleScopeAnySubscriptionInApp

Dieser Typ hat keine Felder.

Stellt den Geltungsbereich der Targeting-Regel dar, der einem Abo in der übergeordneten App entspricht.

UpgradeTargetingRule

Stellt eine Ausrichtungsregel vom Typ „Der Nutzer hat derzeit {scope} [mit Abrechnungszeitraum {billing_period}]“ dar.

JSON-Darstellung 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Felder
oncePerUser

boolean

Dieses Angebot ist nur einmal pro Nutzer verfügbar. Wenn diese Option auf „true“ festgelegt ist, kann ein Nutzer, der dieses Angebot bereits in Anspruch genommen hat, es nie wieder in Anspruch nehmen.
scope

object (TargetingRuleScope)

Erforderlich. Der Geltungsbereich der Abos, die von dieser Regel berücksichtigt werden. Nur „dieses Abo“ und „bestimmtes Abo in der App“ sind zulässig.
billingPeriodDuration

string

Die Dauer des Abrechnungszeitraums, angegeben im ISO 8601-Format, für den ein Nutzer derzeit angemeldet sein muss, um für diese Regel infrage zu kommen. Wenn nicht angegeben, werden Nutzer, die einen beliebigen Abrechnungszeitraum abonniert haben, abgeglichen.

RegionalSubscriptionOfferConfig

Konfiguration für ein Aboangebot in einer einzelnen Region.

JSON-Darstellung 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Felder
regionCode

string

Erforderlich. Nicht veränderbar. Regionscode, für den diese Konfiguration gilt, gemäß ISO 3166-2, z.B. „US“.
newSubscriberAvailability

boolean

Gibt an, ob das Aboangebot in der angegebenen Region für neue Abonnenten verfügbar ist. Wenn dieser Wert auf „false“ festgelegt ist, wird das Abo bestehender Abonnenten nicht gekündigt. Wenn keine Angabe erfolgt, wird standardmäßig „falsch“ verwendet.

OtherRegionsSubscriptionOfferConfig

Konfiguration für alle neuen Standorte, in denen Google Play möglicherweise eingeführt wird, die in einem Aboangebot angegeben sind.

JSON-Darstellung 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Felder
otherRegionsNewSubscriberAvailability

boolean

Ob das Aboangebot in neuen Ländern und Regionen verfügbar sein soll, die Google Play in Zukunft möglicherweise unterstützt Wenn keine Angabe erfolgt, wird standardmäßig „falsch“ verwendet.

Methoden

activate

 Aktiviert ein Aboangebot.

batchGet

 Liest ein oder mehrere Aboangebote.

batchUpdate

 Aktualisiert eine Reihe von Aboangeboten.

batchUpdateStates

 Aktualisiert den Status mehrerer Aboangebote.

create

 Erstellt ein neues Aboangebot.

deactivate

 Deaktiviert ein Aboangebot.

delete

 Löscht ein Aboangebot.

get

 Liest ein einzelnes Angebot

list

 Listet alle Angebote unter einem bestimmten Abo auf.

patch

 Aktualisiert ein bestehendes Aboangebot.