REST Resource: purchases.productsv2

משאב: ProductPurchaseV2

המשאב ProductPurchaseV2 מציין את הסטטוס של רכישת מוצר מתוך האפליקציה על ידי משתמש.

ייצוג ב-JSON
{
  "productLineItem": [
    {
      object (ProductLineItem)
    }
  ],
  "kind": string,
  "purchaseStateContext": {
    object (PurchaseStateContext)
  },
  "testPurchaseContext": {
    object (TestPurchaseContext)
  },
  "orderId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string,
  "regionCode": string,
  "purchaseCompletionTime": string,
  "acknowledgementState": enum (AcknowledgementState)
}
שדות
productLineItem[]

object (ProductLineItem)

מכיל מידע ברמת הפריט של ProductPurchaseV2.

kind

string

הסוג הזה מייצג אובייקט ProductPurchaseV2 בשירות androidpublisher.

purchaseStateContext

object (PurchaseStateContext)

מידע על מצב הרכישה.

testPurchaseContext

object (TestPurchaseContext)

מידע שקשור לרכישות לצורך בדיקה. האפשרות הזו תוגדר רק לרכישות לצורך בדיקה.

orderId

string

מזהה ההזמנה שמשויך לרכישה של המוצר באפליקציה. לא ניתן להגדיר את השדה אם אין הזמנה שמשויכת לרכישה.

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, בזמן שהמוצר הוענק.

purchaseCompletionTime

string (Timestamp format)

המועד שבו הרכישה בוצעה בהצלחה, כלומר המועד שבו הסטטוס PurchaseState השתנה ל-PURCHASED. השדה הזה יופיע רק אחרי שהתשלום יושלם. לדוגמה, אם המשתמש ביצע עסקה בהמתנה (https://developer.android.com/google/play/billing/integrate#pending), השדה הזה לא יאוכלס עד שהמשתמש ישלים את השלבים הנדרשים להשלמת העסקה.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

acknowledgementState

enum (AcknowledgementState)

פלט בלבד. מצב האישור של הרכישה.

PurchaseStateContext

הקשר לגבי מצב הרכישה.

ייצוג ב-JSON
{
  "purchaseState": enum (PurchaseState)
}
שדות
purchaseState

enum (PurchaseState)

פלט בלבד. סטטוס הרכישה.

PurchaseState

מצבי הרכישה האפשריים.

טיפוסים בני מנייה (enum)
PURCHASE_STATE_UNSPECIFIED מצב הרכישה לא צוין. אף פעם לא צריך להגדיר את הערך הזה.
PURCHASED הרכישה בוצעה בהצלחה.
CANCELLED הרכישה בוטלה.
PENDING הרכישה נמצאת במצב המתנה ועדיין לא הושלמה. מידע נוסף על טיפול ברכישות בהמתנה זמין בכתובת https://developer.android.com/google/play/billing/integrate#pending.

TestPurchaseContext

הקשר של רכישת ניסיון.

ייצוג ב-JSON
{
  "fopType": enum (FopType)
}
שדות
fopType

enum (FopType)

סוג ה-fop של רכישת הבדיקה.

FopType

סוגי fop אפשריים.

טיפוסים בני מנייה (enum)
FOP_TYPE_UNSPECIFIED לא צוין סוג ה-FOP. אף פעם לא צריך להגדיר את הערך הזה.
TEST הרכישה בוצעה באמצעות כרטיס בדיקה.

ProductLineItem

מכיל מידע ברמת הפריט של ProductPurchaseV2.

ייצוג ב-JSON
{
  "productId": string,
  "productOfferDetails": {
    object (ProductOfferDetails)
  }
}
שדות
productId

string

מזהה המוצר שנרכש (לדוגמה, 'monthly001').

productOfferDetails

object (ProductOfferDetails)

פרטי המבצע של הפריט הזה.

ProductOfferDetails

פרטי המבצע שקשורים לפריט רכישה.

ייצוג ב-JSON
{
  "offerTags": [
    string
  ],
  "offerId": string,
  "purchaseOptionId": string,
  "rentOfferDetails": {
    object (RentOfferDetails)
  },
  "offerToken": string,
  "quantity": integer,
  "refundableQuantity": integer,
  "consumptionState": enum (ConsumptionState)
}
שדות
offerTags[]

string

תגי המבצע העדכניים ביותר שמשויכים למבצע. הוא כולל תגים שעברו בירושה מאפשרות הרכישה.

offerId

string

מזהה המבצע. מופיע רק במבצעים.

purchaseOptionId

string

המזהה של אפשרות הרכישה.

rentOfferDetails

object (RentOfferDetails)

פרטים על מבצעי השכרה. האפשרות הזו תוגדר רק לפריטי אירוח.

offerToken

string

אסימון המבצע לכל עסקה ששימש לביצוע פריט הרכישה הזה.

quantity

integer

הכמות שמשויכת לרכישה של המוצר באפליקציה.

refundableQuantity

integer

הכמות שעומדת בדרישות לקבלת החזר כספי, כלומר הכמות שלא קיבלה החזר כספי. הערך משקף החזרים כספיים חלקיים שמבוססים על כמות והחזרים כספיים מלאים.

consumptionState

enum (ConsumptionState)

פלט בלבד. מצב הצריכה של הרכישה.

RentOfferDetails

אין שדות לסוג הזה.

פרטי המבצע שקשורים לפריט השכרה.

ConsumptionState

מצבי הצריכה האפשריים.

טיפוסים בני מנייה (enum)
CONSUMPTION_STATE_UNSPECIFIED לא צוין מצב הצריכה. אף פעם לא צריך להגדיר את הערך הזה.
CONSUMPTION_STATE_YET_TO_BE_CONSUMED עדיין לא נצרכו.
CONSUMPTION_STATE_CONSUMED כבר נוצלו.

AcknowledgementState

סטטוס האישור של המוצר בחיוב חד-פעמי.

טיפוסים בני מנייה (enum)
ACKNOWLEDGEMENT_STATE_UNSPECIFIED מצב אישור לא צוין.
ACKNOWLEDGEMENT_STATE_PENDING הרכישה עדיין לא אושרה.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED הרכישה אושרה.

Methods

getproductpurchasev2

בדיקת סטטוס הרכישה והצריכה של פריט בתוך האפליקציה.