- Ressource: Abo
- BasePlan
- Bundesland
- AutoRenewingBasePlanType
- ResubscribeState
- SubscriptionProrationMode
- PrepaidBasePlanType
- TimeExtension
- InstallmentsBasePlanType:
- RenewalType
- RegionalBasePlanConfig
- OtherRegionsBasePlanConfig
- SubscriptionListing
- RestrictedPaymentCountries
- Methoden
Ressource: Abo
Ein einzelnes Abo für eine App.
JSON-Darstellung |
---|
{ "packageName": string, "productId": string, "basePlans": [ { object ( |
Felder | |
---|---|
packageName |
Nicht veränderbar. Paketname der übergeordneten App. |
productId |
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[] |
Die Basis-Abos für dieses Abo. Preise und Dauer des Abos, wenn keine anderen Angebote gelten. |
listings[] |
Erforderlich. Liste der lokalisierten Einträge für dieses Abo. Muss mindestens einen Eintrag für die Standardsprache der übergeordneten App enthalten. |
archived |
Nur Ausgabe. Eingestellt: Die Aboarchivierung wird nicht unterstützt. |
taxAndComplianceSettings |
Details zu Steuern und zur Einhaltung gesetzlicher Vorschriften. |
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 bezüglich des Zahlungsstandorts. |
BasePlan
Ein einzelnes Basis-Abo für ein Abo.
JSON-Darstellung |
---|
{ "basePlanId": string, "state": enum ( |
Felder | |
---|---|
basePlanId |
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 |
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[] |
Regionsspezifische Informationen für dieses Basis-Abo. |
offerTags[] |
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 |
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 |
Sie können festlegen, wann das Basis-Abo in regelmäßigen Abständen automatisch verlängert wird. |
prepaidBasePlanType |
Sie können festlegen, wann das Basis-Abo am Ende des Abrechnungszeitraums nicht automatisch verlängert wird. |
installmentsBasePlanType |
Wird für Basis-Abos mit Raten festgelegt, bei denen sich ein Nutzer zu einer bestimmten Anzahl von Zahlungen verpflichtet hat. |
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 ( |
Felder | |
---|---|
billingPeriodDuration |
Erforderlich. Abolaufzeit im Format ISO 8601. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe. |
gracePeriodDuration |
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 |
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 |
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 |
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 |
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 |
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 ( |
Felder | |
---|---|
billingPeriodDuration |
Erforderlich. Abolaufzeit im Format ISO 8601. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe. |
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. |
InstallmentsBasePlanType
Stellt ein Basis-Abo mit Ratenzahlungen dar, bei dem sich ein Nutzer zu einer bestimmten Anzahl von Zahlungen verpflichtet.
JSON-Darstellung |
---|
{ "billingPeriodDuration": string, "committedPaymentsCount": integer, "renewalType": enum ( |
Felder | |
---|---|
billingPeriodDuration |
Erforderlich. Abolaufzeit im Format ISO 8601. Eine Liste der zulässigen Abrechnungszeiträume finden Sie in der Hilfe. |
committedPaymentsCount |
Erforderlich. Die Anzahl der Zahlungen, zu denen sich der Nutzer verpflichtet hat. |
renewalType |
Erforderlich. Verlängerungstyp der Basis-Abo-Ratenzahlung. Bestimmt das Verhalten am Ende der ersten Zusicherung. |
gracePeriodDuration |
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 |
Optional. Die Dauer der Kontosperre des Abos wird ausschließlich in Tagen und im ISO-8601-Format angegeben. Zulässige Werte sind P0D (null Tage) bis P30D (30 Tage). Wenn keine Angabe erfolgt, wird der Standardwert P30D (30 Tage) verwendet. |
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 |
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. |
RenewalType
Verlängerungstyp der Basis-Abo-Ratenzahlung. Bestimmt das Verhalten am Ende der ersten Zusicherung.
Enums | |
---|---|
RENEWAL_TYPE_UNSPECIFIED |
Nicht angegebener Zustand. |
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT |
Wird in regelmäßigen Abständen ohne Bindung für den Abrechnungszeitraum verlängert. |
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT |
Wird mit der Zusicherung verlängert, die dieselbe Laufzeit hat wie die ursprüngliche. |
RegionalBasePlanConfig
Konfiguration für ein für eine Region spezifisches Basis-Abo.
JSON-Darstellung |
---|
{
"regionCode": string,
"newSubscriberAvailability": boolean,
"price": {
object ( |
Felder | |
---|---|
regionCode |
Erforderlich. Regionscode, für den diese Konfiguration gilt gemäß ISO 3166-2-Definition, z.B. „US“. |
newSubscriberAvailability |
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 |
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 ( |
Felder | |
---|---|
usdPrice |
Erforderlich. Preis in US-Dollar, der für neue Länder verwendet werden kann, in denen Google Play verfügbar sein wird. |
eurPrice |
Erforderlich. Preis in Euro für alle neuen Länder, in denen Play möglicherweise eingeführt wird. |
newSubscriberAvailability |
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 |
Erforderlich. Die durch BCP-47 definierte Sprache dieses Eintrags, z.B. „en-US“. |
title |
Erforderlich. Der Titel dieses Abos in der Sprache des Eintrags. Nur Text |
benefits[] |
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 |
Die Beschreibung dieses Abos in der Sprache des 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 Einschränkungen bezüglich des Zahlungsstandorts.
JSON-Darstellung |
---|
{ "regionCodes": [ string ] } |
Felder | |
---|---|
regionCodes[] |
Erforderlich. Regionscodes, für die Zahlungsbeschränkungen gemäß ISO 3166-2 gelten, z.B. „US“. |
Methoden |
|
---|---|
(deprecated) |
Eingestellt: Die Aboarchivierung wird nicht unterstützt. |
|
Liest ein oder mehrere Abos. |
|
Aktualisiert einen Batch von Abos. |
|
Erstellt ein neues Abo. |
|
Löscht ein Abo. |
|
Liest ein einzelnes Abo. |
|
Listet alle Abos unter einer bestimmten App auf. |
|
Aktualisiert ein bestehendes Abo. |