REST Resource: purchases.subscriptionsv2

Ressource: SubscriptionPurchaseV2

Gibt den Status des Abokaufs eines Nutzers an.

JSON-Darstellung 
{
  "kind": string,
  "regionCode": string,
  "latestOrderId": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}
Felder
kind

string

Diese Art stellt ein SubscriptionPurchaseV2-Objekt im androidpublisher-Dienst dar.
regionCode

string

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

string

Die Bestell-ID der letzten Bestellung für den Kauf des Abos. Bei einem Abo mit automatischer Verlängerung ist dies die Bestell-ID der Registrierungsbestellung, wenn sie noch nicht verlängert wurde, oder die letzte wiederkehrende Bestell-ID (erfolgreicher, ausstehender oder abgelehnter Auftrag). Bei einem Prepaid-Abo ist dies die Bestell-ID, die mit dem abgefragten Kauftoken verknüpft ist.
lineItems[]

object (SubscriptionPurchaseLineItem)

Informationen auf Artikelebene für ein Abo. Die Elemente im selben Kauf sollten entweder alle mit AutoRenewingPlan oder alle mit PrepaidPlan sein.
startTime

string (Timestamp format)

Zeitpunkt, zu dem das Abo gewährt wurde. Nicht für ausstehende Abos festgelegt (Abo wurde erstellt, aber bei der Registrierung wurde die Zahlung noch nicht abgeschlossen).

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
subscriptionState

enum (SubscriptionState)

Der aktuelle Status des Abos.
linkedPurchaseToken

string

Das Kauftoken des alten Abos, wenn es sich um eines der folgenden handelt: * Wiederregistrierung eines gekündigten, aber nicht abgelaufenen Abos * Upgrade/Downgrade von einem vorherigen Abo * Du kannst von Prepaid-Tarifen auf Abos mit automatischer Verlängerung umstellen. * Von einem Abo mit automatischer Verlängerung auf eine Vorauszahlung umstellen * Prepaid-Abo aufladen.
pausedStateContext

object (PausedStateContext)

Zusätzliche Informationen zu pausierten Abos. Nur vorhanden, wenn das Abo derzeit „subscriptionState“ SUBSCRIPTION_STATE_PAused umfasst.
canceledStateContext

object (CanceledStateContext)

Zusätzliche Informationen zu gekündigten Abos. Nur vorhanden, wenn das Abo derzeit „subscriptionState“ SUBSCRIPTION_STATE_CANCELED enthält.
testPurchase

object (TestPurchase)

Nur vorhanden, wenn es sich bei diesem Abo um einen Testkauf handelt.
acknowledgementState

enum (AcknowledgementState)

Der Bestätigungsstatus des Abos.
externalAccountIdentifiers

object (ExternalAccountIdentifiers)

Die Nutzerkonto-ID im Drittanbieterdienst.
subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Nutzerprofil, das mit Käufen über „Abonnieren mit Google“ verknüpft ist.

Abostatus

Mögliche Status, in denen sich ein Abo befindet, z. B. ob es aktiv oder gekündigt ist. Bei den Artikeln innerhalb eines Abokaufs kann es sich entweder um Abos mit automatischer Verlängerung oder um Prepaid-Tarife handeln.

Enums
SUBSCRIPTION_STATE_UNSPECIFIED Unbekannter Abostatus.
SUBSCRIPTION_STATE_PENDING Das Abo wurde erstellt, aber noch nicht bezahlt. In diesem Zustand steht die Zahlung für alle Artikel aus.
SUBSCRIPTION_STATE_ACTIVE Abonnement ist aktiv. (1) Wenn es sich bei dem Abo um ein Abo mit automatischer Verlängerung handelt, ist mindestens ein Artikel „autoRenewEnabled“ und nicht abgelaufen. - (2) Wenn es sich bei dem Abo um einen Prepaid-Tarif handelt, ist mindestens ein Artikel nicht abgelaufen.
SUBSCRIPTION_STATE_PAUSED Abo ist pausiert. Der Status ist nur verfügbar, wenn es sich um ein Abo mit automatischer Verlängerung handelt. In diesem Status sind alle Elemente pausiert.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD Für das Abo gilt ein Kulanzzeitraum. Der Status ist nur verfügbar, wenn es sich um ein Abo mit automatischer Verlängerung handelt. In diesem Zustand befinden sich alle Artikel im Kulanzzeitraum.
SUBSCRIPTION_STATE_ON_HOLD Abo wurde ausgesetzt. Der Status ist nur verfügbar, wenn es sich um ein Abo mit automatischer Verlängerung handelt. In diesem Status sind alle Elemente auf „Hold“ gesetzt.
SUBSCRIPTION_STATE_CANCELED Das Abo wurde gekündigt, ist aber noch nicht abgelaufen. Der Status ist nur verfügbar, wenn es sich um ein Abo mit automatischer Verlängerung handelt. Für alle Elemente ist „autoRenewEnabled“ auf „false“ gesetzt.
SUBSCRIPTION_STATE_EXPIRED Abo ist abgelaufen. Alle Artikel haben ein Ablaufdatum in der Vergangenheit.

Pausierter Zustandskontext

Informationen zu einem Abo mit pausiertem Status.

JSON-Darstellung 
{
  "autoResumeTime": string
}
Felder
autoResumeTime

string (Timestamp format)

Zeit, zu der das Abo automatisch fortgesetzt wird.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

StorniertStateContext

Informationen zu einem Abo im gekündigten Status.

JSON-Darstellung 
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
Felder
Union-Feld cancellation_reason. Der Grund für die Kündigung eines Abos. Für cancellation_reason ist nur einer der folgenden Werte zulässig:
userInitiatedCancellation

object (UserInitiatedCancellation)

Das Abo wurde vom Nutzer gekündigt.
systemInitiatedCancellation

object (SystemInitiatedCancellation)

Das Abo wurde vom System gekündigt, z. B. aufgrund eines Abrechnungsproblems.
developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

Das Abo wurde vom Entwickler gekündigt.
replacementCancellation

object (ReplacementCancellation)

Das Abo wurde durch ein neues Abo ersetzt.

Vom Nutzer initiierte Stornierung

Spezifische Informationen zu Kündigungen, die von Nutzern initiiert wurden.

JSON-Darstellung 
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Felder
cancelSurveyResult

object (CancelSurveyResult)

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

string (Timestamp format)

Der Zeitpunkt, zu dem das Abo vom Nutzer gekündigt wurde. Der Nutzer hat möglicherweise nach wie vor weiterhin Zugriff auf das Abo. Mit „itemItems.expiration_time“ können Sie feststellen, ob ein Nutzer noch Zugriff hat.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

SurveySurveyResult

Ergebnis der Kündigungsumfrage, wenn das Abo vom Nutzer gekündigt wurde.

JSON-Darstellung 
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Felder
reason

enum (CancelSurveyReason)

Der Grund, den der Nutzer für die Kündigungsumfrage ausgewählt hat.
reasonUserInput

string

Nur festgelegt für CANCEL_SURVEY_REASON_OTHERS. Dies ist die Freiform-Antwort des Nutzers auf die Umfrage.

Kündigungsgrund für Umfrage

Der Grund, den der Nutzer für die Kündigungsumfrage ausgewählt hat.

Enums
CANCEL_SURVEY_REASON_UNSPECIFIED Unbekannter Grund für die Kündigung der Umfrage.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE Abo wird nicht ausreichend genutzt.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Technische Probleme bei der Verwendung der App
CANCEL_SURVEY_REASON_FOUND_BETTER_APP Der Nutzer hat eine bessere App gefunden.
CANCEL_SURVEY_REASON_OTHERS Andere Gründe.

Vom System veranlasste Stornierung

Spezifische Informationen zu Stornierungen, die vom Google-System initiiert wurden.

Vom Entwickler veranlasste Stornierung

Informationen zu Stornierungen, die von Entwicklern initiiert wurden.

Stornierung storniert

Spezifische Informationen zu Kündigungen, die durch ein Aboersatz verursacht wurden.

TestKauf

Gibt an, ob es sich bei diesem Abokauf um einen Testkauf handelt.

Bestätigungsstatus

Die möglichen Bestätigungsstatus für ein Abo.

Enums
ACKNOWLEDGEMENT_STATE_UNSPECIFIED Unbekannter Bestätigungsstatus.
ACKNOWLEDGEMENT_STATE_PENDING Das Abo wurde noch nicht bestätigt.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED Das Abo wurde bestätigt.

Externe Kontokennungen

Die Nutzerkonto-ID im Drittanbieterdienst.

JSON-Darstellung 
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Felder
externalAccountId

string

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

string

Eine verschleierte Version der ID, die mit dem Konto des Nutzers in Ihrer App eindeutig verknüpft ist. Für folgende Käufe präsentieren: * Wenn die Kontoverknüpfung beim Abokauf erfolgt ist. * 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 wurde.

Abonnieren mitGoogleInfo

Informationen zu Käufen über „Abonnieren mit Google“

JSON-Darstellung 
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Felder
profileId

string

Die Google-Profil-ID des Nutzers, als das Abo abgeschlossen wurde.
profileName

string

Der Profilname des Nutzers, als das Abo abgeschlossen wurde.
emailAddress

string

Die E-Mail-Adresse des Nutzers, als das Abo abgeschlossen wurde.
givenName

string

Der Name des Nutzers beim Abschluss des Abos.
familyName

string

Der Familienname des Nutzers beim Abschluss des Abos.

SubscriptionPurchaseLineItem

Informationen auf Artikelebene für ein Abo.

JSON-Darstellung 
{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
  "offerDetails": {
    object (OfferDetails)
  }
}
Felder
productId

string

Die gekaufte Produkt-ID, z. B. „monatlich001“.
expiryTime

string (Timestamp format)

Zeitpunkt, zu dem das Abo abgelaufen ist oder abläuft, es sei denn, der Zugriff wird verlängert (z. B. Verlängerung).

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
Union-Feld plan_type. Der Abotyp. Für plan_type ist nur einer der folgenden Werte zulässig:
autoRenewingPlan

object (AutoRenewingPlan)

Der Artikel wird automatisch verlängert.
prepaidPlan

object (PrepaidPlan)

Der Artikel ist im Voraus bezahlt.
offerDetails

object (OfferDetails)

Die Angebotsdetails für diesen Artikel.

Automatische Verlängerung

Informationen zu einem Plan, der sich automatisch verlängert.

JSON-Darstellung 
{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  }
}
Felder
autoRenewEnabled

boolean

Wenn das Abo derzeit automatisch verlängert wird, z.B. wenn der Nutzer das Abo nicht gekündigt hat
priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

Informationen zur letzten Preisänderung des Artikels seit der Registrierung des Abos.

AboItemPriceChangeDetails

Informationen zu Preisänderungen eines Aboartikels.

JSON-Darstellung 
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
Felder
newPrice

object (Money)

Neuer wiederkehrender Preis für den Aboartikel.
priceChangeMode

enum (PriceChangeMode)

Der Modus „Preisänderung“ gibt an, wie sich der Preis des Aboartikels ändert.
priceChangeState

enum (PriceChangeState)

Geben Sie die aktuelle Preisänderung an.
expectedNewPriceChargeTime

string (Timestamp format)

Der Zeitpunkt der Verlängerung, ab dem die Preisänderung für den Nutzer wirksam wird. Dies kann sich in Fällen ändern, bei denen sich die Verlängerungszeit wie die Pause ändert.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Preisänderungsmodus

Der Modus der Preisänderung.

Enums
PRICE_CHANGE_MODE_UNSPECIFIED Modus für Preisänderung nicht angegeben. Dieser Wert sollte nie festgelegt werden.
PRICE_DECREASE Wenn der Abopreis sinkt.
PRICE_INCREASE Wenn der Abopreis erhöht wird und der Nutzer ihn akzeptieren muss.

PreisänderungStatus

Der Status der Preisänderung.

Enums
PRICE_CHANGE_STATE_UNSPECIFIED Status der Preisänderung nicht angegeben. Dieser Wert sollte nicht verwendet werden.
OUTSTANDING Der Nutzer wartet auf die Preisänderung.
CONFIRMED Die Preisänderung wurde für den Nutzer bestätigt.
APPLIED Die Preisänderung wird angewendet, d.h., dem Nutzer wird der neue Preis berechnet.

Prepaid-Tarif

Informationen zu einem Prepaid-Tarif

JSON-Darstellung 
{
  "allowExtendAfterTime": string
}
Felder
allowExtendAfterTime

string (Timestamp format)

Falls vorhanden, ist dies der Zeitraum, nach dem Aufladungen für den Prepaid-Tarif erfolgen können. Für abgelaufene Prepaid-Tarife nicht vorhanden.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Angebotsdetails

Angebotsdetails zu einer Kaufposition angeben

JSON-Darstellung 
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
Felder
offerTags[]

string

Die neuesten Angebots-Tags, die mit dem Angebot verknüpft sind. Es enthält Tags, die vom Basis-Abo übernommen wurden.
basePlanId

string

Die ID des Basis-Abos. Für alle Basis-Abos und Angebote vorhanden.
offerId

string

Die Angebots-ID. Nur für ermäßigte Angebote vorhanden.

Methoden

get

 Metadaten zu einem Abo abrufen