com.google.api.services.androidpublisher

Class AndroidPublisher.Purchases.Voidedpurchases.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.androidpublisher.AndroidPublisherRequest<VoidedPurchasesListResponse>

com.google.api.services.androidpublisher.AndroidPublisher.Purchases.Voidedpurchases.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AndroidPublisher.Purchases.Voidedpurchases

public class AndroidPublisher.Purchases.Voidedpurchases.List
extends AndroidPublisherRequest<VoidedPurchasesListResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String packageName) Lists the purchases that were canceled, refunded or charged-back.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getEndTime() The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response.
Boolean	getIncludeQuantityBasedPartialRefund() Optional.
Long	getMaxResults() Defines how many results the list operation should return.
String	getPackageName() The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
Long	getStartIndex() Defines the index of the first element to return.
Long	getStartTime() The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response.
String	getToken() Defines the token of the page to return, usually taken from TokenPagination.
Integer	getType() The type of voided purchases that you want to see in the response.
AndroidPublisher.Purchases.Voidedpurchases.List	set(String parameterName, Object value)
AndroidPublisher.Purchases.Voidedpurchases.List	set$Xgafv(String $Xgafv) V1 error format.
AndroidPublisher.Purchases.Voidedpurchases.List	setAccessToken(String accessToken) OAuth access token.
AndroidPublisher.Purchases.Voidedpurchases.List	setAlt(String alt) Data format for response.
AndroidPublisher.Purchases.Voidedpurchases.List	setCallback(String callback) JSONP
AndroidPublisher.Purchases.Voidedpurchases.List	setEndTime(Long endTime) The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response.
AndroidPublisher.Purchases.Voidedpurchases.List	setFields(String fields) Selector specifying which fields to include in a partial response.
AndroidPublisher.Purchases.Voidedpurchases.List	setIncludeQuantityBasedPartialRefund(Boolean includeQuantityBasedPartialRefund) Optional.
AndroidPublisher.Purchases.Voidedpurchases.List	setKey(String key) API key.
AndroidPublisher.Purchases.Voidedpurchases.List	setMaxResults(Long maxResults) Defines how many results the list operation should return.
AndroidPublisher.Purchases.Voidedpurchases.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AndroidPublisher.Purchases.Voidedpurchases.List	setPackageName(String packageName) The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
AndroidPublisher.Purchases.Voidedpurchases.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AndroidPublisher.Purchases.Voidedpurchases.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AndroidPublisher.Purchases.Voidedpurchases.List	setStartIndex(Long startIndex) Defines the index of the first element to return.
AndroidPublisher.Purchases.Voidedpurchases.List	setStartTime(Long startTime) The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response.
AndroidPublisher.Purchases.Voidedpurchases.List	setToken(String token) Defines the token of the page to return, usually taken from TokenPagination.
AndroidPublisher.Purchases.Voidedpurchases.List	setType(Integer type) The type of voided purchases that you want to see in the response.
AndroidPublisher.Purchases.Voidedpurchases.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AndroidPublisher.Purchases.Voidedpurchases.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.androidpublisher.AndroidPublisherRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List(String packageName)

Lists the purchases that were canceled, refunded or charged-back. Create a request for the method "voidedpurchases.list". This request holds the parameters needed by the the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

AndroidPublisher.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

packageName - The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VoidedPurchasesListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VoidedPurchasesListResponse>

Throws:

IOException

set$Xgafv

public AndroidPublisher.Purchases.Voidedpurchases.List set$Xgafv(String $Xgafv)

Description copied from class: AndroidPublisherRequest

V1 error format.

Overrides:

set$Xgafv in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setAccessToken

public AndroidPublisher.Purchases.Voidedpurchases.List setAccessToken(String accessToken)

Description copied from class: AndroidPublisherRequest

OAuth access token.

Overrides:

setAccessToken in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setAlt

public AndroidPublisher.Purchases.Voidedpurchases.List setAlt(String alt)

Description copied from class: AndroidPublisherRequest

Data format for response.

Overrides:

setAlt in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setCallback

public AndroidPublisher.Purchases.Voidedpurchases.List setCallback(String callback)

Description copied from class: AndroidPublisherRequest

JSONP

Overrides:

setCallback in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setFields

public AndroidPublisher.Purchases.Voidedpurchases.List setFields(String fields)

Description copied from class: AndroidPublisherRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setKey

public AndroidPublisher.Purchases.Voidedpurchases.List setKey(String key)

Description copied from class: AndroidPublisherRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setOauthToken

public AndroidPublisher.Purchases.Voidedpurchases.List setOauthToken(String oauthToken)

Description copied from class: AndroidPublisherRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setPrettyPrint

public AndroidPublisher.Purchases.Voidedpurchases.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: AndroidPublisherRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setQuotaUser

public AndroidPublisher.Purchases.Voidedpurchases.List setQuotaUser(String quotaUser)

Description copied from class: AndroidPublisherRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setUploadType

public AndroidPublisher.Purchases.Voidedpurchases.List setUploadType(String uploadType)

Description copied from class: AndroidPublisherRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class AndroidPublisherRequest<VoidedPurchasesListResponse>

setUploadProtocol

public AndroidPublisher.Purchases.Voidedpurchases.List setUploadProtocol(String uploadProtocol)

Description copied from class: AndroidPublisherRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class AndroidPublisherRequest<VoidedPurchasesListResponse>

getPackageName

public String getPackageName()

The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').

setPackageName

public AndroidPublisher.Purchases.Voidedpurchases.List setPackageName(String packageName)

The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').

getEndTime

public Long getEndTime()

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.

setEndTime

public AndroidPublisher.Purchases.Voidedpurchases.List setEndTime(Long endTime)

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.

getIncludeQuantityBasedPartialRefund

public Boolean getIncludeQuantityBasedPartialRefund()

Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false.

setIncludeQuantityBasedPartialRefund

public AndroidPublisher.Purchases.Voidedpurchases.List setIncludeQuantityBasedPartialRefund(Boolean includeQuantityBasedPartialRefund)

Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false.

getMaxResults

public Long getMaxResults()

Defines how many results the list operation should return. The default number depends on the resource collection.

setMaxResults

public AndroidPublisher.Purchases.Voidedpurchases.List setMaxResults(Long maxResults)

Defines how many results the list operation should return. The default number depends on the resource collection.

getStartIndex

public Long getStartIndex()

Defines the index of the first element to return. This can only be used if indexed paging is enabled.

setStartIndex

public AndroidPublisher.Purchases.Voidedpurchases.List setStartIndex(Long startIndex)

Defines the index of the first element to return. This can only be used if indexed paging is enabled.

getStartTime

public Long getStartTime()

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.

setStartTime

public AndroidPublisher.Purchases.Voidedpurchases.List setStartTime(Long startTime)

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.

getToken

public String getToken()

Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.

setToken

public AndroidPublisher.Purchases.Voidedpurchases.List setToken(String token)

Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.

getType

public Integer getType()

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.

setType

public AndroidPublisher.Purchases.Voidedpurchases.List setType(Integer type)

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.

set

public AndroidPublisher.Purchases.Voidedpurchases.List set(String parameterName,
                                                           Object value)

Overrides:

set in class AndroidPublisherRequest<VoidedPurchasesListResponse>