Referenzleitfaden für Entwicklerbenachrichtigungen in Echtzeit

In diesem Dokument werden die Arten von Entwicklerbenachrichtigungen in Echtzeit aufgeführt und beschrieben, die du von Google Play erhalten kannst.

Codierung

Jede Veröffentlichung in einem Cloud Pub/Sub-Thema enthält ein einzelnes base64-codiertes Datenfeld.

{
  "message": {
    "attributes": {
      "key": "value"
    },
    "data": "eyAidmVyc2lvbiI6IHN0cmluZywgInBhY2thZ2VOYW1lIjogc3RyaW5nLCAiZXZlbnRUaW1lTWlsbGlzIjogbG9uZywgIm9uZVRpbWVQcm9kdWN0Tm90aWZpY2F0aW9uIjogT25lVGltZVByb2R1Y3ROb3RpZmljYXRpb24sICJzdWJzY3JpcHRpb25Ob3RpZmljYXRpb24iOiBTdWJzY3JpcHRpb25Ob3RpZmljYXRpb24sICJ0ZXN0Tm90aWZpY2F0aW9uIjogVGVzdE5vdGlmaWNhdGlvbiB9",
    "messageId": "136969346945"
  },
  "subscription": "projects/myproject/subscriptions/mysubscription"
}

Nachdem Sie das base64-codierte Datenfeld decodiert haben, enthält DeveloperNotification die folgenden Felder:

{
  "version": string,
  "packageName": string,
  "eventTimeMillis": long,
  "oneTimeProductNotification": OneTimeProductNotification,
  "subscriptionNotification": SubscriptionNotification,
  "voidedPurchaseNotification": VoidedPurchaseNotification,
  "pendingRefundReviewNotification": PendingRefundReviewNotification,
  "testNotification": TestNotification
}

Die einzelnen Felder werden in der folgenden Tabelle beschrieben.

Attributname Wert Beschreibung
Version String Die Version dieser Benachrichtigung. Anfänglich ist dies „1.0“. Diese Version unterscheidet sich von anderen Versionsfeldern.
packageName String Der Paketname der Anwendung, auf die sich diese Benachrichtigung bezieht (z. B. „com.some.thing“).
eventTimeMillis long Der Zeitstempel des Ereignisses in Millisekunden seit der Epoche.
subscriptionNotification SubscriptionNotification

Wenn dieses Feld vorhanden ist, bezieht sich diese Benachrichtigung auf ein Abo und dieses Feld enthält zusätzliche Informationen zum Abo.

Dieses Feld schließt sich gegenseitig mit pendingRefundReviewNotification, oneTimeProductNotification, voidedPurchaseNotification und testNotification aus.

oneTimeProductNotification OneTimeProductNotification

Wenn dieses Feld vorhanden ist, bezieht sich diese Benachrichtigung auf einen einmaligen Kauf. Das Feld enthält dann zusätzliche Informationen zum Kauf.

Dieses Feld schließt sich gegenseitig mit pendingRefundReviewNotification, subscriptionNotification, voidedPurchaseNotification und testNotification aus.

voidedPurchaseNotification VoidedPurchaseNotification

Wenn dieses Feld vorhanden ist, bezieht sich diese Benachrichtigung auf einen stornierten Kauf. Dieses Feld enthält dann zusätzliche Informationen zum stornierten Kauf.

Dieses Feld schließt sich gegenseitig mit „pendingRefundReviewNotification“, „oneTimeProductNotification“, „subscriptionNotification“ und „testNotification“ aus.

pendingRefundReviewNotification PendingRefundReviewNotification

Wenn dieses Feld vorhanden ist, bezieht sich diese Benachrichtigung auf eine Rückbuchungsanfrage, für die Sie eine Lösung vorschlagen können. Antworte auf diese Benachrichtigung, indem du die API „ReviewRefund“ aufrufst.

Dieses Feld schließt sich gegenseitig mit subscriptionNotification, oneTimeProductNotification, voidedPurchaseNotification und testNotification aus.

testNotification TestNotification

Wenn dieses Feld vorhanden ist, bezieht sich diese Benachrichtigung auf eine Testveröffentlichung. Diese werden nur über die Google Play Console gesendet.

Dieses Feld schließt sich gegenseitig mit pendingRefundReviewNotification, oneTimeProductNotification, subscriptionNotification und voidedPurchaseNotification aus.

SubscriptionNotification

Eine SubscriptionNotification enthält die folgenden Felder:

{
  "version": string,
  "notificationType": int,
  "purchaseToken": string
}
Attributname Wert Beschreibung
Version String Die Version dieser Benachrichtigung. Anfänglich ist dies „1.0“. Diese Version unterscheidet sich von anderen Versionsfeldern.
notificationType int Der notificationType für ein Abo kann die folgenden Werte haben:
  • (1) SUBSCRIPTION_RECOVERED: Ein Abo wurde aus der Kontosperre wiederhergestellt oder nach einer Pausierung fortgesetzt.
  • (2) SUBSCRIPTION_RENEWED: Ein aktives Abo wurde verlängert.
  • (3) SUBSCRIPTION_CANCELED: Ein Abo wurde entweder freiwillig oder unfreiwillig gekündigt. Bei freiwilliger Kündigung wird die Benachrichtigung gesendet, wenn der Nutzer kündigt.
  • (4) SUBSCRIPTION_PURCHASED – Ein neues Abo wurde abgeschlossen.
  • (5) SUBSCRIPTION_ON_HOLD: Ein Abo wurde gesperrt (falls aktiviert).
  • (6) SUBSCRIPTION_IN_GRACE_PERIOD – Ein Abo befindet sich im Kulanzzeitraum (falls aktiviert).
  • (7) SUBSCRIPTION_RESTARTED – Der Nutzer hat sein Abo unter Google Play > Konto > Abos wiederhergestellt. Das Abo wurde gekündigt, war aber noch nicht abgelaufen, als der Nutzer es wiederhergestellt hat. Weitere Informationen finden Sie unter Vor Ablauf wiederherstellen.
  • (8) SUBSCRIPTION_PRICE_CHANGE_CONFIRMED (VERWORFEN) – Eine Änderung des Abopreises wurde vom Nutzer bestätigt.
  • (9) SUBSCRIPTION_DEFERRED: Die Laufzeit eines Abos wurde verlängert.
  • (10) SUBSCRIPTION_PAUSED – Ein Abo wurde pausiert.
  • (11) SUBSCRIPTION_PAUSE_SCHEDULE_CHANGED – Ein Zeitplan für die Pausierung eines Abos wurde geändert.
  • (12) SUBSCRIPTION_REVOKED – Ein Abo wurde dem Nutzer vor dem Ablaufdatum entzogen.
  • (13) SUBSCRIPTION_EXPIRED – Ein Abo ist abgelaufen.
  • (17) SUBSCRIPTION_ITEMS_CHANGED – Ein Artikel in einem Abo-Bundle wurde geändert.
  • (18) SUBSCRIPTION_CANCELLATION_SCHEDULED – Die Kündigung eines Abos mit Ratenzahlung wurde geplant und wird am Ende der Mindestlaufzeit wirksam.
  • (19) SUBSCRIPTION_PRICE_CHANGE_UPDATED – Die Details zur Preisänderung eines Aboartikels wurden aktualisiert.
  • (20) SUBSCRIPTION_PENDING_PURCHASE_CANCELED – Eine ausstehende Transaktion eines Abos wurde abgebrochen.
  • (21) SUBSCRIPTION_PLAN_TRANSITION_UPDATED – Die geplante Abo-Umstellung wurde aktualisiert, z. B. wenn ein Nutzer ein Angebot zur Kundenbindung annimmt.
  • (22) SUBSCRIPTION_PRICE_STEP_UP_CONSENT_UPDATED – Der Einwilligungszeitraum für die Preiserhöhung eines Abos hat begonnen oder der Nutzer hat der Preiserhöhung zugestimmt. Diese RTDN wird nur für Abos in einer Region gesendet, in der eine Preiserhöhung erforderlich ist.
purchaseToken String Das Token, das dem Gerät des Nutzers beim Kauf des Abos bereitgestellt wurde.

Beispiel

Hier ist ein Beispiel für eine Benachrichtigung über einen neuen Abo-Kauf:

{
  "version":"1.0",
  "packageName":"com.some.thing",
  "eventTimeMillis":"1503349566168",
  "subscriptionNotification":
  {
    "version":"1.0",
    "notificationType":4,
    "purchaseToken":"PURCHASE_TOKEN"
  }
}

OneTimeProductNotification

Eine OneTimeProductNotification enthält die folgenden Felder:

{
  "version": string,
  "notificationType": int,
  "purchaseToken": string,
  "sku": string
}
Property-Name Wert Beschreibung
Version String Die Version dieser Benachrichtigung. Zu Beginn ist dies „1.0“. Diese Version unterscheidet sich von anderen Versionsfeldern.
notificationType int Die Art der Benachrichtigung. Kann die folgenden Werte haben:
  • (1) ONE_TIME_PRODUCT_PURCHASED: Ein Einmalkaufprodukt wurde von einem Nutzer gekauft.
  • (2) ONE_TIME_PRODUCT_CANCELED: Ein Einmalkaufprodukt wurde storniert oder widerrufen.
purchaseToken String Das Token, das dem Gerät des Nutzers beim Kauf bereitgestellt wurde.
SKU String Die Produkt-ID des gekauften Einmalkaufprodukts (z. B. „sword_001“)

Beispiel

Hier ein Beispiel für eine Benachrichtigung zu einem neuen einmaligen Kauf:

{
  "version":"1.0",
  "packageName":"com.some.thing",
  "eventTimeMillis":"1503349566168",
  "oneTimeProductNotification":
  {
    "version":"1.0",
    "notificationType":1,
    "purchaseToken":"PURCHASE_TOKEN",
    "sku":"my.sku"
  }
}

VoidedPurchaseNotification

Eine VoidedPurchaseNotification enthält die folgenden Felder:

Property-Name Wert Beschreibung

purchaseToken

string

Das Token, das mit dem stornierten Kauf verknüpft ist. Diese Informationen werden dem Entwickler zur Verfügung gestellt, wenn ein neuer Kauf erfolgt.

orderId

string

Die eindeutige Bestell-ID, die der stornierten Transaktion zugeordnet ist. Bei einmaligen Käufen ist dies die einzige Bestell-ID, die für den Kauf generiert wird. Bei Abos mit automatischer Verlängerung wird für jede Verlängerungstransaktion eine neue Bestell-ID generiert.

productType

int

productType für einen widerrufenen Kauf kann die folgenden Werte haben:

  • (1) PRODUCT_TYPE_SUBSCRIPTION – Ein Abo-Kauf wurde storniert.
  • (2) PRODUCT_TYPE_ONE_TIME – Ein einmaliger Kauf wurde storniert.

refundType

int

refundType für einen widerrufenen Kauf kann die folgenden Werte haben:

  • (1) REFUND_TYPE_FULL_REFUND: Der Kauf wurde vollständig storniert.
  • (2) REFUND_TYPE_QUANTITY_BASED_PARTIAL_REFUND: Der Kauf wurde durch eine mengenbasierte teilweise Erstattung teilweise storniert. Dies gilt nur für Käufe in variabler Stückzahl. Ein Kauf kann mehrmals teilweise storniert werden.

Wenn die verbleibende Gesamtmenge eines Kaufs mit mehreren Artikeln erstattet wird, ist der refundType REFUND_TYPE_FULL_REFUND.

Beispiel

Hier ein Beispiel für eine Benachrichtigung zu einem neuen widerrufenen Kauf:

{
  "version":"1.0",
  "packageName":"com.some.app",
  "eventTimeMillis":"1503349566168",
  "voidedPurchaseNotification":
  {
    "purchaseToken":"PURCHASE_TOKEN",
    "orderId":"GS.0000-0000-0000",
    "productType":1
    "refundType":1
  }
}

VoidedPurchaseNotification wird verarbeitet

Wenn Ihr RTDN-Client eine VoidedPurchaseNotification erhält, beachten Sie die folgenden Informationen:

  • packageName: Identifiziert die App.
  • eventTimeMillis: Gibt an, wann die Statusänderung erfolgt ist.
  • purchaseToken: Das Token, das beim Kauf des Produkts auf dem Gerät des Nutzers bereitgestellt wurde.
  • orderId: Gibt die Bestellung an, die mit der stornierten Transaktion verknüpft ist.
  • productType: Gibt an, ob es sich bei dem widerrufenen Kauf um einen In-App-Kauf oder ein Abo handelt.
  • refundType: Gibt die Art der Erstattung an, durch die der Kauf storniert wurde.

PendingRefundReviewNotification

Eine PendingRefundReviewNotification wird gesendet, wenn ein Nutzer eine Rückbuchung für einen Kauf beantragt und der Antrag vom Entwickler geprüft werden muss. Wenn du diese Benachrichtigung erhältst, solltest du die Anfrage prüfen und innerhalb von 24 Stunden einen Erstattungsvorschlag und einen Nachweis über die Nutzung des Kaufs einreichen. Rufe dazu die ReviewRefund API auf.

Eine PendingRefundReviewNotification enthält die folgenden Felder:

{
  "version": string,
  "pendingRefundToken": string,
  "orderId": string,
  "refundReason": int,
  "obfuscatedAccountId": string,
  "obfuscatedProfileId": string
}
Attributname Wert Beschreibung
Version String Die Version dieser Benachrichtigung. Anfänglich ist dies „1.0“. Diese Version unterscheidet sich von anderen Versionsfeldern.
pendingRefundToken String Ein eindeutiges Token, das den ausstehenden Erstattungsantrag identifiziert, der gerade geprüft wird. Übergeben Sie dieses Token, wenn Sie die ReviewRefund API aufrufen.
orderId String Die Bestell-ID des Kaufs, für den die Erstattung aussteht.
refundReason int Grund für den Erstattungsantrag Für ausstehende Überprüfungen wird nur CHARGEBACK (7) als Erstattungsgrund unterstützt. Ihr Code sollte neue Gründe verarbeiten, sobald sie verfügbar sind.
obfuscatedAccountId String (Falls zutreffend) Die verschleierte, vom Entwickler angegebene Nutzerkonto-ID, die beim Kauf angegeben wurde.
obfuscatedProfileId String (Falls zutreffend) Die verschleierte, vom Entwickler angegebene Profil-ID, die beim Kauf angegeben wurde.

Beispiel

Hier ist ein Beispiel für eine Benachrichtigung zu einer ausstehenden Erstattungsprüfung:

{
  "version":"1.0",
  "packageName":"com.some.thing",
  "eventTimeMillis":"1503350156918",
  "pendingRefundReviewNotification":
  {
    "version":"1.0",
    "pendingRefundToken":"example-token",
    "orderId":"GPA.1234-5678-9012-34567",
    "refundReason":7,
    "obfuscatedAccountId":"user-account-id",
    "obfuscatedProfileId":"user-profile-id"
  }
}

TestNotification

Eine TestNotification enthält die folgenden Felder:

{
  "version": string
}
Attributname Wert Beschreibung
Version String Die Version dieser Benachrichtigung. Anfänglich ist dies „1.0“. Diese Version unterscheidet sich von anderen Versionsfeldern.

Beispiel

Hier ein Beispiel für eine Testbenachrichtigung:

{
  "version":"1.0",
  "packageName":"com.some.thing",
  "eventTimeMillis":"1503350156918",
  "testNotification":
  {
    "version":"1.0"
  }
}