Method: purchases.voidedpurchases.list

Liste les achats qui ont été annulés, remboursés ou ayant fait l'objet d'un rejet de débit.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
packageName

string

Nom de package de l'application pour lequel les achats annulés doivent être renvoyés (par exemple, "com.some.thing").

Paramètres de requête

Paramètres
pageSelection.maxResults

integer (uint32 format)

Définit le nombre de résultats que l'opération de liste doit renvoyer. Le nombre par défaut dépend de la collection de ressources.
pageSelection.startIndex

integer (uint32 format)

Définit l'index du premier élément à renvoyer. Cette option ne peut être utilisée que si la pagination indexée est activée.
pageSelection.token

string

Définit le jeton de la page à afficher, généralement issu de TokenPagination. Cette option ne peut être utilisée que si la pagination des jetons est activée.
startTime

string (int64 format)

Durée, en millisecondes écoulées depuis l'époque, de l'achat annulé le plus ancien que vous souhaitez voir dans la réponse. La valeur de ce paramètre ne peut pas dater de plus de 30 jours. Elle est ignorée si un jeton de pagination est défini. La valeur par défaut est égale à l'heure actuelle moins 30 jours. Remarque: Ce filtre est appliqué à l'heure à laquelle l'enregistrement est considéré comme annulé par nos systèmes, et non à l'heure d'annulation réelle renvoyée dans la réponse.
endTime

string (int64 format)

Durée, en millisecondes écoulées depuis l'époque, de l'achat annulé le plus récent que vous souhaitez voir dans la réponse. La valeur de ce paramètre ne peut pas être supérieure à l'heure actuelle. Elle est ignorée si un jeton de pagination est défini. La valeur par défaut est l'heure actuelle. Remarque: Ce filtre est appliqué à l'heure à laquelle l'enregistrement est considéré comme annulé par nos systèmes, et non à l'heure d'annulation réelle renvoyée dans la réponse.
type

integer

Type d'achats annulés que vous souhaitez voir dans la réponse. Les valeurs possibles sont: 0. Seuls les achats de produits intégrés annulés seront renvoyés dans la réponse. Il s'agit de la valeur par défaut. 1. Les achats via une application annulés et les achats d'abonnements annulés seront renvoyés dans la réponse.

Remarque: Avant de demander à recevoir des abonnements annulés, vous devez utiliser orderId dans la réponse, qui identifie de manière unique les achats et abonnements uniques. Dans le cas contraire, vous recevrez plusieurs bons de commande d'abonnement avec le même jeton d'achat, car les ordres de renouvellement d'abonnement partagent le même jeton d'achat.
includeQuantityBasedPartialRefund

boolean

Facultatif. Permet d'inclure ou non les achats annulés ou les remboursements partiels basés sur la quantité, qui ne s'appliquent qu'aux achats de quantités multiples. Si la valeur est "true", les achats annulés supplémentaires peuvent être renvoyés avec la valeur "voidedQuantity" qui indique la quantité remboursée pour un remboursement partiel basé sur la quantité. La valeur par défaut est false.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour l'API voidedpurchases.list.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
Champs
pageInfo

object (PageInfo)

Informations générales sur la pagination.
tokenPagination

object (TokenPagination)

Informations de pagination pour la pagination du jeton.
voidedPurchases[]

object (VoidedPurchase)

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

PageSelection

Type de paramètre de requête pageSelection qui définit les résultats et le nombre de résultats qu'une opération voidedpurchases.list doit renvoyer.

Représentation JSON 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
Champs
maxResults

integer (uint32 format)

Définit le nombre de résultats que l'opération de liste doit renvoyer. Le nombre par défaut dépend de la collection de ressources.
startIndex

integer (uint32 format)

Définit l'index du premier élément à renvoyer. Cette option ne peut être utilisée que si la pagination indexée est activée.
token

string

Définit le jeton de la page à afficher, généralement issu de TokenPagination. Cette option ne peut être utilisée que si la pagination des jetons est activée.