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. 応答では、取り消し済みのアプリ内購入と取り消し済みの定期購入の両方が返されます。

注: 取り消し済みの定期購入を受け取るようリクエストする前に、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)

認可スコープ

次の 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 から取得されます。トークンのページングが有効になっている場合にのみ使用できます。