Method: purchases.voidedpurchases.list

Enumera las compras que se cancelaron o reembolsaron, o para las cuales se generó una devolución del cargo.

Solicitud HTTP

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
packageName

string

Es el nombre del paquete de la aplicación para la que se deben devolver las compras anuladas (por ejemplo, "com.algo.algo").

Parámetros de consulta

Parámetros
pageSelection.maxResults

integer (uint32 format)

Define cuántos resultados debe devolver la operación list. La cantidad predeterminada depende de la colección de recursos.
pageSelection.startIndex

integer (uint32 format)

Define el índice del primer elemento que se devolverá. Esto solo se puede usar si está habilitada la paginación indexada.
pageSelection.token

string

Define el token de la página que se devolverá y que generalmente se obtiene de TokenPagination. Esto solo se puede usar si está habilitada la paginación con tokens.
startTime

string (int64 format)

Indica el tiempo (en milisegundos desde la época) desde la compra anulada más antigua que quieras ver en la respuesta. El valor de este parámetro no puede ser anterior a 30 días y se ignora si se configura un token de paginación. El valor predeterminado es la hora actual menos 30 días. Nota: Este filtro se aplica en el momento en que nuestros sistemas observan el registro como anulado, y no en el momento real de la anulación que se devuelve en la respuesta.
endTime

string (int64 format)

Indica el tiempo (en milisegundos desde la época) a partir de la compra anulada más reciente que quieras ver en la respuesta. El valor de este parámetro no puede ser posterior a la hora actual y se ignora si se configura un token de paginación. El valor predeterminado es la hora actual. Nota: Este filtro se aplica en el momento en que nuestros sistemas observan el registro como anulado, y no en el momento real de la anulación que se devuelve en la respuesta.
type

integer

Indica el tipo de compras anuladas que deseas que aparezcan en la respuesta. Los valores posibles son los siguientes: 0. En la respuesta solo se devolverán compras anuladas de productos integrados en la aplicación. Este es el valor predeterminado. 1. En la respuesta se devolverán las compras anuladas, ya sean directas desde la aplicación o de suscripciones.

Nota: Para solicitar la recepción de compras de suscripciones anuladas, debes usar orderId en la respuesta, ya que identifica de forma exclusiva las suscripciones y compras únicas. De lo contrario, recibirás múltiples pedidos de suscripción con el mismo valor de PurchaseToken, porque los pedidos de renovación de suscripciones comparten ese valor.
includeQuantityBasedPartialRefund

boolean

Opcional. Indica si se incluirán compras anuladas de reembolsos parciales basados en la cantidad, los cuales se aplican únicamente a las compras de cantidades múltiples. Si es verdadero, es posible que se devuelvan compras anuladas adicionales con voidedQuantity, que indica la cantidad de un reembolso parcial basado en la cantidad. El valor predeterminado es falso.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta de la API de voidedpurchases.list.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
Campos
pageInfo

object (PageInfo)

Es información de paginación general.
tokenPagination

object (TokenPagination)

Es información de paginación para la paginación con tokens.
voidedPurchases[]

object (VoidedPurchase)

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/androidpublisher

PageSelection

Es el tipo de parámetro de solicitud de pageSelection que define qué y cuántos resultados debe devolver una operación voidedpurchases.list.

Representación JSON 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
Campos
maxResults

integer (uint32 format)

Define cuántos resultados debe devolver la operación list. La cantidad predeterminada depende de la colección de recursos.
startIndex

integer (uint32 format)

Define el índice del primer elemento que se devolverá. Esto solo se puede usar si está habilitada la paginación indexada.
token

string

Define el token de la página que se devolverá y que generalmente se obtiene de TokenPagination. Esto solo se puede usar si está habilitada la paginación con tokens.