REST Resource: purchases.subscriptions

Ressource: SubscriptionPurchase

Eine Ressource vom Typ „SubscriptionPurchase“ 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, zu dem das Abo abläuft, in Millisekunden seit der Epoche.
autoResumeTimeMillis

string (int64 format)

Zeitpunkt, zu dem das Abo automatisch fortgesetzt wird, in Millisekunden seit der Epoche. Wird nur angezeigt, wenn der Nutzer die Pausierung des Abos angefordert hat.
autoRenewing

boolean

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

string

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

string (int64 format)

Preis des Abos. Bei Ländern ohne Steuern enthält der Preis keine Steuern. In Ländern, in denen die Mehrwertsteuer enthalten ist, ist der Preis inklusive Steuern. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten einer Währungseinheit entsprechen. Beträgt der Abopreis beispielsweise 1, 99 €, beträgt priceAmountMicros 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

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

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

string

ISO 3166-1 Alpha-2-Code für das Land/die Region der Rechnungsadresse des Nutzers zum Zeitpunkt der Abovergabe.
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. Kostenlose Testversion 3. Ausstehendes verzögertes Upgrade/Downgrade

Nicht vorhanden für gekündigte, abgelaufene Abos.
cancelReason

integer

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

string (int64 format)

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

object (SubscriptionCancelSurveyResult)

Informationen, die der Nutzer beim Abschließen der Kündigung des Abos bereitstellt (Umfrage zum Kündigungsgrund).
orderId

string

Die Bestell-ID des letzten Dauerauftrags, der mit dem Kauf des Abos verknüpft ist. Wenn das Abo gekündigt wurde, weil die Zahlung abgelehnt 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. Erneute Anmeldung eines gekündigten, aber nicht abgelaufenen Abos 1. Upgrade/Downgrade von einem früheren Abo

Angenommen, ein Nutzer meldet sich ursprünglich an und Sie erhalten das Kauftoken X. Der Nutzer kündigt den Vorgang ab und durchläuft den Ablauf der Neuregistrierung (vor Ablauf des Abos). Sie erhalten das Kauftoken Y. Schließlich aktualisiert der Nutzer sein Abo und Sie erhalten das Kauftoken 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 Abonnementkaufs. Dieses Feld wird nur festgelegt, wenn dieser Kauf nicht über den standardmäßigen In-App-Abrechnungsablauf getätigt wurde. Mögliche Werte sind: 0. Test (über ein Lizenztestkonto erworben) 1. Angebot (d.h. mit einem Gutscheincode gekauft)
priceChange

object (SubscriptionPriceChange)

Die neuesten verfügbaren Informationen zu Preisänderungen. Dies ist nur vorhanden, wenn eine anstehende Preisänderung für das Abo ansteht, die noch angewendet werden soll.

Sobald das Abo mit dem neuen Preis verlängert oder 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 mit „Abonnieren mit Google“ vorhanden.
emailAddress

string

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

string

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

string

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

string

Die Google-Profil-ID des Nutzers beim Kauf des Abos. Nur für Käufe mit „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 erfolgt ist.
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. Einmalcode 1. Vanity-Code
promotionCode

string

Der Gutscheincode, der auf diesen Kauf angewendet wurde. Dieses Feld wird nur festgelegt, wenn beim Kauf des Abos ein 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 folgende Käufe vorhanden: * Wenn die Kontoverknüpfung im Rahmen des Abokaufs erfolgt ist. * Sie wurde mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid beim Kauf angegeben.
obfuscatedExternalProfileId

string

Eine verschleierte Version der ID, die dem Profil des Nutzers in Ihrer App eindeutig zugeordnet ist. Wird nur angezeigt, wenn dies beim Kauf mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid angegeben wurde.

IntroductoryPriceInfo

Enthält die 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. Wenn der Preis beispielsweise in britischen Pfund Sterling angegeben ist, lautet der Wert für priceCurrencyCode "GBP".
introductoryPriceAmountMicros

string (int64 format)

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

string

Zeitraum für den Einführungspreis im Format 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, für die der Einführungspreis angeboten werden soll.

SubscriptionCancelSurveyResult

Informationen, die der Nutzer beim Abschließen der Kündigung des Abos bereitstellt (Umfrage zum Kündigungsgrund).

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

integer

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

string

Der vom Nutzer festgelegte Grund für das Abbrechen der benutzerdefinierten Eingabe. Nur vorhanden, wenn „cancelReason“ 0 ist.

SubscriptionPriceChange

Enthält die Informationen zur Preisänderung für ein Abo, mit denen Sie den Kaufprozess in Bezug auf die Preisänderung in der App steuern können. Dies kann in Form der Bestätigung durch den Nutzer 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, mit dem das Abo verlängert wird, wenn der Nutzer der Preisänderung zustimmt.
state

integer

Der aktuelle Status der Preisänderung. Mögliche Werte sind: 0. Ausstehend: Hinweis auf eine ausstehende Preisänderung, die auf ihre Zustimmung durch den Nutzer wartet. In diesem Status können Sie mithilfe der In-App API optional eine Bestätigung vom Nutzer anfordern. 1. Akzeptiert: Status einer akzeptierten Preisänderung, mit der das Abo verlängert wird, sofern es nicht gekündigt wird. Die Preisänderung tritt an einem Tag in der Zukunft in Kraft, an dem das Abo verlängert wird. Hinweis: Die Änderung wird bei der nächsten Verlängerung des Abos möglicherweise nicht übernommen.

Methoden

acknowledge

 Damit wird ein Abokauf bestätigt.

cancel

 Storniert den Abokauf eines Nutzers.

defer

 Verschiebt den Abokauf eines Nutzers bis zu einer bestimmten in der Zukunft angegebenen Ablaufzeit.

get

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

refund

 Erstattet den Abonnementkauf des Nutzers, aber das Abonnement bleibt bis zum Ablauf gültig und wird weiter verlängert.

revoke

 Erstattet und widerruft den Abonnementkauf eines Nutzers sofort.