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. Innerhalb der übergeordneten App eindeutig. Produkt-IDs müssen aus Kleinbuchstaben (a–z), Ziffern (0–9), Unterstrichen (_) und Punkten (.) bestehen. Er muss mit einem Kleinbuchstaben oder einer Ziffer beginnen und zwischen 1 und 40 Zeichen (einschließlich) lang sein.
basePlans[]

object (BasePlan)

Die Basis-Abos für dieses Abo. Gibt die Preise und die Dauer des Abos an, sofern keine anderen Angebote zutreffen.
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. Verworfen: Die Aboarchivierung wird nicht unterstützt.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Details zu Steuern und Einhaltung gesetzlicher Vorgaben.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Optional. Länder, in denen der Kauf dieses Abos auf Zahlungsmethoden beschränkt ist, die im selben Land registriert sind. Wenn das Feld leer ist, gelten keine Einschränkungen für den Zahlungsstandort.

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 ID dieses Basis-Abos. Darf innerhalb des Abos nur einmal vorkommen und RFC-1034-konform sein. Das heißt, diese ID darf nur Kleinbuchstaben (a–z), Ziffern (0–9) und Bindestriche (-) enthalten und höchstens 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 wurden. Aboangebote für dieses Basis-Abo erhalten diese Angebots-Tags auch in der Billing Library.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Preisinformationen für neue Standorte, an denen Google Play möglicherweise in Zukunft eingeführt wird. Wenn keine Angabe gemacht wird, ist der BasePlan nicht automatisch für alle neuen Standorte verfügbar, die Google Play in Zukunft einführen könnte.
Union-Feld base_plan_type. Der Typ dieses Basis-Abos. Es muss genau ein Wert festgelegt werden. Für base_plan_type ist nur einer der folgenden Werte zulässig:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Hier können Sie festlegen, wann das Basis-Abo in regelmäßigen Abständen automatisch verlängert wird.
prepaidBasePlanType

object (PrepaidBasePlanType)

Hiermit wird festgelegt, wann das Basis-Abo am Ende des Abrechnungszeitraums nicht automatisch verlängert wird.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Wird für Basis-Abos mit Ratenzahlung festgelegt, bei denen ein Nutzer zu einer bestimmten Anzahl von Zahlungen verpflichtet ist.

Status

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 problemlos 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 der Abolaufzeit 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. Abolaufzeit im ISO-8601-Format angegeben. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe.
gracePeriodDuration

string

Kulanzzeitraum für das Abo im ISO 8601-Format. Zulässige Werte sind P0D (null Tage), P3D (3 Tage), P7D (7 Tage), P14D (14 Tage) und P30D (30 Tage). Wenn keine Angabe erfolgt, wird ein Standardwert basierend auf der Dauer der wiederkehrenden Periode verwendet.
accountHoldDuration

string

Optional. Die Kontosperre für das Abo im ISO-8601-Format. Zulässige Werte müssen in DAYS angegeben werden und zwischen P0D (null Tage) und P30D (30 Tage) liegen. Wenn keine Angabe erfolgt, wird der Standardwert P30D (30 Tage) verwendet.
resubscribeState

enum (ResubscribeState)

Gibt an, ob Nutzer dieses Basis-Abo auf den Google Play-Oberflächen wieder abonnieren können. Wenn keine Angabe erfolgt, wird die Standardeinstellung RESUBSCRIBE_STATE_ACTIVE verwendet.
prorationMode

enum (SubscriptionProrationMode)

Mit dem Zuteilungsmodus für das Basis-Abo wird festgelegt, was passiert, wenn ein Nutzer von einem anderen Basis-Abo zu diesem Abo wechselt. Wenn keine Angabe erfolgt, wird standardmäßig CHARGE_ON_NEXT_BILLING_DATE verwendet.
legacyCompatible

boolean

Gibt an, ob das Basis-Abo, das sich verlängern soll, abwärtskompatibel ist.

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

Nur ein Basis-Abo, das sich verlängern kann, kann für ein bestimmtes Abo als mit der alten Version kompatibel gekennzeichnet werden.
legacyCompatibleSubscriptionOfferId

string

Abo-Angebots-ID, 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, das verlängert wird, kann nur ein Aboangebot als mit alten Versionen kompatibel gekennzeichnet werden.

Wenn Sie kein Abo-Angebot als alte kompatible Version haben möchten, legen Sie dieses Feld als leeren String fest.

ResubscribeState

Status: Wieder abonnieren des Basis-Abos.

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

SubscriptionProrationMode

Der Zuteilungsmodus, der zum Verlängern von Basis-Abos verwendet wird.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Nicht spezifizierter Modus.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Den Nutzern wird am Ende des aktuellen Abrechnungszeitraums das neue Basis-Abo in Rechnung gestellt.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Nutzern wird das neue Basis-Abo sofort und vollständig in Rechnung gestellt. Die verbleibende Laufzeit des bestehenden Abos wird zur Verlängerung der Laufzeit des neuen Abrechnungsmodells verwendet.

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. Abolaufzeit im ISO-8601-Format angegeben. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe.
timeExtension

enum (TimeExtension)

Gibt an, ob Nutzer dieses Basis-Abo mit Vorauszahlung auf Google Play-Oberflächen verlängern können sollen. Wenn keine Angabe erfolgt, wird die Standardeinstellung TIME_EXTENSION_ACTIVE verwendet.

TimeExtension

Zeitverlängerung für Basis-Abo.

Enums
TIME_EXTENSION_UNSPECIFIED Nicht angegebener Zustand.
TIME_EXTENSION_ACTIVE Zeitverlängerung ist aktiv. Nutzer können ihren Prepaid-Tarif aufladen oder verlängern.
TIME_EXTENSION_INACTIVE Die Zeiterweiterung 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. Abolaufzeit im ISO-8601-Format angegeben. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe.
committedPaymentsCount

integer

Erforderlich. Die Anzahl der Zahlungen, zu denen der Nutzer verpflichtet ist.
renewalType

enum (RenewalType)

Erforderlich. Verlängerungstyp des Basis-Abos. Bestimmt das Verhalten am Ende der anfänglichen Zusicherung.
gracePeriodDuration

string

Kulanzzeitraum für das Abo im ISO 8601-Format. Zulässige Werte sind P0D (null Tage), P3D (3 Tage), P7D (7 Tage), P14D (14 Tage) und P30D (30 Tage). Wenn keine Angabe erfolgt, wird ein Standardwert basierend auf der Dauer der wiederkehrenden Periode verwendet.
accountHoldDuration

string

Optional. Die Kontosperre für das Abo, die ausschließlich in Tagen und im Format ISO 8601 angegeben ist. Zulässige Werte sind P0D (null Tage) bis P30D (30 Tage). Wenn keine Angabe erfolgt, wird der Standardwert P30D (30 Tage) verwendet.
resubscribeState

enum (ResubscribeState)

Gibt an, ob Nutzer dieses Basis-Abo auf den Google Play-Oberflächen wieder abonnieren können. Wenn keine Angabe erfolgt, wird die Standardeinstellung RESUBSCRIBE_STATE_ACTIVE verwendet.
prorationMode

enum (SubscriptionProrationMode)

Mit dem Zuteilungsmodus für das Basis-Abo wird festgelegt, was passiert, wenn ein Nutzer von einem anderen Basis-Abo zu diesem Abo wechselt. Wenn keine Angabe erfolgt, wird standardmäßig CHARGE_ON_NEXT_BILLING_DATE verwendet.

RenewalType

Verlängerungstyp des Basis-Abos. Bestimmt das Verhalten am Ende der anfänglichen Zusicherung.

Enums
RENEWAL_TYPE_UNSPECIFIED Nicht angegebener Zustand.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Wird regelmäßig für den gesamten Abrechnungszeitraum ohne Verpflichtung verlängert.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Wird mit der gleichen Dauer wie die ursprüngliche Zusicherung verlängert.

RegionalBasePlanConfig

Konfiguration eines Basis-Abos für eine Region.

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

string

Erforderlich. Regionscode, für den diese Konfiguration gilt, wie in ISO 3166-2 definiert, z.B. „US“.
newSubscriberAvailability

boolean

Gibt an, ob das Basis-Abo in der angegebenen Region für neue Abonnenten verfügbar ist. Das Abo für bestehende Abonnenten wird nicht gekündigt, wenn dieser Wert auf „false“ gesetzt ist. Wenn keine Angabe erfolgt, 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 Google Play eingeführt werden kann.

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

object (Money)

Erforderlich. Preis in US-Dollar, der für neue Play-Standorte verwendet werden soll.
eurPrice

object (Money)

Erforderlich. Der Preis in Euro, der für neue Play-Standorte verwendet werden soll.
newSubscriberAvailability

boolean

Gibt an, ob das Basis-Abo für neue Abonnenten an neuen Standorten verfügbar ist, an denen Google Play eingeführt werden kann. Wenn keine Angabe erfolgt, 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 gemäß BCP-47-Definition, z.B. „de-DE“.
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 Wiederherstellungsprozessen in der Sprache dieses Eintrags angezeigt wird. Nur Text Geordnete Liste mit höchstens 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 dieses Produkt auf Zahlungsmethoden gekauft werden kann, die im selben Land registriert sind. Wenn das Feld leer ist, gelten keine Einschränkungen für den Zahlungsstandort.

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

string

Erforderlich. Regionscodes, für die Zahlungsbeschränkungen gelten, wie nach ISO 3166-2 definiert, z.B. „US“.

Methoden

archive
(deprecated)

 Verworfen: Die Aboarchivierung 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 für eine bestimmte App auf.

patch

 Aktualisiert ein bestehendes Abo.