REST Resource: purchases.subscriptions

Ressource: SubscriptionPurchase

Eine SubscriptionPurchase-Ressource zeigt 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 Epoche
expiryTimeMillis

string (int64 format)

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

string (int64 format)

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

boolean

Gibt an, ob das Abo automatisch verlängert wird, wenn die aktuelle Ablaufzeit erreicht ist.
priceCurrencyCode

string

Der ISO 4217-Währungscode für den Abopreis. Wenn der Preis beispielsweise in britischen Pfund Sterling angegeben ist, ist priceCurrencyCode "GBP".
priceAmountMicros

string (int64 format)

Preis des Abos. In Ländern ohne Steuern ist der Preis ohne Steuern angegeben. In Ländern, in denen die Umsatzsteuer inbegriffen ist, ist der Preis inklusive Steuern. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten eine Währungseinheit darstellen. Wenn der Preis des Abos beispielsweise 1, 99 € beträgt, beträgt er für PriceAmountMicros 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Einführungspreisinformationen für das Abo. Dies ist nur vorhanden, wenn das Abo mit einem Einführungspreis gekauft wurde.

Dieses Feld gibt nicht an, dass sich das Abo derzeit im Einführungspreis befindet.
countryCode

string

ISO 3166-1 Alpha-2-Abrechnungscode des Nutzers zum Zeitpunkt der Aboregistrierung.
developerPayload

string

Ein vom Entwickler angegebener String, der ergänzende Informationen zu einem Auftrag enthält.
paymentState

integer

Der Zahlungsstatus des Abos. Mögliche Werte sind: 0 Ausstehende Zahlung 1. Zahlung am 2. Kostenlose Testversion 3. Ausstehende nachträgliche Umstellung/Downgrade

Bei stornierten, abgelaufenen Abos nicht vorhanden.
cancelReason

integer

Der Grund dafür, dass 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, z. B. aufgrund eines Abrechnungsproblems 2. Das Abo wurde durch ein neues Abo ersetzt: 3. Abo wurde vom Entwickler gekündigt
userCancellationTimeMillis

string (int64 format)

Zeitpunkt, zu dem das Abo vom Nutzer gekündigt wurde, in Millisekunden seit UNIX-Zeitraum Ist nur vorhanden, wenn „cancelReason“ „0“ ist.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

Informationen, die der Nutzer beim Abschließen des Abos angegeben hat (Umfrage zur Kündigung).
orderId

string

Die Bestell-ID der letzten wiederkehrenden Bestellung, die mit dem Kauf des Abos verbunden ist. Wenn das Abo aufgrund einer abgelehnten Zahlung storniert wurde, ist dies die Bestell-ID aus der abgelehnten Zahlung.
linkedPurchaseToken

string

Das Kauftoken des ursprünglichen Kaufs, wenn dieses Abo eines der folgenden ist: 0. Wiederregistrierung eines gekündigten, aber nicht abgelaufenen Abos 1. Upgrade/Downgrade von einem vorherigen Abo durchführen

Angenommen, ein Nutzer hat sich ursprünglich registriert und erhält nun das Kauftoken X. Dann kündigt er den Vorgang für die Neuregistrierung (vor Ablauf seines Abos), erhält das Kauftoken Y und erhält ein Upgrade für sein Abo und Sie erhalten das Kauftoken Z. Wenn Sie diese API mit dem Kauftoken Z aufrufen, wird dieses Feld auf Y festgelegt. Wenn Sie diese API mit dem Kauftoken Y aufrufen, wird dieses Feld auf X festgelegt. 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 der Kauf nicht mithilfe des standardmäßigen In-App-Abrechnungsablaufs getätigt wurde. Mögliche Werte sind: 0 Test (d.h. Kauf über ein Lizenztestkonto) 1. Angebot (d.h. mit einem Gutscheincode gekauft)
priceChange

object (SubscriptionPriceChange)

Die neuesten verfügbaren Informationen zur Preisänderung. Dieser Wert ist nur vorhanden, wenn für das Abo eine Preisänderung ansteht, die noch nicht angewendet wird.

Sobald sich das Abo mit dem neuen Preis verlängert oder das Abo gekündigt wird, werden keine Informationen zur Preisänderung mehr angezeigt.
profileName

string

Der Profilname des Nutzers, als das Abo abgeschlossen wurde. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
emailAddress

string

Die E-Mail-Adresse des Nutzers, als das Abo abgeschlossen wurde. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
givenName

string

Der Name des Nutzers beim Abschluss des Abos. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
familyName

string

Der Familienname des Nutzers beim Abschluss des Abos. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
profileId

string

Die Google-Profil-ID des Nutzers, als das Abo abgeschlossen wurde. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
acknowledgementState

integer

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

string

Die Nutzerkonto-ID im Drittanbieterdienst. Nur vorhanden, wenn die Kontoverknüpfung im Rahmen des Abokaufs vorgenommen wurde.
promotionType

integer

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

string

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

string

Eine verschleierte Version der ID, die eindeutig mit dem Konto des Nutzers in Ihrer App verknüpft ist. Für folgende Käufe erforderlich: * Wenn die Kontoverknüpfung im Rahmen des Abokaufs vorgenommen wurde. * Die Angabe wurde mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid beim Kauf vorgenommen.
obfuscatedExternalProfileId

string

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

Einführungspreisinformationen

Enthält die Einführungspreise für ein Abo.

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

string

Der ISO 4217-Währungscode für den Einführungspreis. Wenn der Preis beispielsweise in britischen Pfund Sterling angegeben ist, ist priceCurrencyCode "GBP".
introductoryPriceAmountMicros

string (int64 format)

Einführungspreis für das Abo, zuzüglich Steuern. Die Währung entspricht der Währung „priceCurrencyCode“. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten eine Währungseinheit darstellen. Wenn der Preis des Abos beispielsweise 1, 99 € beträgt, beträgt er für PriceAmountMicros 1990000.
introductoryPricePeriod

string

Einführungspreis im Format nach ISO 8601. 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, in denen Einführungspreise angeboten werden sollen.

AboCancelSurveyResult

Informationen, die der Nutzer beim Abschließen des Abos angegeben hat (Umfrage zur Kündigung).

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

integer

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

string

Der Grund für die Abbruch der benutzerdefinierten Eingabe des Nutzers. Nur vorhanden, wenn „cancelReason“ „0“ ist.

Abopreisänderung

Enthält die Informationen zu Preisänderungen für ein Abo, mit denen die Nutzererfahrung in Bezug auf die Preisänderung in der App gesteuert werden kann. Hierbei kann es sich um eine Bestätigung durch den Nutzer oder um eine individuell angepasste Nutzererfahrung handeln, die zu einer erfolgreichen Conversion führt.

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

object (Price)

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

integer

Der aktuelle Status der Preisänderung. Mögliche Werte sind: 0 Ausstehend: Status einer ausstehenden Preisänderung, bei der der Nutzer zustimmt. In diesem Fall können Sie mithilfe der In-App API optional eine Bestätigung des Nutzers einholen. 1. Angenommen: Status für eine akzeptierte Preisänderung, bei der das Abo verlängert wird, wenn es nicht gekündigt wird. Die Preisänderung tritt in der Zukunft in Kraft, wenn das Abo verlängert wird. Beachten Sie, dass die Änderung möglicherweise nicht bei der nächsten Verlängerung des Abos vorgenommen wird.

Methoden

acknowledge

 Der Kauf eines Abonnements wird bestätigt.

cancel

 Kündigt das Abo eines Nutzers.

defer

 Der Abonnementkauf eines Nutzers wird bis zu einem bestimmten Zeitraum in der Zukunft verschoben.

get

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

refund

 Der Abokauf eines Nutzers wird erstattet, das Abo ist jedoch bis zum Ablauf der Gültigkeit gültig und wird verlängert.

revoke

 Der Kauf eines Nutzers wird erstattet und der Kauf wird sofort widerrufen.