REST Resource: monetization.subscriptions.basePlans.offers

Ressource: SubscriptionOffer

Ein einmaliges, 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, für das dieses Angebot eine Erweiterung ist.
offerId

string

Erforderlich. Nicht veränderbar. Eindeutige ID dieses Aboangebots. Darf innerhalb des Basis-Abos 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 ersetzt diesen Status. Daher ist möglicherweise kein aktives Angebot verfügbar, wenn das Basis-Abo nicht aktiv ist.
phases[]

object (SubscriptionOfferPhase)

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

object (SubscriptionOfferTargeting)

Die Anforderungen, die Nutzer erfüllen müssen, um dieses Angebot nutzen zu können. Stellt die Anforderungen dar, die Google Play bewertet, um zu entscheiden, ob ein Angebot zurückgegeben werden soll. Entwickler können diese Angebote auch selbst 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 möglicherweise in Zukunft eingeführt.
offerTags[]

object (OfferTag)

Liste von bis zu 20 benutzerdefinierten Tags, die für dieses Angebot angegeben und über die Billing Library an die App zurückgegeben wurden.

Status

Der aktuelle Status des Aboangebots.

Enums
STATE_UNSPECIFIED Standardwert, sollte nie verwendet werden.
DRAFT Das Aboangebot ist für Nutzer noch nicht verfügbar.
ACTIVE Das Aboangebot gilt für neue und bestehende Nutzer.
INACTIVE Das Aboangebot ist für neue Nutzer nicht 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 dieser Angebotsphase berechnet.
duration

string

Erforderlich. Die Dauer einer einzelnen Wiederholung dieser Phase. Wird im ISO 8601-Format angegeben.
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 Länder, in denen Google 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 in dieser 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 Anteil des Basis-Abos, der dem Nutzer für diese Angebotsphase anteilig über die Phasendauer berechnet wird. Beträgt der Preis des Basis-Abos für diese Region beispielsweise 12 € für einen Zeitraum von einem Jahr, entspricht ein Rabatt von 50% für eine Phase von 3 Monaten einem Preis von 1, 50 €. Der Rabatt muss als Bruchteil größer als 0 und kleiner als 1 angegeben werden. Der daraus resultierende Preis wird auf die nächste Rechnungseinheit aufgerundet (z.B. Cent für US-Dollar). Der relative Rabatt gilt als ungültig, wenn der rabattierte Preis unter dem in dieser Region zulässigen Mindestpreis liegt.
absoluteDiscount

object (Money)

Der absolute Geldbetrag, der vom Basis-Abo-Preis anteilig für die Phasendauer abgezogen wird, die der Nutzer für diese Angebotsphase bezahlt. Wenn der Preis des Basis-Abos für diese Region beispielsweise für einen Zeitraum von einem Jahr 12 € beträgt, würde ein Gesamtrabatt in Höhe von 1 € für eine Phase von 3 Monaten einem Preis von 2 € entsprechen. Der resultierende Preis darf nicht unter dem Mindestpreis für diese Region liegen.
free

object

Legen Sie fest, um anzugeben, dass dieses Angebot kostenlos abgerufen werden kann.

OtherRegionsSubscriptionOfferPhaseConfig

Konfiguration für neue Standorte, in denen Play möglicherweise für eine einzelne Angebotsphase eingeführt wird.

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 in dieser 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 für neue Länder liegen, in denen Google Play verfügbar sein wird.
relativeDiscount

number

Der Anteil des Basis-Abos, der dem Nutzer für diese Angebotsphase anteilig über die Phasendauer berechnet wird. Beträgt der Preis des Basis-Abos für diese Region beispielsweise 12 € für einen Zeitraum von einem Jahr, entspricht ein Rabatt von 50% für eine Phase von 3 Monaten einem Preis von 1, 50 €. Der Rabatt muss als Bruchteil größer als 0 und kleiner als 1 angegeben werden. Der daraus resultierende Preis wird auf die nächste Rechnungseinheit aufgerundet (z.B. Cent für US-Dollar). Der relative Rabatt gilt als ungültig, wenn der ermäßigte Preis unter dem Mindestpreis liegt, der in neuen Ländern und Regionen zulässig ist, in denen Google Play angeboten wird.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Der absolute Geldbetrag, der vom Basis-Abo-Preis anteilig für die Phasendauer abgezogen wird, die der Nutzer für diese Angebotsphase bezahlt. Wenn der Preis des Basis-Abos für diese Region beispielsweise für einen Zeitraum von einem Jahr 12 € beträgt, würde ein Gesamtrabatt in Höhe von 1 € für eine Phase von 3 Monaten einem Preis von 2 € entsprechen. Der daraus resultierende Preis darf nicht unter dem Mindestpreis für neue Länder liegen, in denen Play möglicherweise eingeführt wird.
free

object

Legen Sie fest, um anzugeben, dass dieses Angebot kostenlos abgerufen werden kann.

OtherRegionsSubscriptionOfferPhasePrices

Preisinformationen für alle neuen Länder, in denen Google Play möglicherweise eingeführt wird.

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

object (Money)

Erforderlich. Preis in US-Dollar, der für neue Länder verwendet werden kann, in denen Play Play verfügbar sein wird.
eurPrice

object (Money)

Erforderlich. Preis in Euro für alle neuen Länder, in denen Play möglicherweise eingeführt wird.

SubscriptionOfferTargeting

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. Lassen Sie das Feld leer, wenn der Entwickler für das Angebot infrage kommt. Für rule ist nur einer der folgenden Werte zulässig:
acquisitionRule

object (AcquisitionTargetingRule)

Ausrichtungsregel für die Gewinnung neuer Nutzer anbieten.
upgradeRule

object (UpgradeTargetingRule)

Targeting-Regel für das Upgrade der bestehenden Abos von Nutzern anbieten.

AcquisitionTargetingRule

Stellt eine Ausrichtungsregel der Form dar: {scope} des Nutzers nie zuvor verwendet.

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

object (TargetingRuleScope)

Erforderlich. Der Umfang der Abos, die für diese Regel berücksichtigt werden. Nur „dieses Abo“ und „alle Abos in der App“ sind zulässig.

TargetingRuleScope

Definiert den Umfang der Abos, mit denen eine Targeting-Regel abgeglichen werden 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 (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)

Die aktuelle Ausrichtungsregel gilt für alle Abos in der übergeordneten App.
specificSubscriptionInApp

string

Der Geltungsbereich der aktuellen Targeting-Regel ist das Abo mit der angegebenen Abo-ID. Muss ein Abo in derselben übergeordneten App sein.

TargetingRuleScopeThisSubscription

Dieser Typ hat keine Felder.

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

TargetingRuleScopeAnySubscriptionInApp

Dieser Typ hat keine Felder.

Der Geltungsbereich der Targeting-Regel, der einem beliebigen Abo in der übergeordneten App entspricht.

UpgradeTargetingRule

Stellt eine Ausrichtungsregel im folgenden Format dar: Nutzer hat derzeit {scope} [mit Abrechnungszeitraum {billing_period}].

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

boolean

Beschränken Sie dieses Angebot auf nur einmal pro Nutzer. Wenn die Richtlinie auf „true“ gesetzt ist, kann ein Nutzer nie wieder für dieses Angebot infrage kommen, falls er es jemals abonniert hat.
scope

object (TargetingRuleScope)

Erforderlich. Der Umfang der Abos, die für diese Regel berücksichtigt werden. Nur „dieses Abo“ und „bestimmtes Abo in der App“ sind zulässig.
billingPeriodDuration

string

Dauer des Abrechnungszeitraums im ISO-8601-Format, die ein Nutzer derzeit abonniert haben muss, um diese Regel zu nutzen. 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-Definition, z.B. „US“.
newSubscriberAvailability

boolean

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

OtherRegionsSubscriptionOfferConfig

Konfiguration für alle neuen Standorte, an denen Google Play möglicherweise im Rahmen eines Aboangebots eingeführt werden kann.

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

boolean

Gibt an, ob das Aboangebot an neuen Standorten in Play verfügbar sein wird. Wenn keine Angabe erfolgt, wird standardmäßig „false“ verwendet.

Methoden

activate

 Aktiviert ein Aboangebot.

batchGet

 Liest ein oder mehrere Aboangebote.

batchUpdate

 Aktualisiert eine Reihe von Aboangeboten

batchUpdateStates

 Aktualisiert einen Batch von Aboangebotsstatus.

create

 Erstellt ein neues Aboangebot.

deactivate

 Deaktiviert ein Aboangebot.

delete

 Löscht ein Aboangebot.

get

 Ein einzelnes Angebot lesen

list

 Listet alle Angebote eines bestimmten Abos auf.

patch

 Aktualisiert ein bestehendes Aboangebot.