REST Resource: purchases.products
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
المرجع: ProductPurchase
يشير مورد Productpurchase إلى حالة عملية شراء المنتج داخل التطبيق التي يجريها المستخدم.
| تمثيل JSON |
{
"kind": string,
"purchaseTimeMillis": string,
"purchaseState": integer,
"consumptionState": integer,
"developerPayload": string,
"orderId": string,
"purchaseType": integer,
"acknowledgementState": integer,
"purchaseToken": string,
"productId": string,
"quantity": integer,
"obfuscatedExternalAccountId": string,
"obfuscatedExternalProfileId": string,
"regionCode": string,
"refundableQuantity": integer
} |
| الحقول |
kind |
string
يُمثِّل هذا النوع عنصر inappPurchase في خدمة androidpublisher.
|
purchaseTimeMillis |
string (int64 format)
الوقت الذي تم فيه شراء المنتج، بالمللي ثانية منذ الحقبة (1 كانون الثاني/يناير 1970).
|
purchaseState |
integer
حالة شراء الطلب. القيم المحتملة هي: 0. تم شراء 1. تم الإلغاء 2. في انتظار الموافقة
|
consumptionState |
integer
حالة استهلاك المنتج داخل التطبيق. القيم المحتملة هي: 0. لا يتم استهلاكه بعد 1. تم الاستهلاك
|
developerPayload |
string
سلسلة يحدِّدها المطوِّر وتحتوي على معلومات تكميلية حول طلب
|
orderId |
string
مُعرّف الطلب المرتبط بشراء المنتج داخل التطبيق.
|
purchaseType |
integer
نوع شراء المنتج داخل التطبيق. يتم ضبط هذا الحقل فقط إذا لم يتم إجراء عملية الشراء هذه باستخدام مسار الفوترة العادي داخل التطبيق. القيم المحتملة هي: 0. الاختبار (أي تم شراؤه من حساب اختبار الترخيص) 1- عرض ترويجي (أي تم شراؤه باستخدام رمز ترويجي) ولا يشمل ذلك عمليّات الشراء من برنامج Play Points. 2. إعلان بمكافأة (أي مقابل مشاهدة إعلان فيديو بدلاً من الدفع)
|
acknowledgementState |
integer
حالة الإقرار للمنتج داخل التطبيق القيم المحتملة هي: 0. لا يتم قبول العرض بعد 1. تمت الموافقة
|
purchaseToken |
string
رمز الشراء المميّز الذي تم إنشاؤه لتحديد عملية الشراء هذه قد لا تكون متوفّرة.
|
productId |
string
رمز التخزين التعريفي للمنتج داخل التطبيق قد لا تكون متوفّرة.
|
quantity |
integer
الكمية المرتبطة بشراء المنتج داخل التطبيق وفي حال عدم توفّره، تكون الكمية 1.
|
obfuscatedExternalAccountId |
string
إصدار مشفَّر من رقم التعريف يرتبط بشكلٍ فريد بحساب المستخدم في تطبيقك. لا تظهر هذه المعلومات إلا إذا تم تحديدها باستخدام https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid عند إجراء عملية الشراء.
|
obfuscatedExternalProfileId |
string
إصدار مشفَّر من المعرّف يرتبط بشكل فريد بالملف الشخصي للمستخدم في تطبيقك. لا تظهر هذه المعلومات إلا إذا تم تحديدها باستخدام https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid عند إجراء عملية الشراء.
|
regionCode |
string
رمز منطقة الفوترة ISO 3166-1 alpha-2 للمستخدم في وقت منح المنتج.
|
refundableQuantity |
integer
الكمية المؤهلة لاسترداد الأموال، أي الكمية التي لم يتم ردّها تعرض القيمة عمليات ردّ جزء من الأموال استنادًا إلى الكمية وعمليات ردّ الأموال بالكامل.
|
الطُرق |
|
|
الإقرار بشراء منتج داخل التطبيق |
|
|
عند شراء منتج داخل التطبيق |
|
|
يتيح لك هذا الخيار التحقّق من حالة شراء منتج داخل التطبيق واستهلاكه. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThe \u003ccode\u003eProductPurchase\u003c/code\u003e resource provides information about a user's in-app product purchase, including purchase time, state, and consumption status.\u003c/p\u003e\n"],["\u003cp\u003eIt contains details like the product ID, order ID, purchase token, and quantity, along with developer-specified payload and user account identifiers if provided.\u003c/p\u003e\n"],["\u003cp\u003eYou can use methods like \u003ccode\u003eacknowledge\u003c/code\u003e, \u003ccode\u003econsume\u003c/code\u003e, and \u003ccode\u003eget\u003c/code\u003e to manage the purchase and its state.\u003c/p\u003e\n"],["\u003cp\u003eThe resource includes fields for purchase state (purchased, canceled, pending), consumption state (consumed, not consumed), and acknowledgement state (acknowledged, not acknowledged).\u003c/p\u003e\n"]]],["The `ProductPurchase` resource details a user's in-app product purchase status, represented in JSON format with fields like `purchaseTimeMillis`, `purchaseState`, and `consumptionState`. It includes identifiers such as `orderId`, `purchaseToken`, and `productId`. Key actions involve using the methods `acknowledge` to confirm a purchase, `consume` to mark an item as used, and `get` to check the purchase status. The purchase also indicates quantity, purchase types, and refundable amounts.\n"],null,["# REST Resource: purchases.products\n\n- [Resource: ProductPurchase](#ProductPurchase)\n - [JSON representation](#ProductPurchase.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: ProductPurchase\n-------------------------\n\nA ProductPurchase resource indicates the status of a user's inapp product purchase.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"purchaseTimeMillis\": string, \"purchaseState\": integer, \"consumptionState\": integer, \"developerPayload\": string, \"orderId\": string, \"purchaseType\": integer, \"acknowledgementState\": integer, \"purchaseToken\": string, \"productId\": string, \"quantity\": integer, \"obfuscatedExternalAccountId\": string, \"obfuscatedExternalProfileId\": string, \"regionCode\": string, \"refundableQuantity\": integer } ``` |\n\n| Fields ||\n|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` This kind represents an inappPurchase object in the androidpublisher service. |\n| `purchaseTimeMillis` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). |\n| `purchaseState` | `integer` The purchase state of the order. Possible values are: 0. Purchased 1. Canceled 2. Pending |\n| `consumptionState` | `integer` The consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed |\n| `developerPayload` | `string` A developer-specified string that contains supplemental information about an order. |\n| `orderId` | `string` The order id associated with the purchase of the inapp product. |\n| `purchaseType` | `integer` The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code). Does not include Play Points purchases. 2. Rewarded (i.e. from watching a video ad instead of paying) |\n| `acknowledgementState` | `integer` The acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged |\n| `purchaseToken` | `string` The purchase token generated to identify this purchase. May not be present. |\n| `productId` | `string` The inapp product SKU. May not be present. |\n| `quantity` | `integer` The quantity associated with the purchase of the inapp product. If not present, the quantity is 1. |\n| `obfuscatedExternalAccountId` | `string` An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using \u003chttps://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid\u003e when the purchase was made. |\n| `obfuscatedExternalProfileId` | `string` An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using \u003chttps://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid\u003e when the purchase was made. |\n| `regionCode` | `string` ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted. |\n| `refundableQuantity` | `integer` The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------|--------------------------------------------------------------|\n| ### [acknowledge](/android-publisher/api-ref/rest/v3/purchases.products/acknowledge) | Acknowledges a purchase of an inapp item. |\n| ### [consume](/android-publisher/api-ref/rest/v3/purchases.products/consume) | Consumes a purchase for an inapp item. |\n| ### [get](/android-publisher/api-ref/rest/v3/purchases.products/get) | Checks the purchase and consumption status of an inapp item. |"]]
