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.
basePlans[]

object (BasePlan)

Die Basis-Abos für dieses Abo. Stellt die Preise und die Dauer des Abos dar, 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: Die Archivierung von Abos wird nicht unterstützt.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Details zu Steuern und Compliance.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Optional. Länder, in denen der Kauf dieses Abos auf Zahlungsmethoden beschränkt ist, die für diese Länder registriert sind. Wenn das Feld leer ist, gelten keine Zahlungsbeschränkungen für Länder und Regionen.

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 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 deaktiviert werden. Inaktive Basis-Abos können gekündigt werden. Dieses Feld kann nicht durch Aktualisieren der Ressource geändert werden. Verwenden Sie stattdessen die dedizierten 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. Abo-Angebote für dieses Basis-Abo erhalten diese Angebots-Tags auch in der Billing Library.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Preisinformationen für neue Standorte, die Google Play in Zukunft einführt. Wenn Sie diese Option weglassen, ist das Basis-Abo nicht automatisch an neuen Standorten verfügbar, an denen Google Play in Zukunft eingeführt wird.
Union-Feld base_plan_type. Der Typ dieses Basis-Abos. Es muss genau eine Option festgelegt werden. Der Basis-Abo-Typ kann nach dem Erstellen des Basis-Abos 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)

Wird festgelegt, wenn sich das Basis-Abo am Ende des Abrechnungszeitraums nicht automatisch verlängert.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Wird für Basis-Abos mit Ratenzahlung festgelegt, 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 kann jetzt ohne Bedenken gelöscht werden.
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 zulässigen Abrechnungszeiträume finden Sie in der Hilfe. Die Dauer kann nach dem Erstellen des Basis-Abos 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 nicht angegeben, wird ein Standardwert basierend auf dem Abrechnungszeitraum verwendet.

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

string

Optional. Benutzerdefinierter Zeitraum für die Kontosperre 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 Tagen liegen.
resubscribeState

enum (ResubscribeState)

Ob Nutzer dieses Basis-Abo auf Google Play-Oberflächen erneut abonnieren können sollen. Wenn keine Angabe erfolgt, wird standardmäßig RESUBSCRIBE_STATE_ACTIVE verwendet.
prorationMode

enum (SubscriptionProrationMode)

Der anteilige 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 sich verlängernde 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 verlängerndes Basis-Abo als mit alten Versionen kompatibel markiert werden.
legacyCompatibleSubscriptionOfferId

string

Abo-Angebots-ID, die mit alten Versionen kompatibel ist.

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

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

Wenn kein Aboangebot als mit alten Versionen kompatibel festgelegt werden soll, lassen Sie dieses Feld leer.

ResubscribeState

Status des erneuten Abonnierens des Basis-Abos.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED Nicht angegebener Zustand.
RESUBSCRIBE_STATE_ACTIVE Die Funktion zum erneuten Abonnieren ist aktiv.
RESUBSCRIBE_STATE_INACTIVE Die Option „Erneut abonnieren“ ist inaktiv.

SubscriptionProrationMode

Der anteilige Modus, der für die Verlängerung von Basis-Abos verwendet wird.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Nicht angegebener Modus.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Der neue Basis-Tarif wird Nutzern 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 Preismodells zu verlängern.

PrepaidBasePlanType

Steht für ein Basis-Abo, das sich am Ende der Laufzeit nicht automatisch verlängert 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 zulässigen Abrechnungszeiträume finden Sie in der Hilfe. Die Dauer kann nach dem Erstellen des Basis-Abos nicht mehr geändert werden.
timeExtension

enum (TimeExtension)

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

TimeExtension

Zeitverlängerung für Basis-Abo.

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 ihren Prepaid-Tarif 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 zulässigen Abrechnungszeiträume finden Sie in der Hilfe. Die Dauer kann nach dem Erstellen des Basis-Abos nicht mehr geändert werden.
committedPaymentsCount

integer

Erforderlich. Nicht veränderbar. Die Anzahl der Zahlungen, zu denen sich der Nutzer verpflichtet hat. Sie kann nach dem Erstellen des Basis-Abos nicht mehr geändert werden.
renewalType

enum (RenewalType)

Erforderlich. Nicht veränderbar. Verlängerungstyp für Basis-Abo mit Ratenzahlung. Bestimmt das Verhalten am Ende der ursprünglichen Zusicherung. Der Verlängerungstyp kann nach dem Erstellen des Basis-Abos 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 nicht angegeben, wird ein Standardwert basierend auf dem Abrechnungszeitraum verwendet.

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

string

Optional. Benutzerdefinierter Zeitraum für die Kontosperre 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 Tagen liegen.
resubscribeState

enum (ResubscribeState)

Ob Nutzer dieses Basis-Abo auf Google Play-Oberflächen erneut abonnieren können sollen. Wenn keine Angabe erfolgt, wird standardmäßig RESUBSCRIBE_STATE_ACTIVE verwendet.
prorationMode

enum (SubscriptionProrationMode)

Der anteilige 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

Verlängerungstyp für Basis-Abo mit Ratenzahlung. Bestimmt das Verhalten am Ende der ursprünglichen Zusicherung. Der Verlängerungstyp kann nach dem Erstellen des Basis-Abos nicht mehr geändert werden.

Enums
RENEWAL_TYPE_UNSPECIFIED Nicht angegebener Zustand.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Wird regelmäßig für die Dauer des Abrechnungszeitraums ohne Verpflichtung verlängert.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Wird mit einer Zusicherung verlängert, die dieselbe Dauer wie die ursprüngliche hat.

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. Regionscode, für den diese Konfiguration gilt, wie in ISO 3166-1 Alpha-2 definiert, z.B. „DE“.
newSubscriberAvailability

boolean

Gibt an, ob das Basis-Abo in der angegebenen Region für neue Abonnenten verfügbar ist. Wenn dieser Wert auf „false“ gesetzt ist, wird das Abo bestehender Abonnenten nicht gekündigt. 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 neue Länder, in denen Google Play eingeführt wird.

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

object (Money)

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

object (Money)

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

boolean

Ob das Basis-Abo für neue Abonnenten an neuen Standorten verfügbar ist, an denen Google 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 durch 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 Google Play Store und in Wiederherstellungsabläufen in der Sprache dieses Eintrags angezeigt werden. Nur Text Sortierte Liste mit maximal vier Vorteilen.
description

string

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

Methoden

archive
(deprecated)

 Eingestellt: Die Archivierung von Abos wird nicht unterstützt.

batchGet

 Liest ein oder mehrere Abos.

batchUpdate

 Aktualisiert einen Batch von Abos.

create

 Erstellt ein neues Abo.

delete

 Löscht ein Abo.

get

 Liest ein einzelnes Abo.

list

 Listet alle Abos in einer bestimmten App auf.

patch

 Aktualisiert ein vorhandenes Abo.

Fehlercodes

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

Fehlercode Grund Beschreibung Auflösung