Method: purchases.voidedpurchases.list

Liste les achats 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 laquelle des 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 à afficher. 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. Elle ne peut être utilisée que si la pagination de jetons est activée.

startTime

string (int64 format)

Durée, en millisecondes depuis l'epoch, du plus ancien achat annulé que vous souhaitez voir dans la réponse. La valeur de ce paramètre ne peut pas dater de plus de 30 jours et est ignorée si un jeton de pagination est défini. La valeur par défaut correspond à l'heure actuelle moins 30 jours. Remarque: Ce filtre est appliqué au moment où l'enregistrement est considéré comme annulé par nos systèmes, et non au temps d'annulation réel renvoyé dans la réponse.

endTime

string (int64 format)

Durée, en millisecondes depuis l'epoch, du dernier achat annulé que vous souhaitez voir dans la réponse. La valeur de ce paramètre ne peut pas être supérieure à l'heure actuelle et 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é au moment où l'enregistrement est considéré comme annulé par nos systèmes, et non au temps d'annulation réel renvoyé 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 ainsi que les achats d'abonnements annulés seront renvoyés dans la réponse.

Remarque: Avant de demander à recevoir des achats d'abonnements annulés, vous devez utiliser orderId dans la réponse, qui identifie de manière unique les achats ponctuels et les abonnements. Sinon, vous recevrez plusieurs commandes d'abonnement avec le même purchaseToken, car les demandes de renouvellement d'abonnement partagent le même purchaseToken.

includeQuantityBasedPartialRefund

boolean

Facultatif. Permet d'inclure les achats annulés pour les remboursements partiels basés sur une quantité, qui ne s'appliquent qu'aux achats de quantités multiples. Si la valeur est "true", des achats supplémentaires annulés peuvent être retournés avec voidedQuantity qui indique la quantité à rembourser d'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 des jetons.

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 quel résultat et combien de résultats 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 à afficher. 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. Elle ne peut être utilisée que si la pagination de jetons est activée.