Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
L'API Voided Purchases de Google Play fournit la liste des commandes
sont associées à des achats annulés par l'utilisateur. Vous pouvez utiliser des informations
de cette liste pour mettre en place un système de révocation qui empêche l'utilisateur
accéder aux produits
de ces commandes.
Cette API s'applique aux commandes et abonnements ponctuels effectués via une application.
Un achat peut être annulé pour les raisons suivantes :
L'utilisateur demande le remboursement de sa commande.
L'utilisateur annule sa commande.
Une commande est rejetée.
Le développeur annule ou rembourse la commande.
Google annule ou rembourse la commande.
En utilisant cette API, vous contribuez à créer une expérience plus équilibrée et équitable pour tous les utilisateurs de votre application, en particulier s'il s'agit d'un jeu.
Accès
Pour utiliser l'API Voided Purchases, vous devez être autorisé à afficher
des informations financières. Vous accordez les autorisations à l'aide d'un client OAuth ou
de service géré. Si vous utilisez un compte de service, activez l'option
rapports" au sein de ce compte.
Pour en savoir plus sur l'obtention d'un accès autorisé aux API Google Play Developer, consultez
les guides suivants:
Utilisez la méthode GET pour demander la liste des achats annulés. Dans votre demande,
incluez le nom complet du package de votre application,
com.google.android.apps.maps, et le jeton d'autorisation que vous
reçues lors de l'obtention de l'accès à l'API.
GET https://www.googleapis.com/androidpublisher/v3/applications/
your_package_name/purchases/voidedpurchases?access_token=your_auth_token
Vous pouvez également inclure les paramètres suivants dans votre requête, chacun étant
facultatif:
startTime
Durée, en millisecondes écoulées depuis l'epoch Unix, de la plus ancienne
l'achat annulé que vous souhaitez voir dans la réponse. Par défaut,
startTime est définie sur il y a 30 jours.
L'API ne peut afficher que les achats annulés qui ont eu lieu dans le passé.
30 jours. Les achats annulés plus anciens ne sont pas inclus dans la réponse,
de la valeur que vous avez fournie pour startTime.
<ph type="x-smartling-placeholder">
endTime
Durée, en millisecondes écoulées depuis l'epoch Unix, de la
l'achat annulé que vous voulez voir dans la réponse. Par défaut,
endTime est défini sur l'heure actuelle.
maxResults
Nombre maximal d'achats annulés qui apparaissent dans chaque réponse. Par
par défaut, cette valeur est 1000. Notez que la valeur maximale de ce paramètre est
et 1 000.
jeton
Jeton de continuation d'une réponse précédente, vous permettant d'afficher plus
résultats.
type
Type d'achats annulés qui apparaissent dans chaque réponse. Si la valeur est définie sur 0,
seuls les achats via l'application annulés sont renvoyés. Si la valeur est définie sur 1, les deux éléments dans l'application sont annulés
et les abonnements annulés sont retournés. La valeur par défaut est
0.
includeQuantityBasedPartialRefund
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,
d'autres achats annulés peuvent être retournés avec voidedQuantity
qui indique la quantité remboursée d'un remboursement partiel basé sur la quantité. La valeur par défaut est false.
La réponse est une chaîne JSON qui contient une liste d'achats annulés. S'il y a
Le nombre de résultats est supérieur au nombre spécifié dans le paramètre de requête maxResults.
, la réponse inclut une valeur nextPageToken, que vous pouvez transmettre à un
requête ultérieure pour afficher plus de résultats. Le premier résultat de la liste
achat annulé le plus ancien.
L'API Voided Purchases définit les quotas suivants par paquet:
6 000 requêtes par jour. (Une journée commence et se termine à minuit, heure du Pacifique.)
30 requêtes au cours d'une période de 30 secondes
Consignes pour les requêtes initiales
Lors de votre requête API initiale, vous souhaiterez peut-être récupérer toutes les données disponibles pour
votre application. Bien que peu probable, ce processus peut épuiser votre quota quotidien. À
obtenir les données sur les achats annulés de manière plus sûre et cohérente, suivez ces
bonnes pratiques:
Utilisez la valeur par défaut pour le paramètre maxResults. De cette façon, si vous utilisez
l'intégralité de votre quota de requêtes pour une journée, vous pouvez récupérer
achats annulés.
Si une réponse inclut une valeur pour nextPageToken, attribuez cette valeur au
token lors de votre prochaine requête.
Bonnes pratiques
Lorsque vous utilisez cette API dans votre application, n'oubliez pas
d'annuler un achat et qu'il n'existe pas de solution unique
dans tous les cas. Vous devez garder vos utilisateurs à l'esprit lorsque vous concevez votre révocation
des stratégies et des stratégies. Pour ce faire, vous pouvez appliquer les pratiques recommandées suivantes:
Utilisez cette API comme l'un des nombreux éléments d'une stratégie complète pour résoudre les problèmes
tout comportement indésirable. Révocation de l'accès aux produits intégrés est généralement plus efficace
lorsqu'elle est associée à une application dont les prix sont raisonnables pour les achats via l'application,
une conception d'application qui décourage tout comportement indésirable, une base d'utilisateurs solide dont
rejette ce type de comportement, et une assistance aux utilisateurs réactive et efficace
canaux de distribution.
Administrer vos règles de révocation de manière uniforme afin de garantir l'équité pour tous les utilisateurs.
Envisagez de créer une règle en préproduction pour traiter les comportements indésirables. Pour
Par exemple, commencez par les avertissements dans l'application en cas d'infractions précoces, puis escaladez
si le comportement indésirable d'un utilisateur se poursuit. En dernier recours, vous pouvez
empêcher un utilisateur d'interagir avec votre application.
Lorsque vous mettez en place une règle de révocation et que vous la mettez à jour, utilisez votre
les canaux de communication de votre application
pour informer vos utilisateurs des changements. Offrez à vos utilisateurs
pour bien comprendre ces changements avant qu'ils n'entrent en vigueur dans votre application.
Soyez transparent envers vos utilisateurs et informez-les chaque fois que vous prenez des mesures, par exemple
révoquant son accès à un produit intégré ; Dans l’idéal, les utilisateurs
devraient pouvoir
contestent vos décisions, et ces contestations doivent être traitées de manière équitable.
Surveiller les formulaires de commentaires et les forums de la communauté pour comprendre ce qui pousse les utilisateurs à
se comportent de manière indésirable
et la façon dont ils se comportent de tels comportements. Prenez des mesures en conséquence
les insights comme première ligne de défense.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003eThe Google Play Voided Purchases API lets you track voided in-app purchases and subscriptions to implement revocation systems, ensuring a fair user experience.\u003c/p\u003e\n"],["\u003cp\u003eVoided purchases include user refunds, cancellations, chargebacks, and cancellations/refunds by the developer or Google.\u003c/p\u003e\n"],["\u003cp\u003eAccess the API using OAuth or a service account with "View financial reports" permission and make requests with your package name and authorization token.\u003c/p\u003e\n"],["\u003cp\u003eTailor your revocation policies to be fair and transparent, escalating responses as needed while informing users of any actions taken.\u003c/p\u003e\n"],["\u003cp\u003eCombine this API with other strategies and real-time notifications for a comprehensive approach to managing user entitlements and addressing undesirable behaviors.\u003c/p\u003e\n"]]],["The Google Play Voided Purchases API lists orders linked to user-voided purchases, including refunds, cancellations, chargebacks, and developer/Google-initiated voids. This API helps developers implement revocation systems to prevent access to products from voided orders. To use it, developers need \"View financial reports\" permission and can use a `GET` method to request voided purchases, filtering by time, quantity, or type. It has quotas, provides best practices and advises using it along side RTDN.\n"],null,["# Voided Purchases API\n\nThe Google Play Voided Purchases API provides a list of orders that\nare associated with purchases that a user has voided. You can use information\nfrom this list to implement a revocation system that prevents the user from\naccessing products from those orders.\n\nThis API applies to one-time in-app orders and App Subscriptions.\n\nA purchase can be voided in the following ways:\n\n- The user requests a refund for their order.\n- The user cancels their order.\n- An order is charged back.\n- Developer cancels or refunds order.\n\n | **Note:** only revoked orders will be shown in the Voided Purchases API. If a developer refunds a purchase without setting the revoke option, the order will not be returned by the API.\n- Google cancels or refunds order.\n\nBy using this API, you help create a more balanced and fair experience for all\nof your app's users, particularly if your app is a game.\n| **Note:** Unlike other order-related data sources, the Voided Purchases API includes purchases that are charged back by payment processors. Therefore, you might see inconsistencies between the information from this API and information from other order-related data sources.\n| **Note:** The Voided Purchases API returns voided purchases only when they need to be revoked. Developers can use this API as an indication for when to take additional action on their end. However, some purchases may be refunded with reason that the purchase was never acknowledged by the developer, and therefore may not exist in the developer's records.\n\nGaining Access\n--------------\n\nTo work with the Voided Purchases API, you need to have permission to view\nfinancial information. You provide authorization using an OAuth client or a\nservice account. If you're using a service account, enable the \"View financial\nreports\" permission within this account.\n\nTo learn more about gaining authorized access to Google Play Developer APIs, see\nthe following guides:\n\n- [Setting Up API Access Clients](/android-publisher/getting_started#setting_up_api_access_clients)\n- [Add developer account users \\& manage permissions](https://support.google.com/googleplay/android-developer/answer/2528691)\n\nViewing Voided Purchases\n------------------------\n\nUse the `GET` method to request a list of voided purchases. In your request,\ninclude the fully-qualified package name for your app---such as\n`com.google.android.apps.maps`---and the authorization token you\nreceived when [gaining access](#gaining_access) to the API. \n\n```\nGET https://www.googleapis.com/androidpublisher/v3/applications/\nyour_package_name/purchases/voidedpurchases?access_token=your_auth_token\n```\n\nYou can also include the following parameters in your request, each of which is\noptional:\n\nstartTime\n\n: The time, in milliseconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time), of the oldest\n voided purchase that you want to see in the response. By default,\n `startTime` is set to 30 days ago.\n\n The API can only show voided purchases that have occurred during the past\n 30 days. Older voided purchases are not included in the response, regardless\n of the value that you've provided for `startTime`.\n | **Note:** The voided purchases within the response are filtered based on the time at which a given record is seen as voided by the API, not by the value of `voidedTimeMillis` returned in the response.\n\nendTime\n\n: The time, in milliseconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time), of the newest\n voided purchase of that you want to see in the response. By default,\n `endTime` is set to the current time.\n\n | **Note:** The voided purchases within the response are filtered based on the time at which a given record is seen as voided by the API, not by the value of `voidedTimeMillis` returned in the response.\n\nmaxResults\n: The maximum number of voided purchases that appear in each response. By\n default, this value is 1000. Note that the maximum value for this parameter is\n also 1000.\n\ntoken\n: A continuation token from a previous response, allowing you to view more\n results.\n\ntype\n\n: The type of voided purchases that appear in each response. If set to 0,\n only voided in-app purchases will be returned. If set to 1, both voided in-app\n purchases and voided subscription purchases will be returned. Default value is\n 0.\n\n | **Note:** Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken.\n\nincludeQuantityBasedPartialRefund\n\n: Whether to include voided purchases of quantity-based partial refunds,\n which are applicable only to multi-quantity purchases. If `true`,\n additional voided purchases may be returned with `voidedQuantity`\n that indicates the refund quantity of a quantity-based partial refund. The\n default value is `false`.\n\n | **Note:** When the remaining total quantity of a purchase is refunded, the corresponding voided purchase won't have `voidedQuantity`, which serves as a signal that the purchase has been fully refunded. For example, if a purchase of quantity 10 is refunded 3 times with quantities 2, 3 and 5, there will be 3 voided purchases. The first two voided purchases will have a `voidedQuantity` of 2 and 3, while the third voided purchase *will not* have a `voidedQuantity`.\n\nThe response is a JSON string that contains a list of voided purchases. If there\nare more results than the number specified in the `maxResults` request parameter\n, the response includes a `nextPageToken` value, which you can pass into a\nsubsequent request to view more results. The first result in the list shows the\noldest voided purchase. \n\n```\n{\n \"tokenPagination\": {\n \"nextPageToken\": \"next_page_token\"\n },\n \"voidedPurchases\": [\n {\n \"kind\": \"androidpublisher#voidedPurchase\",\n \"purchaseToken\": \"some_purchase_token\",\n \"purchaseTimeMillis\": \"1468825200000\",\n \"voidedTimeMillis\": \"1469430000000\",\n \"orderId\": \"some_order_id\",\n \"voidedSource\": \"0\",\n \"voidedReason\": \"4\"\n },\n {\n \"kind\": \"androidpublisher#voidedPurchase\",\n \"purchaseToken\": \"some_other_purchase_token\",\n \"purchaseTimeMillis\": \"1468825100000\",\n \"voidedTimeMillis\": \"1470034800000\",\n \"orderId\": \"some_other_order_id\",\n \"voidedSource\": \"2\",\n \"voidedReason\": \"5\"\n },\n ]\n}\n```\n\nQuotas\n------\n\nThe Voided Purchases API sets the following quotas on a per-package basis:\n\n- 6000 queries per day. (The day begins and ends at midnight Pacific Time.)\n- 30 queries during any 30-second period.\n\n### Guidelines for initial requests\n\nDuring your initial API request, you may want to fetch all available data for\nyour app. Although unlikely, this process could exhaust your daily quota. To\nobtain voided purchases data in a safer, more consistent manner, follow these\nbest practices:\n\n- Use the default value for the `maxResults` parameter. That way, if you use your entire query quota for a day, you can retrieve the details of 6,000,000 voided purchases.\n- If a response includes a value for `nextPageToken`, assign this value to the `token` parameter during your next request.\n\nBest Practices\n--------------\n\n| **Note:** In addition to using this API, developers should integrate with [Real-time developer notifications (RTDN)](https://developer.android.com/google/play/billing/getting-ready#configure-rtdn). With RTDN, you receive notifications from Google whenever there is a change in a user's entitlement within your app, including when a user [voids a purchase](https://developer.android.com/google/play/billing/rtdn-reference#voided-purchase).\n\nWhen using this API in your app, remember that there are many\nreasons to void a purchase and that there is no single solution that works in\nall cases. You should keep your users in mind when designing your revocation\npolicies and strategies. To do so, you can apply these recommended practices:\n\n- Use this API as one of many elements in a comprehensive strategy to address undesired behavior. Revoking access to in-app products is usually more effective when combined with an app that has reasonable prices for in-app purchases, an app design that discourages undesirable behavior, a strong user base whose culture rejects such behavior, and responsive and efficient user support channels.\n- Administer your revocation policy uniformly to ensure fairness for all users.\n- Consider creating a staged policy when addressing undesired behavior. For example, start with in-app warnings for early offenses, then escalate your responses as a user's undesired behavior continues. As a last resort, you can prevent a user from interacting with your app at all.\n- When you introduce a revocation policy, and each time you update it, use your app's outreach channels to inform your users about the changes. Give your users time to clearly understand these changes before they take effect in your app.\n- Be transparent to your users and inform them whenever you take action, such as revoking their access to an in-app product. Ideally, users should be able to dispute your decisions, and such disputes should be treated fairly.\n- Monitor feedback forms and community forums to understand what drives users to behave in undesirable ways and how they carry out such behavior. Act on these insights as a first line of defense."]]
