Method: purchases.voidedpurchases.list

キャンセル、払い戻し、またはチャージバックされた購入のリストを作成します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
packageName

string

無効になった購入を返す必要のあるアプリのパッケージ名（例: 「com.some.thing」）。

クエリ パラメータ

パラメータ
pageSelection.maxResults

integer (uint32 format)

リスト オペレーションが返す結果の件数を定義します。デフォルトの件数はリソース コレクションに基づきます。
pageSelection.startIndex

integer (uint32 format)

返す最初の要素のインデックスを定義します。インデックスを使用したページングが有効な場合にのみ使用できます。
pageSelection.token

string

返すページのトークンを定義します。通常 TokenPagination から取得されます。トークンを使用したページングが有効な場合にのみ使用できます。
startTime

string (int64 format)

応答に含める最も古い取り消し済み購入の時刻（エポックからのミリ秒単位の経過時間）。このパラメータは 30 日より古い値にはできません。また、ページング トークンが設定されている場合は無視されます。デフォルトの値は、現在の時刻から 30 日を差し引いた値です。注: このフィルタは、レコードが取り消されたとシステムがみなした時刻（応答で返された実際の取り消し時刻ではない）に適用されます。
endTime

string (int64 format)

応答に含める最も新しい取り消し済み購入の時刻（エポックからのミリ秒単位の経過時間）。このパラメータは現在の時刻より大きな値にはできません。また、ページング トークンが設定されている場合は無視されます。デフォルトの値は現在の時刻です。注: このフィルタは、レコードが取り消されたとシステムがみなした時刻（応答で返された実際の取り消し時刻ではない）に適用されます。
type

integer

応答に含める取り消し済み購入のタイプ。値は次のいずれかです。0. 取り消し済みアプリ内アイテムの購入のみが応答で返されます。これはデフォルト値です。1. 取り消し済みアプリ内購入と取り消し済み定期購入の両方が応答で返されます。

注: 取り消し済み定期購入を返すようリクエストするには、応答で orderId を使用するように切り替えて、1 回限りの購入と定期購入を一意に識別する必要があります。orderId を使用するように切り替えないと、定期購入更新注文は PurchaseToken が同じであるため、PurchaseToken が同じ定期購入の注文が複数返されます。
includeQuantityBasedPartialRefund

boolean

省略可。数量ベースの一部払い戻しの取り消し済みの購入を含めるかどうか。複数量の購入にのみ適用されます。true の場合、数量ベースの一部払い戻しの払い戻し量を示す voidedQuantity とあわせて、追加の取り消し済み購入が返されることがあります。デフォルト値は false です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

voidedpurchases.list API のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
フィールド
pageInfo

object (PageInfo)

ページングに関する一般情報。
tokenPagination

object (TokenPagination)

トークンを使用したページングの情報。
voidedPurchases[]

object (VoidedPurchase)

サンプル

リクエストの例を次に示します。

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'

レスポンスの例を次に示します。

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

認可スコープ

次の OAuth スコープが必要です。

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

PageSelection

pageSelection リクエスト パラメータのタイプ。voidedpurchases.list オペレーションが返す結果とその件数を定義します。

JSON 表現 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
フィールド
maxResults

integer (uint32 format)

リスト オペレーションが返す結果の件数を定義します。デフォルトの件数はリソース コレクションに基づきます。
startIndex

integer (uint32 format)

返す最初の要素のインデックスを定義します。インデックスを使用したページングが有効な場合にのみ使用できます。
token

string

返すページのトークンを定義します。通常 TokenPagination から取得されます。トークンを使用したページングが有効な場合にのみ使用できます。