Method: purchases.voidedpurchases.list

Indique les achats qui ont été annulés, remboursés ou rejetés.

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 du package de l'application pour laquelle les achats annulés doivent être remboursés (par exemple, "com.un.truc").

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 à renvoyer, généralement extrait de TokenPagination. Cette option ne peut être utilisée que si la pagination des jetons est activée.
startTime

string (int64 format)

Heure (en millisecondes depuis l'epoch) de l'achat annulé le plus ancien que vous souhaitez afficher dans la réponse. La valeur de ce paramètre ne doit pas être antérieure à 30 jours et est ignorée si un jeton de pagination est défini. La valeur par défaut est 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)

Heure (en millisecondes depuis l'epoch) du dernier achat annulé que vous souhaitez afficher 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é à 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 afficher dans la réponse. Les valeurs possibles sont: 0. Seuls les achats de produits via une application annulés seront renvoyés dans la réponse. Il s'agit de la valeur par défaut. 1. Les achats via une application et les abonnements annulés sont tous deux renvoyés dans la réponse.

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

boolean

Facultatif. Indique si les achats annulés pour des remboursements partiels basés sur la quantité, qui ne s'appliquent qu'aux achats de quantités multiples, doivent être inclus. Si cette valeur est définie sur "true", d'autres achats annulés peuvent être retournés avec une valeur "voidedQuantity" qui indique la quantité remboursée 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 de 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 du paramètre de requête pageSelection qui définit les résultats et leur nombre à renvoyer par une opération voidedpurchases.list.

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 à renvoyer, généralement extrait de TokenPagination. Cette option ne peut être utilisée que si la pagination des jetons est activée.