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. Die eindeutige Produkt-ID des Produkts. Sie muss innerhalb der übergeordneten App eindeutig sein. 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. Enthält die Preise und die Laufzeit des Abos, 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 rechtlicher Compliance
restrictedPaymentCountries

object (RestrictedPaymentCountries)

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

BasePlan

Ein einzelner Basistarif 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 Basistarifs. Darf innerhalb des Abos nur einmal vorkommen und muss RFC-1034 entsprechen. Die 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 gesetzt werden. Inaktive Basis-Abos können gekündigt werden. Dieses Feld kann nicht durch Aktualisieren der Ressource geändert werden. Verwenden Sie stattdessen die speziellen Endpunkte.
regionalConfigs[]

object (RegionalBasePlanConfig)

Regionsspezifische Informationen zu diesem Basistarif.
offerTags[]

object (OfferTag)

Liste mit bis zu 20 benutzerdefinierten Tags, die für diesen Basistarif angegeben und über die Billing Library an die App zurückgegeben werden. Aboangebote für diesen Basistarif erhalten ebenfalls diese Angebots-Tags in der Abrechnungsbibliothek.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Preisinformationen für alle neuen Standorte, die Google Play in Zukunft einführen könnte. Wenn Sie diesen Parameter weglassen, ist der BasePlan nicht automatisch für neue Standorte verfügbar, die in Google Play in Zukunft eingeführt werden.
Union-Feld base_plan_type. Der Typ dieses Basis-Abos. Es muss genau eine festgelegt werden. Der Basisplantyp 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)

Wird festgelegt, wenn der Base Plan am Ende des Abrechnungszeitraums nicht automatisch verlängert wird.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Legen Sie diese Option für Basis-Abos mit Ratenzahlung fest, bei denen sich ein Nutzer zu einer bestimmten Anzahl von Zahlungen verpflichtet.

Status

Aktueller Status eines Basis-Abos.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
DRAFT Der Basisplan befindet sich derzeit im Status „Entwurf“ und wurde noch nicht aktiviert. Sie können es jetzt löschen.
ACTIVE Das Basis-Abo ist aktiv und für neue Abonnenten verfügbar.
INACTIVE Der Basistarif ist inaktiv und nur für bestehende Abonnenten verfügbar.

AutoRenewingBasePlanType

Stellt ein Basis-Abo dar, das sich am Ende der Abolaufzeit automatisch verlängert.

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 ist nach dem Erstellen 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 kürzeren der beiden Werte „30D“ und der Abrechnungsperiode des Basistarifs liegen.

Wenn keine Angabe erfolgt, wird ein Standardwert basierend auf dem Abrechnungszeitraum verwendet.

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

string

Optional. Die Kontosperre des Abos im ISO 8601-Format. Zulässige Werte müssen in Tagen angegeben und zwischen P0D und P60D liegen.

Wenn keine Angabe erfolgt, beträgt der Standardwert P30D.

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

enum (ResubscribeState)

Ob Nutzer dieses Basis-Abo auf Google Play-Oberflächen wieder abonnieren können sollen. Wenn keine Angabe erfolgt, ist der Standardwert RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Mit dem Modus für die Aufteilung des Grundpreises für das Basis-Abo wird festgelegt, 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 verlängernder Basistarif als abwärtskompatibel markiert werden.
legacyCompatibleSubscriptionOfferId

string

Die Angebots-ID des Abos, die mit der alten Version 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 abwärtskompatibel gekennzeichnet werden.

Wenn kein Aboangebot mit der alten Version kompatibel sein soll, setzen Sie dieses Feld auf einen leeren String.

ResubscribeState

Status der Reaktivierung des Base Plan

Enums
RESUBSCRIBE_STATE_UNSPECIFIED Nicht angegebener Zustand.
RESUBSCRIBE_STATE_ACTIVE Die Option „Wieder abonnieren“ ist aktiv.
RESUBSCRIBE_STATE_INACTIVE Die Option „Wieder abonnieren“ ist inaktiv.

SubscriptionProrationMode

Der Modus für die Aufteilung, der für die Verlängerung von Basistarifen verwendet wird.

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 Abo am Ende des aktuellen Abrechnungszeitraums in Rechnung gestellt.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Nutzer werden die Kosten für ihr neues Basis-Abo sofort und in voller Höhe in Rechnung gestellt. Die verbleibende Laufzeit des bestehenden Abos wird auf die Laufzeit des neuen Abrechnungszeitraums angerechnet.

PrepaidBasePlanType

Stellt ein Basis-Abo dar, das sich am Ende des Basis-Abos 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 ist nach dem Erstellen des Basisplans unveränderlich.
timeExtension

enum (TimeExtension)

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

TimeExtension

Verlängerung der Laufzeit des Basis-Abos

Enums
TIME_EXTENSION_UNSPECIFIED Nicht angegebener Zustand.
TIME_EXTENSION_ACTIVE Die Zeitverlängerung ist aktiv. Nutzer dürfen ihr Prepaid-Guthaben aufladen oder verlängern.
TIME_EXTENSION_INACTIVE Die Zeitverlängerung ist inaktiv. Nutzer können ihr Prepaid-Guthaben nicht aufladen oder ihren Prepaid-Tarif 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 ist nach dem Erstellen des Basisplans unveränderlich.
committedPaymentsCount

integer

Erforderlich. Nicht veränderbar. Die Anzahl der Zahlungen, die der Nutzer zu leisten verpflichtet ist. Nach dem Erstellen des Basisplans ist er unveränderlich.
renewalType

enum (RenewalType)

Erforderlich. Nicht veränderbar. Verlängerungstyp des Base Plan mit Ratenzahlung Bestimmt das Verhalten am Ende der ursprünglichen Bindung. Der Verlängerungstyp kann nach dem Erstellen 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 kürzeren der beiden Werte „30D“ und der Abrechnungsperiode des Basistarifs liegen.

Wenn keine Angabe erfolgt, wird ein Standardwert basierend auf dem Abrechnungszeitraum verwendet.

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

string

Optional. Die Kontosperre des Abos im ISO 8601-Format. Zulässige Werte müssen in Tagen angegeben und zwischen P0D und P60D liegen.

Wenn keine Angabe erfolgt, beträgt der Standardwert P30D.

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

enum (ResubscribeState)

Ob Nutzer dieses Basis-Abo auf Google Play-Oberflächen wieder abonnieren können sollen. Wenn keine Angabe erfolgt, ist der Standardwert RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Mit dem Modus für die Aufteilung des Grundpreises für das Basis-Abo wird festgelegt, was passiert, wenn ein Nutzer von einem anderen Basis-Abo zu diesem wechselt. Wenn nicht angegeben, wird standardmäßig CHARGE_ON_NEXT_BILLING_DATE verwendet.

RenewalType

Verlängerungstyp des Basistarifs mit Ratenzahlung. Bestimmt das Verhalten am Ende der ursprünglichen Bindung. Der Verlängerungstyp kann nach dem Erstellen des Basisplans nicht mehr geändert werden.

Enums
RENEWAL_TYPE_UNSPECIFIED Nicht angegebener Zustand.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Wird ohne Bindung regelmäßig für die Dauer des Abrechnungszeitraums verlängert.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Verlängerung mit einer Zusicherung derselben Dauer wie die ursprüngliche.

RegionalBasePlanConfig

Konfiguration für ein regionsspezifisches Basis-Abo.

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

string

Erforderlich. 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. Wenn dieser Wert auf „false“ gesetzt ist, wird das Abo bestehender Abonnenten nicht gekündigt. Wenn keine Angabe erfolgt, wird standardmäßig „falsch“ 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 sein, die mit der angegebenen Region verknüpft ist.

OtherRegionsBasePlanConfig

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

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 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.
newSubscriberAvailability

boolean

Ob das Basis-Abo für neue Abonnenten in allen neuen Ländern und Regionen verfügbar ist, in denen Google Play eingeführt wird. Wenn keine Angabe erfolgt, wird standardmäßig „falsch“ 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 gemäß BCP-47, 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 Nutzern auf Plattformen wie dem Play Store und in Wiederherstellungsabläufen in der Sprache dieses Eintrags angezeigt werden. Nur Text Eine sortierte Liste mit maximal vier Vorteilen.
description

string

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

RestrictedPaymentCountries

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

JSON-Darstellung 
{
  "regionCodes": [
    string
  ]
}
Felder
regionCodes[]

string

Erforderlich. Regionscodes, für die Zahlungsbeschränkungen gemäß ISO 3166-2 gelten sollen, z.B. „US“.

Methoden

archive
(deprecated)

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

batchGet

 Liest ein oder mehrere Abos.

batchUpdate

 Aktualisiert mehrere Abos.

create

 Erstellt ein neues Abo.

delete

 Löscht ein Abo.

get

 Liest ein einzelnes Abo.

list

 Listet alle Abos unter einer bestimmten App auf.

patch

 Aktualisiert ein vorhandenes Abo.