Przewodnik po powiadomieniach w czasie rzeczywistym dla deweloperów

W tym dokumencie znajdziesz listę i opis typów powiadomień w czasie rzeczywistym dla deweloperów, które możesz otrzymywać z Google Play.

Kodowanie

Każda publikacja w temacie Cloud Pub/Sub zawiera jedno pole danych zakodowane w formacie base64.

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

Po zdekodowaniu pola danych zakodowanego w formacie base64 DeveloperNotification zawiera te pola:

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

Pola są opisane w tej tabeli.

Nazwa właściwości Wartość Opis
wersja tekst Wersja tego powiadomienia. Początkowo jest to „1.0”. Ta wersja różni się od innych pól wersji.
packageName tekst Nazwa pakietu aplikacji, której dotyczy to powiadomienie (np. `com.some.thing`).
eventTimeMillis długi Sygnatura czasowa wystąpienia zdarzenia w milisekundach od początku epoki.
subscriptionNotification SubscriptionNotification

Jeśli to pole jest obecne, powiadomienie jest powiązane z subskrypcją, a pole zawiera dodatkowe informacje na jej temat.

Pamiętaj, że to pole wyklucza się wzajemnie z polami pendingRefundReviewNotification, oneTimeProductNotification, voidedPurchaseNotification i testNotification.

oneTimeProductNotification OneTimeProductNotification

Jeśli to pole jest obecne, powiadomienie dotyczy jednorazowego zakupu, a pole zawiera dodatkowe informacje o zakupie.

Pamiętaj, że to pole wyklucza się wzajemnie z polami pendingRefundReviewNotification, subscriptionNotification, voidedPurchaseNotification i testNotification.

voidedPurchaseNotification VoidedPurchaseNotification

Jeśli to pole jest obecne, powiadomienie dotyczy unieważnionego zakupu, a to pole zawiera dodatkowe informacje na jego temat.

Pamiętaj, że to pole wyklucza się wzajemnie z polami pendingRefundReviewNotification, oneTimeProductNotification, subscriptionNotification i testNotification.

pendingRefundReviewNotification PendingRefundReviewNotification

Jeśli to pole jest obecne, powiadomienie dotyczy prośby o obciążenie zwrotne, w przypadku której możesz zaproponować rozwiązanie. Odpowiedz na to powiadomienie, wywołując interfejs API `ReviewRefund`.

Pamiętaj, że to pole wyklucza się wzajemnie z polami subscriptionNotification, oneTimeProductNotification, voidedPurchaseNotification i testNotification.

testNotification TestNotification

Jeśli to pole jest obecne, powiadomienie jest związane z publikacją testową. Są one wysyłane tylko przez Konsolę Google Play.

Pamiętaj, że to pole wyklucza się wzajemnie z polami pendingRefundReviewNotification, oneTimeProductNotification, subscriptionNotification i voidedPurchaseNotification.

SubscriptionNotification

SubscriptionNotification zawiera te pola:

{
  "version": string,
  "notificationType": int,
  "purchaseToken": string
}
Nazwa właściwości Wartość Opis
wersja tekst Wersja tego powiadomienia. Początkowo jest to „1.0”. Ta wersja różni się od innych pól wersji.
notificationType int Parametr notificationType subskrypcji może mieć te wartości:
  • (1) SUBSCRIPTION_RECOVERED – subskrypcja została przywrócona po zawieszeniu konta lub wznowiona po wstrzymaniu.
  • (2) SUBSCRIPTION_RENEWED – aktywna subskrypcja została odnowiona.
  • (3) SUBSCRIPTION_CANCELED – subskrypcja została anulowana dobrowolnie lub niedobrowolnie. W przypadku anulowania dobrowolnego – wysyłane, gdy użytkownik anuluje subskrypcję.
  • (4) SUBSCRIPTION_PURCHASED – zakupiono nową subskrypcję.
  • (5) SUBSCRIPTION_ON_HOLD – subskrypcja została wstrzymana (jeśli ta opcja jest włączona).
  • (6) SUBSCRIPTION_IN_GRACE_PERIOD – subskrypcja weszła w okres prolongaty (jeśli jest włączony).
  • (7) SUBSCRIPTION_RESTARTED – użytkownik przywrócił subskrypcję w sekcji Google Play > Konto > Subskrypcje. Subskrypcja została anulowana, ale nie wygasła, gdy użytkownik ją przywrócił. Więcej informacji znajdziesz w sekcji Przywracanie przed wygaśnięciem.
  • (8) SUBSCRIPTION_PRICE_CHANGE_CONFIRMED (WYCOFANE) – użytkownik potwierdził zmianę ceny subskrypcji.
  • (9) SUBSCRIPTION_DEFERRED – czas cyklu subskrypcji został wydłużony.
  • (10) SUBSCRIPTION_PAUSED – subskrypcja została wstrzymana.
  • (11) SUBSCRIPTION_PAUSE_SCHEDULE_CHANGED – harmonogram wstrzymania subskrypcji został zmieniony.
  • (12) SUBSCRIPTION_REVOKED – subskrypcja została odebrana użytkownikowi przed upływem daty ważności.
  • (13) SUBSCRIPTION_EXPIRED – subskrypcja wygasła.
  • (17) SUBSCRIPTION_ITEMS_CHANGED – element w pakiecie subskrypcji został zmieniony.
  • (18) SUBSCRIPTION_CANCELLATION_SCHEDULED – zaplanowano anulowanie subskrypcji ratalnej, które wejdzie w życie z końcem okresu zobowiązania.
  • (19) SUBSCRIPTION_PRICE_CHANGE_UPDATED – szczegóły zmiany ceny produktu w subskrypcji zostały zaktualizowane.
  • (20) SUBSCRIPTION_PENDING_PURCHASE_CANCELED – oczekująca transakcja subskrypcji została anulowana.
  • (21) SUBSCRIPTION_PLAN_TRANSITION_UPDATED – zaplanowane przejście na inny abonament zostało zaktualizowane (np. gdy użytkownik zaakceptuje ofertę utrzymania).
  • (22) SUBSCRIPTION_PRICE_STEP_UP_CONSENT_UPDATED – rozpoczął się okres zgody na podwyżkę ceny subskrypcji lub użytkownik wyraził zgodę na podwyżkę ceny. To powiadomienie RTDN jest wysyłane tylko w przypadku subskrypcji w regionie, w którym wymagane jest podniesienie ceny.
purchaseToken tekst Token dostarczony na urządzenie użytkownika podczas zakupu subskrypcji.

Przykład

Oto przykład powiadomienia o zakupie nowej subskrypcji:

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

OneTimeProductNotification

OneTimeProductNotification zawiera te pola:

{
  "version": string,
  "notificationType": int,
  "purchaseToken": string,
  "sku": string
}
Nazwa właściwości Wartość Opis
wersja tekst Wersja tego powiadomienia. Początkowo będzie to „1.0”. Ta wersja różni się od innych pól wersji.
notificationType int Typ powiadomienia. Może mieć te wartości:
  • (1) ONE_TIME_PRODUCT_PURCHASED – użytkownik kupił produkt kupowany raz.
  • (2) ONE_TIME_PRODUCT_CANCELED – zakup produktu kupowanego raz został anulowany lub unieważniony.
purchaseToken tekst Token dostarczony na urządzenie użytkownika podczas dokonywania zakupu.
sku tekst Identyfikator zakupionego produktu kupowanego raz (np. „sword_001”).

Przykład

Oto przykład powiadomienia o nowym jednorazowym zakupie:

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

VoidedPurchaseNotification

VoidedPurchaseNotification zawiera te pola:

Nazwa właściwości Wartość Opis

purchaseToken

string

Token powiązany z zakupem, który został unieważniony. Te informacje są przekazywane deweloperowi, gdy następuje nowy zakup.

orderId

string

Unikalny identyfikator zamówienia powiązany z transakcją, która została unieważniona. W przypadku zakupów jednorazowych jest to jedyny identyfikator zamówienia wygenerowany na potrzeby zakupu. W przypadku subskrypcji odnawianych automatycznie dla każdej transakcji odnowienia generowany jest nowy identyfikator zamówienia.

productType

int

Wartość productType w przypadku unieważnionego zakupu może być jedną z tych:

  • (1) PRODUCT_TYPE_SUBSCRIPTION – zakup subskrypcji został unieważniony.
  • (2) PRODUCT_TYPE_ONE_TIME – jednorazowy zakup został unieważniony.

refundType

int

Wartość refundType w przypadku unieważnionego zakupu może być jedną z tych:

  • (1) REFUND_TYPE_FULL_REFUND – zakup został całkowicie unieważniony.
  • (2) REFUND_TYPE_QUANTITY_BASED_PARTIAL_REFUND – zakup został częściowo unieważniony przez częściowy zwrot środków za określoną liczbę produktów. Dotyczy to tylko zakupów obejmujących wiele produktów. Zakup można częściowo unieważnić kilka razy.

Pamiętaj, że gdy zostanie zwrócona pozostała łączna kwota za zakup wielu produktów, refundType będzie REFUND_TYPE_FULL_REFUND.

Przykład

Oto przykład powiadomienia o nowym unieważnionym zakupie:

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

Wykorzystywanie VoidedPurchaseNotification

Gdy klient RTDN otrzyma powiadomienie VoidedPurchaseNotification, zwróć uwagę na te informacje:

  • packageName: identyfikuje aplikację.
  • eventTimeMillis: informuje o godzinie zmiany stanu.
  • purchaseToken: token dostarczony na urządzenie użytkownika podczas zakupu produktu.
  • orderId: identyfikuje zamówienie powiązane z unieważnioną transakcją.
  • productType: wskazuje, czy unieważniony zakup był zakupem w aplikacji czy subskrypcją.
  • refundType: określa typ zwrotu środków, który spowodował unieważnienie zakupu.

PendingRefundReviewNotification

Powiadomienie PendingRefundReviewNotification jest wysyłane, gdy użytkownik prosi o obciążenie zwrotne za zakup, a prośba wymaga sprawdzenia przez dewelopera. Gdy otrzymasz takie powiadomienie, musisz ocenić prośbę i w ciągu 24 godzin przesłać sugestię dotyczącą zwrotu środków oraz dowód korzystania z zakupu, wywołując interfejs API ReviewRefund.

PendingRefundReviewNotification zawiera te pola:

{
  "version": string,
  "pendingRefundToken": string,
  "orderId": string,
  "refundReason": int,
  "obfuscatedAccountId": string,
  "obfuscatedProfileId": string
}
Nazwa właściwości Wartość Opis
wersja tekst Wersja tego powiadomienia. Początkowo jest to „1.0”. Ta wersja różni się od innych pól wersji.
pendingRefundToken tekst Unikalny token, który identyfikuje oczekującą prośbę o zwrot środków w trakcie sprawdzania. Przekaż ten token podczas wywoływania interfejsu ReviewRefund API.
orderId tekst Identyfikator zamówienia, którego dotyczy oczekująca prośba o zwrot środków.
refundReason int przyczyna prośby o zwrot środków. W przypadku opinii oczekujących na sprawdzenie jako powód zwrotu środków można podać tylko CHARGEBACK (7). Kod powinien obsługiwać nowe przyczyny, gdy tylko staną się dostępne.
obfuscatedAccountId tekst (Jeśli dotyczy) Ukryty identyfikator konta użytkownika określony przez dewelopera, który został podany podczas zakupu.
obfuscatedProfileId tekst (Jeśli dotyczy) Ukryty identyfikator profilu określony przez dewelopera, który został podany podczas zakupu.

Przykład

Oto przykład powiadomienia o oczekującej prośbie o zwrot środków:

{
  "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

TestNotification zawiera te pola:

{
  "version": string
}
Nazwa właściwości Wartość Opis
wersja tekst Wersja tego powiadomienia. Początkowo jest to „1.0”. Ta wersja różni się od innych pól wersji.

Przykład

Oto przykład powiadomienia testowego:

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