Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e4e4b403f89a92d0f2d0661bf47d5ccd490d7bbd / . / docs / dyn / androidpublisher_v3.purchases.voidedpurchases.html
blob: 2a5b68456aee88f9bd4cc8df727707eb778332b2 [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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.purchases.html">purchases</a> . <a href="androidpublisher_v3.purchases.voidedpurchases.html">voidedpurchases</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]81 <code><a href="#list">list(packageName, type=None, maxResults=None, startTime=None, endTime=None, startIndex=None, token=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Lists the purchases that were canceled, refunded or charged-back.</p>
83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]90 <code class="details" id="list">list(packageName, type=None, maxResults=None, startTime=None, endTime=None, startIndex=None, token=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <pre>Lists the purchases that were canceled, refunded or charged-back.
92
93Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 packageName: string, The package name of the application for which voided purchases need to be returned (for example, &#x27;com.some.thing&#x27;). (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]95 type: integer, The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]96 maxResults: integer, Defines how many results the list operation should return. The default number depends on the resource collection.
97 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.
98 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.
99 startIndex: integer, Defines the index of the first element to return. This can only be used if indexed paging is enabled.
100 token: string, Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105
106Returns:
107 An object of the form:
108
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]109 { # Response for the voidedpurchases.list API.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]110 &quot;tokenPagination&quot;: { # Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one &quot;page&quot; of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_page_token or previous_page_token to access another page. # Pagination information for token pagination.
111 &quot;nextPageToken&quot;: &quot;A String&quot;, # Tokens to pass to the standard list field &#x27;page_token&#x27;. Whenever available, tokens are preferred over manipulating start_index.
112 &quot;previousPageToken&quot;: &quot;A String&quot;,
113 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;voidedPurchases&quot;: [
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]115 { # A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]116 &quot;kind&quot;: &quot;A String&quot;, # This kind represents a voided purchase object in the androidpublisher service.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]117 &quot;purchaseToken&quot;: &quot;A String&quot;, # 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).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]118 &quot;purchaseTimeMillis&quot;: &quot;A String&quot;, # The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]119 &quot;voidedTimeMillis&quot;: &quot;A String&quot;, # The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]120 &quot;voidedReason&quot;: 42, # The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback
121 &quot;voidedSource&quot;: 42, # The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google
122 &quot;orderId&quot;: &quot;A String&quot;, # 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]123 },
124 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]125 &quot;pageInfo&quot;: { # Information about the current page. List operations that supports paging return only one &quot;page&quot; of results. This protocol buffer message describes the page that has been returned. # General pagination information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]126 &quot;startIndex&quot;: 42, # Index of the first result returned in the current page.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]127 &quot;totalResults&quot;: 42, # Total number of results available on the backend ! The total number of results in the result set.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]128 &quot;resultPerPage&quot;: 42, # Maximum number of results returned in one page. ! The number of results included in the API response.
129 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 }</pre>
131</div>
132
133</body></html>