Method: purchases.voidedpurchases.list

Indica las compras que se cancelaron, reembolsaron o devolvieron.

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 mostrar la operación de lista. La cantidad predeterminada depende de la colección de recursos.

pageSelection.startIndex

integer (uint32 format)

Define el índice del primer elemento que se muestra. Solo se puede usar si está habilitada la paginación indexada.

pageSelection.token

string

Define el token de la página que se mostrará, por lo general, tomado de la paginación de tokens. Solo se puede usar si la paginación de tokens está habilitada.

startTime

string (int64 format)

Indica el tiempo (en milisegundos desde la época) de la compra anulada más antigua que quieras ver en la respuesta. El valor de este parámetro no puede tener más de 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 anulan el registro y no en el tiempo real de anulación que se muestra en la respuesta.

endTime

string (int64 format)

Indica el tiempo (en milisegundos desde la época) de la compra anulada más reciente que quieras ver en la respuesta. El valor de este parámetro no puede ser mayor que 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 anulan el registro y no en el tiempo real de anulación que se muestra en la respuesta.

type

integer

Indica el tipo de compras anuladas que deseas ver en la respuesta. Los valores posibles son 0. En la respuesta, solo se mostrarán las compras anuladas de productos integrados en la aplicación. Este es el valor predeterminado. 1. Las compras directas desde la aplicación y las compras de suscripciones que se anularon se mostrarán en la respuesta.

Nota: Antes de solicitar la recepción de compras de suscripciones anuladas, debes usar orderId en la respuesta, que identifica de forma única las suscripciones y compras únicas. De lo contrario, recibirás varios pedidos de suscripción con el mismo PurchaseToken, ya que los pedidos de renovación de suscripciones comparten el mismo PurchaseToken.

includeQuantityBasedPartialRefund

boolean

Opcional. Indica si se deben incluir las compras anuladas de reembolsos parciales basados en la cantidad, que se aplican solo a las compras de varias cantidades. Si es verdadero, es posible que se devuelvan otras compras anuladas con el valor 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

Respuesta para 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)

Información general sobre paginación.

tokenPagination

object (TokenPagination)

Información de paginación para la paginación de tokens.

voidedPurchases[]

object (VoidedPurchase)

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

PageSelection

Es el tipo del parámetro de solicitud pageSelection que define cuáles y cuántos resultados debe mostrar una operación voidedpurchases.list.

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

integer (uint32 format)

Define cuántos resultados debe mostrar la operación de lista. La cantidad predeterminada depende de la colección de recursos.

startIndex

integer (uint32 format)

Define el índice del primer elemento que se muestra. Solo se puede usar si está habilitada la paginación indexada.

token

string

Define el token de la página que se mostrará, por lo general, tomado de la paginación de tokens. Solo se puede usar si la paginación de tokens está habilitada.