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. Sie sind in der übergeordneten App eindeutig und 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. Preise und Dauer 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 Aboarchivierung wird nicht unterstützt.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Details zu Steuern und zur Einhaltung gesetzlicher Vorschriften.

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)
  }
  // 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 umfassen.
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 Abrechnungsbibliothek an die App zurückgegeben wurden. Aboangebote für dieses Basis-Abo erhalten diese Angebots-Tags auch in der Abrechnungsbibliothek.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

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

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

Sie können festlegen, wann 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 noch nicht aktiviert. Sie kann jetzt bedenkenlos 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. Abolaufzeit im Format ISO 8601. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe.
gracePeriodDuration

string

Kulanzzeitraum für das Abo, angegeben 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.
accountHoldDuration

string

Optional. Die Dauer der Kontosperre des Abos, angegeben im ISO 8601-Format. Zulässige Werte müssen zwischen DAYS und P0D (null Tage) bis 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 in Google Play-Oberflächen wieder abonnieren können. Wenn keine Angabe erfolgt, wird standardmäßig 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 kein Wert angegeben ist, wird standardmäßig CHARGE_ON_NEXT_BILLING_DATE verwendet.
legacyCompatible

boolean

Gibt an, ob das zu 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

Aboangebots-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 sich verlängerndes Basis-Abo kann nur ein Aboangebot als mit der alten Version kompatibel gekennzeichnet werden.

Wenn Sie kein Aboangebot als mit der alten Version kompatibel haben möchten, setzen Sie dieses Feld auf einen leeren String.

ResubscribeState

Status des erneuten Abonnierens 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 Anteilsvergleichsmodus, der zum Verlängern von Basis-Abos verwendet wird.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Modus nicht angegeben.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Das neue Basis-Abo 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 vollständig in Rechnung gestellt. Der verbleibende Zeitraum des bestehenden Abos wird verwendet, um die Dauer des neuen Preismodells 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. Abolaufzeit im Format ISO 8601. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe.
timeExtension

enum (TimeExtension)

Gibt an, ob Nutzer dieses Prepaid-Basis-Abo auf Google Play-Oberflächen verlängern können sollen. Falls 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 ihr Prepaid-Guthaben aufladen oder verlängern.
TIME_EXTENSION_INACTIVE Die Zeitverlängerung ist inaktiv. Nutzer können ihren Prepaid-Tarif nicht aufladen oder verlängern.

RegionalBasePlanConfig

Konfiguration für ein für eine Region spezifisches 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-Definition, 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, 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 Länder, in denen Google Play möglicherweise 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 neue Länder verwendet werden kann, in denen Play Play verfügbar sein wird.
eurPrice

object (Money)

Erforderlich. Preis in Euro für alle neuen Länder, in denen Play möglicherweise eingeführt wird.
newSubscriberAvailability

boolean

Gibt an, ob das Basis-Abo für neue Abonnenten an neuen Standorten verfügbar ist, an denen Google Play möglicherweise eingeführt wird. Wenn keine Angabe erfolgt, wird standardmäßig „false“ verwendet.

SubscriptionListing

Die für Nutzer sichtbaren Metadaten eines Abos.

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

string

Erforderlich. Die durch BCP-47 definierte Sprache dieses Eintrags, z.B. „en-US“.
title

string

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

string

Eine Liste der Vorteile, die dem Nutzer auf Plattformen wie dem Play Store und bei Wiederherstellungsprozessen in der Sprache dieses Eintrags angezeigt werden. Nur Text Sortierte Liste mit höchstens vier Vorteilen.
description

string

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

Methoden

archive
(deprecated)

 Eingestellt: 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 unter einer bestimmten App auf.

patch

 Aktualisiert ein bestehendes Abo.