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 日を引いた値です。注: このフィルタは、Google のシステムによってレコードが取り消されたと認識された時点に適用されます。応答で返された実際の取り消し時点ではありません。

endTime

string (int64 format)

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

type

integer

応答に表示する取り消し済みの購入の種類。有効な値は 0 です。取り消し済みのアプリ内アイテムの購入のみがレスポンスで返されます。これがデフォルト値です。 1. 取り消し済みのアプリ内購入と取り消し済みの定期購入は、どちらもレスポンスで返されます。

注: 取り消し済みの定期購入の受け取りをリクエストする前に、レスポンスで orderId を使用することに切り替えて、1 回限りの購入と定期購入を一意に識別する必要があります。更新しないと、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)

承認スコープ

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

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

PageSelection

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

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

integer (uint32 format)

一覧表示オペレーションで返す結果の数を定義します。デフォルトの数は、リソース コレクションによって異なります。

startIndex

integer (uint32 format)

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

token

string

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