Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / androidpublisher_v3.purchases.voidedpurchases.html
blob: 60a0299ed92712fcde51f3f48916d8315caab7ec [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androidpublisher_v3.html">Google Play Developer API</a> . <a href="androidpublisher_v3.purchases.html">purchases</a> . <a href="androidpublisher_v3.purchases.voidedpurchases.html">voidedpurchases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#list">list(packageName, startTime=None, token=None, maxResults=None, startIndex=None, endTime=None, type=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Lists the purchases that were canceled, refunded or charged-back.</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]82 <code class="details" id="list">list(packageName, startTime=None, token=None, maxResults=None, startIndex=None, endTime=None, type=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <pre>Lists the purchases that were canceled, refunded or charged-back.
84
85Args:
86 packageName: string, The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 startTime: string, The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88 token: string, A parameter
89 maxResults: integer, A parameter
90 startIndex: integer, A parameter
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]91 endTime: string, The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
92 type: integer, The type of voided purchases that you want to see in the response. Possible values are:
93- 0: Only voided in-app product purchases will be returned in the response. This is the default value.
94- 1: Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
96Returns:
97 An object of the form:
98
99 {
100 "voidedPurchases": [
101 { # A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 "orderId": "A String", # The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 "kind": "androidpublisher#voidedPurchase", # This kind represents a voided purchase object in the androidpublisher service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104 "purchaseToken": "A String", # The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).
105 "voidedSource": 42, # The initiator of voided purchase, possible values are:
106 # - User
107 # - Developer
108 # - Google
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 "voidedTimeMillis": "A String", # The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 "purchaseTimeMillis": "A String", # The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 "voidedReason": 42, # The reason why the purchase was voided, possible values are:
112 # - Other
113 # - Remorse
114 # - Not_received
115 # - Defective
116 # - Accidental_purchase
117 # - Fraud
118 # - Friendly_fraud
119 # - Chargeback
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 },
121 ],
122 "tokenPagination": {
123 "nextPageToken": "A String",
124 "previousPageToken": "A String",
125 },
126 "pageInfo": {
127 "totalResults": 42,
128 "startIndex": 42,
129 "resultPerPage": 42,
130 },
131 }</pre>
132</div>
133
134</body></html>