با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
Google Play Voided Purchases API فهرستی از سفارش‌های مرتبط با خریدهایی را که کاربر باطل کرده است ارائه می‌کند. می‌توانید از اطلاعات این فهرست برای پیاده‌سازی یک سیستم ابطال استفاده کنید که از دسترسی کاربر به محصولات آن سفارش‌ها جلوگیری می‌کند.
این API برای سفارش‌های درون‌برنامه‌ای یک‌باره و اشتراک‌های برنامه اعمال می‌شود.
خرید را می توان به روش های زیر باطل کرد:
کاربر برای سفارش خود درخواست بازپرداخت می کند.
کاربر سفارش خود را لغو می کند.
یک سفارش پس گرفته می شود.
برنامه‌نویس سفارش را لغو یا بازپرداخت می‌کند.
Google سفارش را لغو یا بازپرداخت می کند.
با استفاده از این API، به ایجاد یک تجربه متعادل تر و منصفانه برای همه کاربران برنامه خود کمک می کنید، به خصوص اگر برنامه شما یک بازی باشد.
دستیابی به دسترسی
برای کار با Voided Purchases API، باید مجوز مشاهده اطلاعات مالی را داشته باشید. شما با استفاده از یک سرویس گیرنده OAuth یا یک حساب خدمات مجوز ارائه می کنید. اگر از یک حساب خدماتی استفاده می‌کنید، مجوز «مشاهده گزارش‌های مالی» را در این حساب فعال کنید.
برای کسب اطلاعات بیشتر در مورد دسترسی مجاز به API های برنامه نویس Google Play، به راهنمای زیر مراجعه کنید:
از روش GET برای درخواست لیستی از خریدهای باطل استفاده کنید. در درخواست خود، نام بسته کاملاً واجد شرایط برنامه خود - مانند com.google.android.apps.maps - و رمز مجوزی را که هنگام دسترسی به API دریافت کرده‌اید، وارد کنید.
GET https://www.googleapis.com/androidpublisher/v3/applications/
your_package_name/purchases/voidedpurchases?access_token=your_auth_token
همچنین می توانید پارامترهای زیر را در درخواست خود بگنجانید که هر کدام اختیاری است:
زمان شروع
زمان، بر حسب میلی ثانیه از دوران یونیکس ، قدیمی ترین خرید باطل شده ای که می خواهید در پاسخ مشاهده کنید. به طور پیش فرض، startTime روی 30 روز پیش تنظیم شده است.
API فقط می‌تواند خریدهای باطل شده‌ای را نشان دهد که در 30 روز گذشته رخ داده‌اند. خریدهای باطل شده قدیمی‌تر، صرف‌نظر از ارزشی که برای startTime ارائه کرده‌اید، در پاسخ لحاظ نمی‌شوند.
پایان زمان
زمان، بر حسب میلی ثانیه از دوران یونیکس ، جدیدترین خرید باطل شده ای که می خواهید در پاسخ مشاهده کنید. به طور پیش فرض، endTime روی زمان فعلی تنظیم شده است.
حداکثر نتایج
حداکثر تعداد خریدهای باطل که در هر پاسخ ظاهر می شود. به طور پیش فرض این مقدار 1000 است. توجه داشته باشید که حداکثر مقدار برای این پارامتر نیز 1000 است.
نشانه
یک نشانه ادامه از پاسخ قبلی که به شما امکان می دهد نتایج بیشتری را مشاهده کنید.
نوع
نوع خریدهای باطل که در هر پاسخ ظاهر می شود. اگر روی 0 تنظیم شود، فقط خریدهای درون برنامه ای باطل شده برگردانده می شوند. اگر روی ۱ تنظیم شود، هم خریدهای درون‌برنامه‌ای باطل و هم خریدهای اشتراک باطل برگردانده می‌شوند. مقدار پیش فرض 0 است.
شامل بازپرداخت جزئی مقدار مبتنی بر مقدار
آیا شامل خریدهای باطل بازپرداخت جزئی بر اساس مقدار است که فقط برای خریدهای چند مقداری قابل اعمال است. اگر true ، خریدهای اضافی باطل شده ممکن است با voidedQuantity که مقدار بازپرداخت بازپرداخت جزئی بر اساس مقدار را نشان می‌دهد، بازگردانده شوند. مقدار پیش فرض false است.
پاسخ یک رشته JSON است که شامل لیستی از خریدهای باطل شده است. اگر نتایج بیشتر از تعداد مشخص‌شده در پارامتر درخواست maxResults باشد، پاسخ شامل یک مقدار nextPageToken است که می‌توانید برای مشاهده نتایج بیشتر به درخواست بعدی ارسال کنید. اولین نتیجه در لیست قدیمی ترین خرید باطل شده را نشان می دهد.
Voided Purchases API سهمیه های زیر را بر اساس هر بسته تعیین می کند:
6000 پرس و جو در روز. (روز در نیمه شب به وقت اقیانوس آرام شروع و به پایان می رسد.)
30 پرس و جو در هر دوره 30 ثانیه ای.
دستورالعمل برای درخواست های اولیه
در طول درخواست اولیه API خود، ممکن است بخواهید همه داده های موجود را برای برنامه خود واکشی کنید. اگرچه بعید است، اما این روند می تواند سهمیه روزانه شما را تمام کند. برای به دست آوردن اطلاعات خریدهای باطل به روشی ایمن تر و سازگارتر، این بهترین شیوه ها را دنبال کنید:
از مقدار پیش فرض برای پارامتر maxResults استفاده کنید. به این ترتیب، اگر از کل سهمیه درخواست خود برای یک روز استفاده کنید، می توانید جزئیات 6,000,000 خرید باطل شده را بازیابی کنید.
اگر یک پاسخ حاوی مقداری برای nextPageToken باشد، در درخواست بعدی خود این مقدار را به پارامتر token اختصاص دهید.
بهترین شیوه ها
هنگام استفاده از این API در برنامه خود، به یاد داشته باشید که دلایل زیادی برای لغو خرید وجود دارد و هیچ راه حل واحدی وجود ندارد که در همه موارد کار کند. هنگام طراحی خط مشی ها و استراتژی های ابطال، باید کاربران خود را در نظر داشته باشید. برای انجام این کار، می توانید این روش های توصیه شده را اعمال کنید:
از این API به عنوان یکی از عناصر متعدد در یک استراتژی جامع برای رسیدگی به رفتارهای نامطلوب استفاده کنید. لغو دسترسی به محصولات درون‌برنامه معمولاً زمانی مؤثرتر است که با برنامه‌ای ترکیب شود که قیمت‌های مناسبی برای خریدهای درون‌برنامه دارد، طراحی اپلیکیشنی که رفتار نامطلوب را منع می‌کند، پایگاه کاربری قوی که فرهنگ آن چنین رفتاری را رد می‌کند، و پشتیبانی پاسخگو و کارآمد کاربر. کانال ها
خط مشی ابطال خود را به طور یکسان مدیریت کنید تا از عدالت برای همه کاربران اطمینان حاصل کنید.
هنگام پرداختن به رفتار ناخواسته، یک خط مشی مرحله‌ای را در نظر بگیرید. به عنوان مثال، با هشدارهای درون برنامه ای برای تخلفات اولیه شروع کنید، سپس با ادامه رفتار نامطلوب کاربر، پاسخ های خود را تشدید کنید. به عنوان آخرین راه حل، می توانید به هیچ وجه از تعامل کاربر با برنامه خود جلوگیری کنید.
وقتی یک خط‌مشی لغو را معرفی می‌کنید و هر بار که آن را به‌روزرسانی می‌کنید، از کانال‌های ارتباطی برنامه‌تان برای اطلاع‌رسانی به کاربران خود در مورد تغییرات استفاده کنید. به کاربران خود زمان بدهید تا قبل از اعمال این تغییرات در برنامه شما، به وضوح این تغییرات را درک کنند.
برای کاربران خود شفاف باشید و هر زمان که اقدامی انجام می دهید، مانند لغو دسترسی آنها به یک محصول درون برنامه ای، به آنها اطلاع دهید. در حالت ایده آل، کاربران باید بتوانند تصمیمات شما را به چالش بکشند و با چنین اختلافاتی باید منصفانه برخورد شود.
فرم‌های بازخورد و انجمن‌های انجمن را زیر نظر بگیرید تا بفهمید چه چیزی کاربران را به رفتارهای نامطلوب سوق می‌دهد و چگونه چنین رفتاری را انجام می‌دهند. بر اساس این بینش ها به عنوان اولین خط دفاع عمل کنید.
تاریخ آخرین به‌روزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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."]]
