REST Resource: monetization.subscriptions

Ressource: Abo

Ein einzelnes Abo für eine App.

JSON-Darstellung 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Felder
packageName

string

Nicht veränderbar. Paketname der übergeordneten App.
productId

string

Nicht veränderbar. Eindeutige Produkt-ID des Produkts. Eindeutig innerhalb der übergeordneten App. Produkt-IDs müssen aus Kleinbuchstaben (a–z), Ziffern (0–9), Unterstrichen (_) und Punkten (.) bestehen. Sie müssen mit einem Kleinbuchstaben oder einer Ziffer beginnen und zwischen 1 und 40 Zeichen lang sein (einschließlich).
basePlans[]

object (BasePlan)

Die Gruppe von Basis-Abos für dieses Abo. Gibt die Preise und die Dauer des Abos an, wenn keine anderen Angebote gelten.
listings[]

object (SubscriptionListing)

Erforderlich. Liste der lokalisierten Einträge für dieses Abo. Muss mindestens einen Eintrag für die Standardsprache der übergeordneten App enthalten.
archived
(deprecated)

boolean

Nur Ausgabe. Eingestellt: Das Archivieren von Abos wird nicht unterstützt.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Details zu Steuern und rechtlicher Compliance
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Optional. Länder, in denen der Kauf dieses Abos auf Zahlungsmethoden beschränkt ist, die im selben Land registriert sind. Wenn leer, werden keine Zahlungsbeschränkungen für Länder und Regionen auferlegt.

BasePlan

Ein einzelnes Basis-Abo für ein Abo.

JSON-Darstellung 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Felder
basePlanId

string

Erforderlich. Nicht veränderbar. Die eindeutige Kennung dieses Basis-Abos. Muss innerhalb des Abos eindeutig sein und RFC-1034 entsprechen. Diese ID darf also nur Kleinbuchstaben (a–z), Ziffern (0–9) und Bindestriche (-) enthalten und maximal 63 Zeichen lang sein.
state

enum (State)

Nur Ausgabe. Der Status des Basis-Abos, d.h. ob es aktiv ist. Entwürfe und inaktive Basis-Abos können aktiviert oder gelöscht werden. Aktive Basis-Abos können inaktiv gemacht werden. Inaktive Basis-Abos können gekündigt werden. Dieses Feld kann nicht durch Aktualisieren der Ressource geändert werden. Verwenden Sie stattdessen die entsprechenden Endpunkte.
regionalConfigs[]

object (RegionalBasePlanConfig)

Regionsspezifische Informationen für dieses Basis-Abo.
offerTags[]

object (OfferTag)

Liste mit bis zu 20 benutzerdefinierten Tags, die für dieses Basis-Abo angegeben und über die Billing Library an die App zurückgegeben werden. Aboangebote für dieses Basis-Abo erhalten diese Angebotstags auch in der Abrechnungsbibliothek.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Preisinformationen für alle neuen Standorte, an denen Play in Zukunft eingeführt werden könnte. Wenn Sie diese Option nicht angeben, ist der BasePlan nicht automatisch an neuen Standorten verfügbar, an denen Play in Zukunft eingeführt wird.
Union-Feld base_plan_type. Der Typ dieses Basis-Abos. Es muss genau einer festgelegt werden. Der Typ des Basisplans kann nach der Erstellung des Basisplans nicht mehr geändert werden. Für base_plan_type ist nur einer der folgenden Werte zulässig:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Legen Sie fest, wann sich das Basis-Abo in regelmäßigen Abständen automatisch verlängert.
prepaidBasePlanType

object (PrepaidBasePlanType)

Gibt an, wann der Base Plan am Ende des Abrechnungszeitraums nicht automatisch verlängert wird.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Für Basis-Abos mit Ratenzahlung, bei denen sich ein Nutzer zu einer bestimmten Anzahl von Zahlungen verpflichtet.

Bundesland

Aktueller Status eines Basis-Abos.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
DRAFT Das Basis-Abo befindet sich derzeit im Entwurfsstatus und wurde noch nicht aktiviert. Sie können sie an dieser Stelle ohne Bedenken löschen.
ACTIVE Das Basis-Abo ist aktiv und für neue Abonnenten verfügbar.
INACTIVE Das Basis-Abo ist inaktiv und nur für bestehende Abonnenten verfügbar.

AutoRenewingBasePlanType

Stellt ein Basis-Abo dar, das am Ende des Abozeitraums automatisch verlängert wird.

JSON-Darstellung 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Felder
billingPeriodDuration

string

Erforderlich. Nicht veränderbar. Abozeitraum im ISO 8601-Format. Eine Liste der akzeptablen Abrechnungszeiträume finden Sie in der Hilfe. Die Dauer kann nach der Erstellung des Basisplans nicht mehr geändert werden.
gracePeriodDuration

string

Kulanzzeitraum des Abos im ISO 8601-Format. Zulässige Werte müssen in Tagen angegeben werden und zwischen P0D und dem kleineren Wert von 30D und dem Abrechnungszeitraum des Basis-Abos liegen.

Wenn nichts angegeben ist, wird basierend auf dem Abrechnungszeitraum ein Standardwert verwendet.

Die Summe aus „gracePeriodDuration“ und „accountHoldDuration“ muss zwischen P30D und P60D liegen.
accountHoldDuration

string

Optional. Benutzerdefinierter Zeitraum für die Kontosperrung des Abos im ISO 8601-Format. Zulässige Werte müssen in Tagen angegeben werden und zwischen P0D und P60D liegen.

Ein leeres Feld steht für eine empfohlene Kontosperre, die als 60 Tage abzüglich des Kulanzzeitraums berechnet wird.

Die Summe aus „gracePeriodDuration“ und „accountHoldDuration“ muss zwischen P30D und P60D liegen.
resubscribeState

enum (ResubscribeState)

Gibt an, ob Nutzer dieses Basis-Abo bei Google Play noch einmal abonnieren können. Wenn keine Angabe erfolgt, ist der Standardwert RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Der Abrechnungsmodus für das Basis-Abo bestimmt, was passiert, wenn ein Nutzer von einem anderen Basis-Abo zu diesem Abo wechselt. Wenn nicht angegeben, wird standardmäßig CHARGE_ON_NEXT_BILLING_DATE verwendet.
legacyCompatible

boolean

Gibt an, ob das verlängerte Basis-Abo abwärtskompatibel ist.

Das abwärtskompatible Basis-Abo wird von der eingestellten Methode „querySkuDetailsAsync()“ der Google Play Billing Library zurückgegeben.

Für ein bestimmtes Abo kann nur ein sich automatisch verlängerndes Basis-Abo als mit alten Versionen kompatibel markiert werden.
legacyCompatibleSubscriptionOfferId

string

Die Angebots-ID des Abos, die mit der alten Version kompatibel ist.

Das abwärtskompatible Abo-Angebot wird von der eingestellten Methode „querySkuDetailsAsync()“ der Google Play Billing Library zurückgegeben.

Für ein bestimmtes Basis-Abo mit Verlängerung kann nur ein Aboangebot als mit alten Versionen kompatibel markiert werden.

Wenn kein Aboangebot als mit der alten Version kompatibel festgelegt werden soll, muss dieses Feld ein leerer String sein.

ResubscribeState

Status der Reaktivierung des Basis-Abos.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED Nicht angegebener Zustand.
RESUBSCRIBE_STATE_ACTIVE Die Reaktivierung des Abos ist aktiv.
RESUBSCRIBE_STATE_INACTIVE Die Reaktivierung des Abos ist inaktiv.

SubscriptionProrationMode

Der für die Verlängerung von Basisplänen verwendete Abrechnungsmodus.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Nicht angegebener Modus.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Nutzern werden die Gebühren für ihr neues Basis-Abo am Ende des aktuellen Abrechnungszeitraums in Rechnung gestellt.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Nutzern wird das neue Basis-Abo sofort und in voller Höhe in Rechnung gestellt. Die verbleibende Laufzeit des bestehenden Abos wird verwendet, um die Laufzeit des neuen Abrechnungsmodells zu verlängern.

PrepaidBasePlanType

Stellt ein Basis-Abo dar, das am Ende des Basis-Abos nicht automatisch verlängert wird und vom Nutzer manuell verlängert werden muss.

JSON-Darstellung 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Felder
billingPeriodDuration

string

Erforderlich. Nicht veränderbar. Abozeitraum im ISO 8601-Format. Eine Liste der akzeptablen Abrechnungszeiträume finden Sie in der Hilfe. Die Dauer kann nach der Erstellung des Basisplans nicht mehr geändert werden.
timeExtension

enum (TimeExtension)

Ob Nutzer dieses Prepaid-Basis-Abo auf Google Play-Plattformen verlängern können. Wenn keine Angabe erfolgt, wird standardmäßig TIME_EXTENSION_ACTIVE verwendet.

TimeExtension

Verlängerung des Basis-Abos.

Enums
TIME_EXTENSION_UNSPECIFIED Nicht angegebener Zustand.
TIME_EXTENSION_ACTIVE Die Zeitverlängerung ist aktiv. Nutzer können ihren Prepaid-Tarif aufladen oder verlängern.
TIME_EXTENSION_INACTIVE Die Zeitverlängerung ist inaktiv. Nutzer können ihr Prepaid-Abo nicht aufladen oder verlängern.

InstallmentsBasePlanType

Stellt ein Basis-Abo mit Ratenzahlung dar, bei dem sich ein Nutzer zu einer bestimmten Anzahl von Zahlungen verpflichtet.

JSON-Darstellung 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Felder
billingPeriodDuration

string

Erforderlich. Nicht veränderbar. Abozeitraum im ISO 8601-Format. Eine Liste der akzeptablen Abrechnungszeiträume finden Sie in der Hilfe. Die Dauer kann nach der Erstellung des Basisplans nicht mehr geändert werden.
committedPaymentsCount

integer

Erforderlich. Nicht veränderbar. Die Anzahl der Zahlungen, zu denen sich der Nutzer verpflichtet hat. Sie ist unveränderlich, nachdem der Basisplan erstellt wurde.
renewalType

enum (RenewalType)

Erforderlich. Nicht veränderbar. Typ der Verlängerung des Basis-Abos für Ratenzahlungen. Legt das Verhalten am Ende der ursprünglichen Zusicherung fest. Der Verlängerungstyp ist nach der Erstellung des Basisplans unveränderlich.
gracePeriodDuration

string

Kulanzzeitraum des Abos im ISO 8601-Format. Zulässige Werte müssen in Tagen angegeben werden und zwischen P0D und dem kleineren Wert von 30D und dem Abrechnungszeitraum des Basis-Abos liegen.

Wenn nichts angegeben ist, wird basierend auf dem Abrechnungszeitraum ein Standardwert verwendet.

Die Summe aus „gracePeriodDuration“ und „accountHoldDuration“ muss zwischen P30D und P60D liegen.
accountHoldDuration

string

Optional. Benutzerdefinierter Zeitraum für die Kontosperrung des Abos im ISO 8601-Format. Zulässige Werte müssen in Tagen angegeben werden und zwischen P0D und P60D liegen.

Ein leeres Feld steht für eine empfohlene Kontosperre, die als 60 Tage abzüglich des Kulanzzeitraums berechnet wird.

Die Summe aus „gracePeriodDuration“ und „accountHoldDuration“ muss zwischen P30D und P60D liegen.
resubscribeState

enum (ResubscribeState)

Gibt an, ob Nutzer dieses Basis-Abo bei Google Play noch einmal abonnieren können. Wenn keine Angabe erfolgt, ist der Standardwert RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Der Abrechnungsmodus für das Basis-Abo bestimmt, was passiert, wenn ein Nutzer von einem anderen Basis-Abo zu diesem Abo wechselt. Wenn nicht angegeben, wird standardmäßig CHARGE_ON_NEXT_BILLING_DATE verwendet.

RenewalType

Typ der Verlängerung des Basis-Abos für Ratenzahlungen. Legt das Verhalten am Ende der ursprünglichen Zusicherung fest. Der Verlängerungstyp ist nach der Erstellung des Basisplans unveränderlich.

Enums
RENEWAL_TYPE_UNSPECIFIED Nicht angegebener Zustand.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Das Abo wird ohne Verpflichtung regelmäßig für die Dauer des Abrechnungszeitraums verlängert.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Die Verlängerung erfolgt mit der Zusicherung derselben Dauer wie die ursprüngliche.

RegionalBasePlanConfig

Konfiguration für ein Basis-Abo, das für eine bestimmte Region gilt.

JSON-Darstellung 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Felder
regionCode

string

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

boolean

Gibt an, ob das Basis-Abo in der angegebenen Region für neue Abonnenten verfügbar ist. Das Abo bestehender Abonnenten wird nicht gekündigt, wenn dieser Wert auf „false“ gesetzt ist. Wenn nichts angegeben ist, wird standardmäßig „false“ verwendet.
price

object (Money)

Der Preis des Basis-Abos in der angegebenen Region. Muss festgelegt werden, wenn das Basis-Abo für neue Abonnenten verfügbar ist. Muss in der Währung festgelegt werden, die mit der angegebenen Region verknüpft ist.

OtherRegionsBasePlanConfig

Preisinformationen für alle neuen Standorte, an denen Play eingeführt wird.

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

object (Money)

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

object (Money)

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

boolean

Gibt an, ob das Basis-Abo für neue Abonnenten an neuen Standorten verfügbar ist, an denen Play eingeführt wird. Wenn nichts angegeben ist, wird standardmäßig „false“ verwendet.

SubscriptionListing

Die für den Nutzer sichtbaren Metadaten eines Abos.

JSON-Darstellung 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Felder
languageCode

string

Erforderlich. Die Sprache dieses Eintrags, wie in BCP-47 definiert, z.B. „en-US“.
title

string

Erforderlich. Der Titel dieses Abos in der Sprache dieses Eintrags. Nur Text
benefits[]

string

Eine Liste der Vorteile, die dem Nutzer auf Plattformen wie dem Play Store und in Reaktivierungsvorgängen in der Sprache dieses Eintrags angezeigt werden. Nur Text Geordnete Liste mit maximal vier Vorteilen.
description

string

Die Beschreibung dieses Abos in der Sprache dieses Eintrags. Maximale Länge: 80 Zeichen. Nur Text

Methoden

archive
(deprecated)

 Eingestellt: Das Archivieren von Abos wird nicht unterstützt.

batchGet

 Liest ein oder mehrere Abos.

batchUpdate

 Aktualisiert eine Reihe von Abos.

create

 Erstellt ein neues Abo.

delete

 Löscht ein Abo.

get

 Liest ein einzelnes Abo.

list

 Listet alle Abos für eine bestimmte App auf.

patch

 Aktualisiert ein vorhandenes Abo.

Fehlercodes

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

Fehlercode Grund Auflösung
5xx Allgemeiner Fehler auf dem Google Play-Server. Wiederholen Sie Ihre Anfrage.

Wenn das Problem weiterhin besteht, wenden Sie sich an Ihren Google Play-Kundenbetreuer oder senden Sie eine Supportanfrage. Prüfen Sie das Play-Status-Dashboard auf bekannte Ausfälle.
409 Fehler beim Aktualisieren der Gleichzeitigkeit.

Es wurde versucht, ein Objekt zu aktualisieren, das gerade aktualisiert wird. Beispiel: Ein Kauf wird bestätigt, indem gleichzeitig die acknowledgePurchase()-Methode der Play Billing Library und die purchases.products.acknowledge-Methode der Play Developer API aufgerufen werden.

 Wiederholen Sie Ihre Anfrage.