Class PurchasesResource.VoidedpurchasesResource.ListRequest
Lists the purchases that were canceled, refunded or charged-back.
Inheritance
Inherited Members
Namespace: Google.Apis.AndroidPublisher.v3
Assembly: Google.Apis.AndroidPublisher.v3.dll
Syntax
public class PurchasesResource.VoidedpurchasesResource.ListRequest : AndroidPublisherBaseServiceRequest<VoidedPurchasesListResponse>, IClientServiceRequest<VoidedPurchasesListResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string packageName)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| string | packageName |
Properties
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.
Declaration
[RequestParameter("endTime", RequestParameterType.Query)]
public virtual long? EndTime { get; set; }
Property Value
| Type | Description |
|---|---|
| long? |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
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.
Declaration
[RequestParameter("includeQuantityBasedPartialRefund", RequestParameterType.Query)]
public virtual bool? IncludeQuantityBasedPartialRefund { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
MaxResults
Defines how many results the list operation should return. The default number depends on the resource collection.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
| Type | Description |
|---|---|
| long? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
PackageName
The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
Declaration
[RequestParameter("packageName", RequestParameterType.Path)]
public virtual string PackageName { get; }
Property Value
| Type | Description |
|---|---|
| string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
StartIndex
Defines the index of the first element to return. This can only be used if indexed paging is enabled.
Declaration
[RequestParameter("startIndex", RequestParameterType.Query)]
public virtual long? StartIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| 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.
Declaration
[RequestParameter("startTime", RequestParameterType.Query)]
public virtual long? StartTime { get; set; }
Property Value
| Type | Description |
|---|---|
| long? |
Token
Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.
Declaration
[RequestParameter("token", RequestParameterType.Query)]
public virtual string Token { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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.
Declaration
[RequestParameter("type", RequestParameterType.Query)]
public virtual int? Type { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()