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)
  }
}
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 und müssen mit einem Kleinbuchstaben oder einer Ziffer beginnen und müssen zwischen 1 und 40 Zeichen (einschließlich) 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. apks.list der lokalisierten Einträge für dieses Abo. Muss mindestens einen Eintrag für die Standardsprache der übergeordneten App enthalten.
archived

boolean

Nur Ausgabe. Gibt an, ob dieses Abo archiviert wurde. Archivierte Abos sind für keine Abonnenten mehr verfügbar, können nicht aktualisiert werden und werden in Listenanfragen nur dann zurückgegeben, wenn das Flag „Archivierte Elemente anzeigen“ übergeben wurde.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Details zu Steuern und zur Einhaltung von Rechtsvorschriften

Basis-Abo

Ein 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)
  }
  // End of list of possible types for union field base_plan_type.
}
Fields
basePlanId

string

Erforderlich. Nicht veränderbar. Die eindeutige Kennung dieses Basis-Abos. Darf innerhalb des Abos nur einmal vorkommen und muss RFC-1034-konform sein. Das heißt, dass die ID nur Kleinbuchstaben (a–z), Ziffern (0–9) und Bindestriche (-) enthalten darf und höchstens 63 Zeichen lang sein darf.
state

enum (State)

Nur Ausgabe. Der Status des Basis-Abos, d.h., ob er aktiv ist. Entwurfs- 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 geändert werden, indem die Ressource aktualisiert wird. Verwenden Sie stattdessen die dedizierten Endpunkte.
regionalConfigs[]

object (RegionalBasePlanConfig)

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

object (OfferTag)

apks.list von bis zu 20 benutzerdefinierten Tags, die für dieses Basis-Abo angegeben und über die Abrechnungsbibliothek an die App zurückgegeben wurden Abo-Angebote für dieses Basis-Abo erhalten diese Angebots-Tags ebenfalls in der Abrechnungsbibliothek.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Preisinformationen für neue Standorte, an denen Play möglicherweise in Zukunft eingeführt wird. Falls nicht angegeben, steht das Basis-Abo nicht automatisch für neue Standorte zur Verfügung, die in Zukunft von Play eingeführt werden könnten.
Union-Feld base_plan_type. Der Typ dieses Basis-Abos. Genau eins muss festgelegt werden. Für base_plan_type ist nur einer der folgenden Werte zulässig:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

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

Status

Aktueller Status eines Basis-Abos.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
DRAFT Das Basis-Abo befindet sich derzeit im Entwurfsstatus und wurde nicht aktiviert. Sie können es dann an diesem Punkt sicher 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.

Basis automatisch verlängern

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

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

string

Erforderlich. Abolaufzeit im Format gemäß ISO 8601. 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 verwendet, der auf der Dauer des wiederkehrenden Zeitraums basiert.
resubscribeState

enum (ResubscribeState)

Gibt an, ob Nutzer dieses Basis-Abo in Google Play-Plattformen wieder abonnieren können sollen. Wenn keine Angabe erfolgt, wird standardmäßig RESUBSCRIBE_STATE_ACTIVE verwendet.
prorationMode

enum (SubscriptionProrationMode)

Der anteilige Modus für das Basis-Abo bestimmt, was passiert, wenn ein Nutzer von einem anderen Basis-Abo zu diesem Abo wechselt. Enthält standardmäßig den Wert CHARGE_ON_NEXT_BILLING_DATE.
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.

Pro Abo kann nur ein sich verlängerndes Basis-Abo als mit der alten Version kompatibel gekennzeichnet werden.
legacyCompatibleSubscriptionOfferId

string

Die ID des Aboangebots, 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 bestehendes Basis-Abo kann nur ein Abo als mit der alten Version kompatibel gekennzeichnet werden.

Wenn kein Aboangebot vorhanden sein soll, das mit alten Versionen kompatibel ist, legen Sie dieses Feld als leeren String fest.

Erneut abonnieren

Abostatus wieder abonnieren.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED Nicht angegebener Zustand.
RESUBSCRIBE_STATE_ACTIVE Wieder abonnieren ist aktiv.
RESUBSCRIBE_STATE_INACTIVE Resubscribe is inactive.

Abonnementanteil

Der anteilige Modus für die Verlängerung von Basis-Abos.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Nicht angegebener Modus.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Nutzern wird das neue Basis-Abo am Ende des aktuellen Abrechnungszeitraums in Rechnung gestellt.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Das neue Basis-Abo wird Nutzern sofort und vollständig in Rechnung gestellt. Der verbleibende Zeitraum des bestehenden Abos wird verwendet, um die Dauer des neuen Abrechnungstarifs zu verlängern.

Prepaid-Basisplantyp

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

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

string

Erforderlich. Abolaufzeit im Format gemäß ISO 8601. 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-Plattformen verlängern können. Wenn keine Angabe erfolgt, wird standardmäßig TIME_EXTENSION_ACTIVE verwendet.

Zeiterweiterung

Verlängerung des Basis-Abos.

Enums
TIME_EXTENSION_UNSPECIFIED Unspecified state.
TIME_EXTENSION_ACTIVE Die Zeiterweiterung ist aktiv. Nutzer können ihr Prepaid-Guthaben aufladen oder verlängern.
TIME_EXTENSION_INACTIVE Die Zeiterweiterung ist inaktiv. Nutzer können ihr Prepaid-Guthaben weder aufladen noch verlängern.

RegionalBasePlanConfig

Konfiguration für ein Basis-Abo speziell für eine Region.

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

string

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

boolean

Gibt an, ob das Basis-Abo in der angegebenen Region für neue Abonnenten verfügbar ist. Bestehende Abonnenten werden nicht gekündigt, wenn dieser Wert auf „false“ gesetzt ist. Wenn keine Angabe erfolgt, ist der Standardwert „false“.
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 angegeben werden, die mit der angegebenen Region verknüpft ist.

Sonstige RegionBasePlanConfig

Preisinformationen für alle neuen Standorte, an denen Play möglicherweise eingeführt wird

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

object (Money)

Erforderlich. Preis in USD für neue Standorte, an denen Play möglicherweise eingeführt wird.
eurPrice

object (Money)

Erforderlich. Preis in EUR, der für neue Standorte verwendet werden soll, an denen Play verfügbar sein kann.
newSubscriberAvailability

boolean

Gibt an, ob das Basis-Abo für neue Abonnenten an allen neuen Standorten verfügbar sein wird, an denen Play verfügbar sein wird. Wenn keine Angabe erfolgt, ist der Standardwert „false“.

Aboliste

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 bei der Wiederherstellung in der Sprache dieses Eintrags angezeigt werden. Nur Text Bestellliste mit maximal vier Vorteilen.
description

string

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

Methoden

archive

 Archiviert ein Abo.

create

 Erstellt ein neues Abo.

delete

 Löscht ein Abo.

get

 Lies ein einzelnes Abo.

list

 Listet alle Abos in einer bestimmten App auf.

patch

 Aktualisiert ein vorhandenes Abo.