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
גרסה עם ערפול קוד (obfuscated) של המזהה שמשויכת באופן ייחודי לחשבון המשתמש באפליקציה שלכם. מוצג רק אם צוין באמצעות 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 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\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. |"]]
