| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Kim | d059ad8 | 2020-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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#list">list(packageName, maxResults=None, type=None, startTime=None, endTime=None, startIndex=None, token=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 82 | <code class="details" id="list">list(packageName, maxResults=None, type=None, startTime=None, endTime=None, startIndex=None, token=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <pre>Lists the purchases that were canceled, refunded or charged-back. |
| 84 | |
| 85 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 86 | packageName: string, The package name of the application for which voided purchases need to be |
| 87 | returned (for example, 'com.some.thing'). (required) |
| 88 | maxResults: integer, Defines how many results the list operation should return. |
| 89 | The default number depends on the resource collection. |
| 90 | type: integer, The type of voided purchases that you want to see in the response. |
| 91 | Possible values are: |
| 92 | 0. Only voided in-app product purchases will be returned in the |
| 93 | response. This is the default value. |
| 94 | 1. Both voided in-app purchases and voided subscription purchases |
| 95 | will be returned in the response. |
| 96 | |
| 97 | Note: Before requesting to receive voided subscription purchases, you |
| 98 | must switch to use orderId in the response which uniquely identifies |
| 99 | one-time purchases and subscriptions. Otherwise, you will receive multiple |
| 100 | subscription orders with the same PurchaseToken, because subscription |
| 101 | renewal orders share the same PurchaseToken. |
| 102 | startTime: string, The time, in milliseconds since the Epoch, of the oldest voided purchase |
| 103 | that you want to see in the response. The value of this parameter cannot |
| 104 | be older than 30 days and is ignored if a pagination token is set. |
| 105 | Default value is current time minus 30 days. |
| 106 | Note: This filter is applied on the time at which the record is seen as |
| 107 | voided by our systems and not the actual voided time returned in the |
| 108 | response. |
| 109 | endTime: string, The time, in milliseconds since the Epoch, of the newest voided purchase |
| 110 | that you want to see in the response. The value of this parameter cannot |
| 111 | be greater than the current time and is ignored if a pagination token is |
| 112 | set. Default value is current time. |
| 113 | Note: This filter is applied on the time at which the record is seen as |
| 114 | voided by our systems and not the actual voided time returned in the |
| 115 | response. |
| 116 | startIndex: integer, Defines the index of the first element to return. |
| 117 | This can only be used if indexed paging is enabled. |
| 118 | token: string, Defines the token of the page to return, usually taken from |
| 119 | TokenPagination. |
| 120 | This can only be used if token paging is enabled. |
| 121 | x__xgafv: string, V1 error format. |
| 122 | Allowed values |
| 123 | 1 - v1 error format |
| 124 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 129 | { # Response for the voidedpurchases.list API. |
| 130 | "pageInfo": { # Information about the current page. # General pagination information. |
| 131 | # |
| 132 | # List operations that supports paging return only one "page" of results. This |
| 133 | # protocol buffer message describes the page that has been returned. |
| 134 | "resultPerPage": 42, # Maximum number of results returned in one page. |
| 135 | # ! The number of results included in the API response. |
| 136 | "startIndex": 42, # Index of the first result returned in the current page. |
| 137 | "totalResults": 42, # Total number of results available on the backend |
| 138 | # ! The total number of results in the result set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 139 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 140 | "tokenPagination": { # Pagination information returned by a List operation when token pagination # Pagination information for token pagination. |
| 141 | # is enabled. |
| 142 | # |
| 143 | # List operations that supports paging return only one "page" of results. This |
| 144 | # protocol buffer message describes the page that has been returned. |
| 145 | # |
| 146 | # When using token pagination, clients should use the next/previous token |
| 147 | # to get another page of the result. The presence or absence of next/previous |
| 148 | # token indicates whether a next/previous page is available and provides a |
| 149 | # mean of accessing this page. ListRequest.page_token should be set to either |
| 150 | # next_page_token or previous_page_token to access another page. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | "previousPageToken": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | "nextPageToken": "A String", # Tokens to pass to the standard list field 'page_token'. Whenever available, |
| 153 | # tokens are preferred over manipulating start_index. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 154 | }, |
| 155 | "voidedPurchases": [ |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 156 | { # A VoidedPurchase resource indicates a purchase that was either |
| 157 | # canceled/refunded/charged-back. |
| 158 | "kind": "A String", # This kind represents a voided purchase object in the androidpublisher |
| 159 | # service. |
| 160 | "voidedTimeMillis": "A String", # The time at which the purchase was canceled/refunded/charged-back, |
| 161 | # in milliseconds since the epoch (Jan 1, 1970). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "voidedReason": 42, # The reason why the purchase was voided, possible values are: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 163 | # 0. Other |
| 164 | # 1. Remorse |
| 165 | # 2. Not_received |
| 166 | # 3. Defective |
| 167 | # 4. Accidental_purchase |
| 168 | # 5. Fraud |
| 169 | # 6. Friendly_fraud |
| 170 | # 7. Chargeback |
| 171 | "orderId": "A String", # The order id which uniquely identifies a one-time purchase, subscription |
| 172 | # purchase, or subscription renewal. |
| 173 | "purchaseTimeMillis": "A String", # The time at which the purchase was made, in milliseconds since the |
| 174 | # epoch (Jan 1, 1970). |
| 175 | "purchaseToken": "A String", # The token which uniquely identifies a one-time purchase or subscription. |
| 176 | # To uniquely identify subscription renewals use order_id (available |
| 177 | # starting from version 3 of the API). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "voidedSource": 42, # The initiator of voided purchase, possible values are: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 179 | # 0. User |
| 180 | # 1. Developer |
| 181 | # 2. Google |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 182 | }, |
| 183 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 184 | }</pre> |
| 185 | </div> |
| 186 | |
| 187 | </body></html> |