Method: purchases.voidedpurchases.list

Lista zakupów, które zostały anulowane, zwrócone lub objęte zwrotem środków.

Żądanie HTTP

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
packageName

string

Nazwa pakietu aplikacji, w której anulowane zakupy muszą zostać zwrócone (np. „com.cośtam.cośtam”).

Parametry zapytania

Parametry
pageSelection.maxResults

integer (uint32 format)

Określa, ile wyników powinna zwrócić operacja listy. Domyślna liczba zależy od zbioru zasobów.
pageSelection.startIndex

integer (uint32 format)

Określa indeks pierwszego elementu, który ma zostać zwrócony. Z tej opcji można korzystać tylko wtedy, gdy indeksowanie stron jest włączone.
pageSelection.token

string

Określa token strony do zwrócenia, zwykle pobierany z TokenPagination. Można jej używać tylko wtedy, gdy włączone jest przełączanie tokenów.
startTime

string (int64 format)

Czas w milisekundach od początku epoki najstarszego anulowanego zakupu, który ma być widoczny w odpowiedzi. Wartość tego parametru nie może być starsza niż 30 dni i jest ignorowana, jeśli ustawiony jest token strony. Wartość domyślna to bieżąca data pomniejszona o 30 dni. Uwaga: ten filtr jest stosowany w czasie, w którym rekord jest uznawany za unieważniony przez nasze systemy, a nie w czasie, w którym został zwrócony w odpowiedzi.
endTime

string (int64 format)

Czas w milisekundach od początku epoki najnowszego anulowanego zakupu, który chcesz zobaczyć w odpowiedzi. Wartość tego parametru nie może być większa niż bieżąca godzina i jest ignorowana, jeśli ustawiony jest token podziału na strony. Wartość domyślna to aktualna godzina. Uwaga: ten filtr jest stosowany w czasie, w którym rekord jest uznawany za unieważniony przez nasze systemy, a nie w czasie, w którym został zwrócony w odpowiedzi.
type

integer

Typ anulowanych zakupów, który ma być uwzględniony w odpowiedzi. Możliwe wartości: 0. W odpowiedzi zwrócone zostaną tylko anulowane zakupy produktów w aplikacji. Jest to wartość domyślna. 1. W odpowiedzi zwrócone zostaną zarówno unieważnione zakupy w aplikacji, jak i unieważnione zakupy subskrypcji.

Uwaga: zanim poprosisz o otrzymanie anulowanych zakupów subskrypcji, musisz w odpowiedzi użyć parametru orderId, który jednoznacznie identyfikuje zakupy jednorazowe i subskrypcje. W przeciwnym razie otrzymasz wiele zamówień subskrypcji z tym samym identyfikatorem PurchaseToken, ponieważ zamówienia na odnowienie subskrypcji mają ten sam identyfikator PurchaseToken.
includeQuantityBasedPartialRefund

boolean

Opcjonalnie. Określ, czy chcesz uwzględniać anulowane zakupy objęte częściowymi zwrotami środków na podstawie ilości, które mają zastosowanie tylko do zakupów z większą liczbą produktów. Jeśli ma wartość true (prawda), dodatkowe anulowane zakupy mogą zostać zwrócone z wartością voidedQuantity, która wskazuje ilość zwracanych środków w ramach częściowego zwrotu środków na podstawie ilości. Wartość domyślna to false (fałsz).

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź interfejsu API voidedpurchases.list.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
Pola
pageInfo

object (PageInfo)

Ogólne informacje o podziale na strony.
tokenPagination

object (TokenPagination)

Informacje o podziale na strony tokena.
voidedPurchases[]

object (VoidedPurchase)

Przykład

Oto przykładowa prośba:

curl -X GET \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.some.thing/purchases/voidedpurchases?endTime=1678886400000&includeQuantityBasedPartialRefund=true&maxResults=10&startIndex=0&startTime=1676208000000&token=SAMPLE_PAGINATION_TOKEN&type=1'

Oto przykładowa odpowiedź:

{
  "pageInfo": {
    "resultPerPage": 10,
    "startIndex": 0,
    "totalResults": 25
  },
  "tokenPagination": {
    "nextPageToken": "c3RhdGVfZm9yX3BhZ2VfMg==",
    "previousPageToken": null
  },
  "voidedPurchases": [
    {
      "kind": "androidpublisher#voidedPurchase",
      "orderId": "GPA.3315-1234-5678-90123",
      "purchaseTimeMillis": "1678886400000",
      "purchaseToken": "aebkhenchpfeidbefgkcjmfi.AO-J1OykGjJh9r_V7_v0kI6bA4v88e5c44f4e0c4b4a8e0e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z",
      "voidedQuantity": 1,
      "voidedReason": 1,
      "voidedSource": 0,
      "voidedTimeMillis": "1678972800000"
    },
    {
      "kind": "androidpublisher#voidedPurchase",
      "orderId": "GPA.3377-9876-5432-10987.0",
      "purchaseTimeMillis": "1678713600000",
      "purchaseToken": "fkgdjdmfgmcmflekdgmdncj.AO-J1OyU6sXvB9LqRt3jD2wZ_pE8gXyF5hT3mN1zK0aP7bV4qL9cO6iR2sD0kM7oU1bL8jI3sF5tY9vU4wO1eP2g",
      "voidedQuantity": 1,
      "voidedReason": 7,
      "voidedSource": 2,
      "voidedTimeMillis": "1678800000000"
    }
  ]
}

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/androidpublisher

PageSelection

Typ parametru żądania pageSelection, który określa, które i ile wyników ma zwrócić operacja voidedpurchases.list.

Zapis JSON 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
Pola
maxResults

integer (uint32 format)

Określa, ile wyników powinna zwrócić operacja listy. Domyślna liczba zależy od zbioru zasobów.
startIndex

integer (uint32 format)

Określa indeks pierwszego elementu, który ma zostać zwrócony. Z tej opcji można korzystać tylko wtedy, gdy indeksowanie stron jest włączone.
token

string

Określa token strony, która ma zostać zwrócona, zwykle pobierany z TokenPagination. Można jej używać tylko wtedy, gdy włączone jest przełączanie tokenów.