REST Resource: purchases.subscriptions

Ressource: SubscriptionPurchase

Eine SubscriptionPurchase-Ressource gibt den Status des Abokaufs eines Nutzers an.

JSON-Darstellung 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Felder
kind

string

Diese Art stellt ein „subscriptionPurchase“-Objekt im „androidpublisher“-Dienst dar.
startTimeMillis

string (int64 format)

Zeitpunkt, zu dem das Abo gewährt wurde, in Millisekunden seit der Epoche.
expiryTimeMillis

string (int64 format)

Zeitpunkt in Millisekunden seit der Epoche, zu dem das Abo abläuft.
autoResumeTimeMillis

string (int64 format)

Zeitpunkt in Millisekunden seit der Epoche, zu dem das Abo automatisch fortgesetzt wird. Nur vorhanden, wenn der Nutzer das Pausieren des Abos angefordert hat.
autoRenewing

boolean

Gibt an, ob das Abo bei Ablauf des aktuellen Ablaufdatums automatisch verlängert wird.
priceCurrencyCode

string

ISO 4217-Währungscode für den Abopreis. Ist der Preis beispielsweise in Britischen Pfund Sterling angegeben, lautet der Wert für priceCurrencyCode "GBP".
priceAmountMicros

string (int64 format)

Preis des Abos – in Ländern ohne Steuern ist der Preis ohne Steuern. Bei Ländern inklusive Steuern ist der Preis inklusive Steuern. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten eine Währungseinheit darstellen. Beträgt der Abonnementpreis beispielsweise 1, 99 €, beträgt priceAmountMicros 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Informationen zum Einführungspreis des Abos. Diese Option ist nur vorhanden, wenn das Abo mit einem Einführungspreis erworben wurde.

Dieses Feld bedeutet nicht, dass sich das Abo derzeit in der Phase des Einführungspreises befindet.
countryCode

string

ISO 3166-1 Alpha-2-Rechnungsland-/Regionscode des Nutzers zum Zeitpunkt der Abobewilligung.
developerPayload

string

Ein vom Entwickler angegebener String, der zusätzliche Informationen zu einer Bestellung enthält.
paymentState

integer

Der Zahlungsstatus des Abos. Mögliche Werte sind: 0. Zahlung ausstehend 1. Zahlung erhalten 2. Kostenloser Testzeitraum 3. Verzögertes Upgrade/Downgrade ausstehend

Nicht vorhanden bei gekündigten, abgelaufenen Abonnements.
cancelReason

integer

Der Grund, warum ein Abo gekündigt wurde oder sich nicht automatisch verlängert. Mögliche Werte sind: 0. Der Nutzer hat das Abo gekündigt. 1. Das Abo wurde vom System gekündigt, beispielsweise wegen eines Abrechnungsproblems. 2. Das Abo wurde durch ein neues Abo ersetzt. 3. Abo wurde vom Entwickler gekündigt
userCancellationTimeMillis

string (int64 format)

Der Zeitpunkt in Millisekunden seit der Epoche, zu dem das Abonnement vom Nutzer gekündigt wurde. Nur vorhanden, wenn cancelReason 0 ist.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

Informationen, die der Nutzer beim Abschließen des Abo-Kündigungsvorgangs angegeben hat (Umfrage zu Kündigungsgründen).
orderId

string

Die Bestell-ID des letzten Dauerauftrags, der mit dem Kauf des Abonnements verknüpft ist. Wenn das Abo aufgrund einer abgelehnten Zahlung gekündigt wurde, ist dies die Bestell-ID der Bestellung mit der abgelehnten Zahlung.
linkedPurchaseToken

string

Das Kauftoken des ursprünglichen Kaufs, wenn dieses Abo einen der folgenden Werte hat: 0. Erneute Anmeldung eines gekündigten, aber nicht abgelaufenen Abos 1. Upgrade/Downgrade auf ein früheres Abo ausführen

Angenommen, ein Nutzer registriert sich ursprünglich und Sie erhalten das Kauf-Token X. Dann kündigt der Nutzer den Vorgang und führt die Neuregistrierung durch, bevor das Abo abläuft. Sie erhalten das Kauf-Token Y, der Nutzer aktualisiert sein Abo und Sie erhalten das Kauf-Token Z. Wenn Sie diese API mit dem Kauftoken Z aufrufen, wird dieses Feld auf Y gesetzt. Wenn Sie diese API mit dem Kauftoken Y aufrufen, wird dieses Feld auf „X“ gesetzt. Wenn Sie diese API mit dem Kauftoken X aufrufen, wird dieses Feld nicht festgelegt.
purchaseType

integer

Die Art des Kaufs des Abos. Dieses Feld wird nur festgelegt, wenn dieser Kauf nicht über den standardmäßigen In-App-Abrechnungsvorgang getätigt wurde. Mögliche Werte sind: 0. Test (d.h. Kauf über ein Lizenztestkonto) 1. Angebot (Kauf mit einem Gutscheincode)
priceChange

object (SubscriptionPriceChange)

Die neuesten Informationen zu Preisänderungen. Dies ist nur vorhanden, wenn eine Preisänderung für das Abo bevorsteht, die noch angewendet werden muss.

Sobald das Abo mit dem neuen Preis verlängert oder das Abo gekündigt wird, werden keine Informationen zu Preisänderungen mehr zurückgegeben.
profileName

string

Der Profilname des Nutzers beim Kauf des Abos. Nur für Käufe über „Abonnieren mit Google“ vorhanden.
emailAddress

string

Die E-Mail-Adresse des Nutzers beim Kauf des Abos. Nur für Käufe über „Abonnieren mit Google“ vorhanden.
givenName

string

Der Vorname des Nutzers beim Kauf des Abos. Nur für Käufe über „Abonnieren mit Google“ vorhanden.
familyName

string

Der Familienname des Nutzers beim Kauf des Abos. Nur für Käufe über „Abonnieren mit Google“ vorhanden.
profileId

string

Die Google-Profil-ID des Nutzers beim Kauf des Abos. Nur für Käufe über „Abonnieren mit Google“ vorhanden.
acknowledgementState

integer

Der Bestätigungsstatus des Aboprodukts. Mögliche Werte sind: 0. Noch nicht bestätigt 1. Bestätigt
externalAccountId

string

ID des Nutzerkontos im Drittanbieterdienst. Nur vorhanden, wenn die Kontoverknüpfung im Rahmen des Abokaufs erfolgte.
promotionType

integer

Die Art des Angebots, das auf diesen Kauf angewendet wird. Dieses Feld wird nur festgelegt, wenn beim Kauf des Abos ein Angebot angewendet wird. Mögliche Werte sind: 0. Einmaliger Code 1. Vanity-Code
promotionCode

string

Der Gutscheincode, der für diesen Kauf gilt. Dieses Feld wird nur festgelegt, wenn beim Kauf des Abos eine Vanity-Code-Promotion angewendet wird.
obfuscatedExternalAccountId

string

Eine verschleierte Version der ID, die dem Konto des Nutzers in Ihrer App eindeutig zugeordnet ist. Für die folgenden Käufe vorhanden: * Wenn die Kontoverknüpfung im Rahmen des Abokaufs erfolgt ist. * Er wurde beim Kauf mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid angegeben.
obfuscatedExternalProfileId

string

Eine verschleierte Version der ID, die eindeutig dem Nutzerprofil in Ihrer App zugeordnet ist. Nur vorhanden, wenn beim Kauf mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid angegeben wurde.

IntroductoryPriceInfo

Enthält Informationen zum Einführungspreis für ein Abo.

JSON-Darstellung 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
Felder
introductoryPriceCurrencyCode

string

ISO 4217-Währungscode für den Einführungspreis für das Abo. Ist der Preis beispielsweise in Britischen Pfund Sterling angegeben, lautet der Wert für priceCurrencyCode "GBP".
introductoryPriceAmountMicros

string (int64 format)

Einführungspreis des Abos, zuzüglich Steuern. Die Währung ist mit der Währung „priceCurrencyCode“ identisch. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten eine Währungseinheit darstellen. Beträgt der Abonnementpreis beispielsweise 1, 99 €, beträgt priceAmountMicros 1990000.
introductoryPricePeriod

string

Zeitraum für Einführungspreis, angegeben im ISO-8601-Format. Gängige Werte sind unter anderem "P1W" (eine Woche), "P1M" (ein Monat), "P3M" (drei Monate), "P6M" (sechs Monate) und "P1Y" (ein Jahr).
introductoryPriceCycles

integer

Die Anzahl der Abrechnungszeiträume, für die der Einführungspreis angeboten wird.

SubscriptionCancelSurveyResult

Informationen, die der Nutzer beim Abschließen des Abo-Kündigungsvorgangs angegeben hat (Umfrage zu Kündigungsgründen).

JSON-Darstellung 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
Felder
cancelSurveyReason

integer

Der Kündigungsgrund, den der Nutzer in der Umfrage ausgewählt hat. Mögliche Werte sind: 0. Sonstiges 1. Ich nutze diesen Dienst zu selten 2. Technische Probleme 3. Aus Kostengründen 4. Weil ich eine bessere App gefunden habe
userInputCancelReason

string

Der benutzerdefinierte Grund für den Abbruch der Eingabe durch den Nutzer. Nur vorhanden, wenn cancelReason 0 ist.

SubscriptionPriceChange

Enthält Informationen zu Preisänderungen für ein Abo, mit denen der Kaufprozess bei der Preisänderung in der App gesteuert werden kann. Dies kann in Form der Bestätigung des Nutzers oder der Anpassung der Nutzererfahrung für eine erfolgreiche Conversion erfolgen.

JSON-Darstellung 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
Felder
newPrice

object (Price)

Der neue Preis, zu dem das Abo verlängert wird, wenn der Nutzer die Preisänderung akzeptiert.
state

integer

Der aktuelle Status der Preisänderung. Mögliche Werte sind: 0. Ausstehend: Gibt den Status für eine ausstehende Preisänderung an, bei der der Nutzer seine Zustimmung noch nicht erteilt hat. In diesem Status können Sie optional mithilfe der In-App API eine Bestätigung vom Nutzer einholen. 1. Akzeptiert: Geben Sie eine akzeptierte Preisänderung an, mit der das Abo verlängert wird, sofern es nicht gekündigt wird. Die Preisänderung tritt an einem Datum in Kraft, an dem das Abo verlängert wird. Hinweis: Die Änderung tritt möglicherweise nicht bei der nächsten Verlängerung des Abos ein.

Methoden

acknowledge

 Bestätigt den Abokauf.

cancel

 Storniert den Abokauf eines Nutzers.

defer

 Der Abokauf eines Nutzers wird bis zu einer bestimmten zukünftigen Ablaufzeit aufgeschoben.

get

 Überprüft, ob der Abokauf eines Nutzers gültig ist, und gibt die Ablaufzeit zurück.

refund

 Erstattet den Abonnementkauf eines Nutzers, das Abo bleibt jedoch bis zum Ablauf der Gültigkeit gültig und wird wiederholt.

revoke

 Der Abokauf eines Nutzers wird erstattet und der Kauf des Abos wird sofort widerrufen.