REST Resource: monetization.subscriptions.basePlans.offers

Ressource: SubscriptionOffer

Ein einzelnes, vorübergehendes 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, für das dieses Angebot eine Verlängerung ist.
offerId

string

Erforderlich. Nicht veränderbar. Eindeutige ID dieses Aboangebots. Darf im Basis-Abo nur einmal vorkommen.
state

enum (State)

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

object (SubscriptionOfferPhase)

Erforderlich. Die Phasen dieses Aboangebots. Muss mindestens einen Eintrag enthalten und kann höchstens fünf Einträge enthalten. Nutzer erhalten immer alle diese Phasen in der angegebenen Reihenfolge. Phasen können nach der Erstellung nicht hinzugefügt, entfernt oder neu angeordnet werden.
targeting

object (SubscriptionOfferTargeting)

Die Anforderungen, die Nutzer erfüllen müssen, um dieses Angebot in Anspruch nehmen zu können. Stellt die Anforderungen dar, die Google Play entscheidet, 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 neue Standorte wird in Zukunft möglicherweise von Google Play eingeführt.
offerTags[]

object (OfferTag)

Sie können bis zu 20 benutzerdefinierte Tags (.apks.list) für dieses Angebot angeben und über die Abrechnungsbibliothek an die App zurückgeben.

Status

Der aktuelle Status des Aboangebots.

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

AboOfferPhase

Eine einzelne Phase eines Aboangebots.

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

integer

Erforderlich. Gibt an, wie oft sich diese Phase wiederholt. Wenn diese Angebotsphase nicht kostenlos ist, wird dem Nutzer bei jeder Wiederholung der Preis in dieser Angebotsphase berechnet.
duration

string

Erforderlich. Die Dauer einer einzelnen Wiederholung dieser Phase. Die Angabe erfolgt im ISO-8601-Format.
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 Play möglicherweise eingeführt wird

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
  }
  // End of list of possible types for union field price_override.
}
Felder
regionCode

string

Erforderlich. Nicht veränderbar. Die Region, für die diese Konfiguration gilt.
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 Mindestpreis für diese Region liegen.
relativeDiscount

number

Der anteilige Preis des Basis-Abos, anteilsmäßig berechnet über die Laufzeit, die der Nutzer für diese Angebotsphase bezahlt. Wenn der Basis-Abo-Preis für diese Region beispielsweise für 1 Jahr 12 € beträgt, entspricht ein Rabatt von 50% für eine Phase von 3 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 gerundet (z.B. Cent für US-Dollar). Der relative Rabatt gilt als ungültig, wenn der rabattierte Preis niedriger ist als der in dieser Region zulässige Mindestpreis.
absoluteDiscount

object (Money)

Der absolute Geldbetrag, der vom Basis-Abo-Preis abgezogen wird, anteilsmäßig berechnet über die Laufzeit, die der Nutzer für diese Angebotsphase bezahlt. Wenn der Preis für das Basis-Abo beispielsweise 12 € beträgt und ein Zeitraum von 1 Jahr beträgt, entspricht ein absoluter Rabatt von 1 € für eine Phase von 3 Monaten einem Preis von 2 €. Der resultierende Preis darf nicht unter dem Mindestpreis liegen, der für diese Region zulässig ist.
free

object

Geben Sie an, dass dieses Angebot kostenlos abgerufen werden soll.

OtherRegionsOfferOfferPhaseConfig

Die Konfiguration für neue Standorte, an denen Play für eine einzelne Angebotsphase gestartet 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
  }
  // 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 Mindestpreis liegen, der für neue Standorte in Google Play gilt.
relativeDiscount

number

Der anteilige Preis des Basis-Abos, anteilsmäßig berechnet über die Laufzeit, die der Nutzer für diese Angebotsphase bezahlt. Wenn der Basis-Abo-Preis für diese Region beispielsweise für 1 Jahr 12 € beträgt, entspricht ein Rabatt von 50% für eine Phase von 3 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 gerundet (z.B. Cent für US-Dollar). Der relative Rabatt gilt als ungültig, wenn der reduzierte Preis unter dem Mindestpreis liegt, der an allen neuen Standorten zulässig ist, an denen Play verfügbar sein kann.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Der absolute Geldbetrag, der vom Basis-Abo-Preis abgezogen wird, anteilsmäßig berechnet über die Laufzeit, die der Nutzer für diese Angebotsphase bezahlt. Wenn der Preis für das Basis-Abo beispielsweise 12 € beträgt und ein Zeitraum von 1 Jahr beträgt, entspricht ein absoluter Rabatt von 1 € für eine Phase von 3 Monaten einem Preis von 2 €. Der resultierende Preis ist möglicherweise nicht geringer als der Mindestpreis, der an allen neuen Standorten in Google Play zulässig ist.
free

object

Geben Sie an, dass dieses Angebot kostenlos abgerufen werden soll.

OtherRegionSubscriptionOfferPhasePreise

Preisinformationen für alle neuen Standorte, an denen Play möglicherweise eingeführt wird

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

object (Money)

Erforderlich. Preis in USD für neue Standorte, an denen Play möglicherweise eingeführt wird.
eurPrice

object (Money)

Erforderlich. Preis in EUR, der für neue Standorte verwendet werden soll, an denen Play verfügbar sein kann.

TargetingOffer-Abonnement

Definiert die Regel, 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.

Für rule ist nur einer der folgenden Werte zulässig:
acquisitionRule

object (AcquisitionTargetingRule)

Targeting-Regel für die Gewinnung neuer Nutzer anbieten.
upgradeRule

object (UpgradeTargetingRule)

Targeting-Regel für das Upgrade bestehender Nutzer

Akquisitions-Targeting-Regel

Stellt eine Targeting-Regel im folgenden Format dar: Der Nutzer hatte noch nie {scope}.

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

object (TargetingRuleScope)

Erforderlich. Der Umfang der Abos, die in dieser Regel berücksichtigt werden. Ermöglicht nur dieses Abo und alle Abos in Apps.

Ausrichtungsregelbereich

Hier wird der Umfang der Abos festgelegt, die eine Ausrichtungsregel haben kann, um Angebote basierend auf früheren oder aktuellen Berechtigungen auf Nutzer auszurichten.

JSON-Darstellung 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "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

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

object

Der Bereich der aktuellen Targeting-Regel ist ein beliebiges Abo in der übergeordneten App.
specificSubscriptionInApp

string

Der Bereich der aktuellen Ausrichtungsregel ist das Abo mit der angegebenen Abo-ID. Muss ein Abo in derselben übergeordneten App sein.

Upgrade-Ausrichtungsregel

Stellt eine Targeting-Regel im folgenden Format dar: Der Nutzer hat derzeit {scope} [mit Abrechnungszeitraum {billing_period}].

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

boolean

Dieses Angebot auf einmal pro Nutzer beschränken. Wenn die Option auf „true“ gesetzt ist, kann ein Nutzer nicht mehr für dieses Angebot infrage kommen, wenn er dieses Angebot jemals abonniert hat.
scope

object (TargetingRuleScope)

Erforderlich. Der Umfang der Abos, die in dieser Regel berücksichtigt werden. In dieser App sind nur bestimmte Abos und Apps zulässig.
billingPeriodDuration

string

Die Dauer eines bestimmten Abrechnungszeitraums im ISO-8601-Format, die ein Nutzer aktuell abonniert hat, um für diese Regel infrage zu kommen. Wenn nicht angegeben, werden Nutzer, die einen beliebigen Abrechnungszeitraum abonniert haben, abgeglichen.

RegionalAboOfferConfig

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 gemäß ISO 3166-2 gilt, z. B. "US"
newSubscriberAvailability

boolean

Gibt an, ob das Aboangebot in der angegebenen Region für neue Abonnenten verfügbar ist. Bestehende Abonnenten werden nicht gekündigt, wenn dieser Wert auf „false“ gesetzt ist. Wenn keine Angabe erfolgt, ist der Standardwert „false“.

Sonstige RegionAboOfferConfig

Die Konfiguration für alle neuen Standorte, die Play im Rahmen eines Aboangebots festlegen kann.

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

boolean

Gibt an, ob das Aboangebot in Zukunft an allen neuen Standorten bei Google Play eingeführt werden soll. Wenn keine Angabe erfolgt, ist der Standardwert „false“.

Methoden

activate

 Aktiviert ein Aboangebot.

create

 Erstellt ein neues Aboangebot.

deactivate

 Deaktiviert ein Aboangebot.

delete

 Löscht ein Aboangebot.

get

 Einzelnes Angebot lesen

list

 Führt alle Angebote unter einem bestimmten Abo auf.

patch

 Aktualisiert ein bestehendes Aboangebot.