Method: purchases.voidedpurchases.list

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

בקשת HTTP

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
packageName

string

שם החבילה של האפליקציה שעבורה צריך לבטל את הרכישות (לדוגמה, 'com.some.thing').

פרמטרים של שאילתה

פרמטרים
pageSelection.maxResults

integer (uint32 format)

מגדיר כמה תוצאות הפעולה של הרשימה צריכה להחזיר. המספר שמוגדר כברירת מחדל תלוי באוסף המשאבים.
pageSelection.startIndex

integer (uint32 format)

מגדיר את האינדקס של הרכיב הראשון שיש להחזיר. אפשר להשתמש באפשרות הזו רק אם הוספת דפים לאינדקס מופעלת.
pageSelection.token

string

הגדרת האסימון של הדף להצגה. האסימון הזה בדרך כלל מגיע מ-TokenPagination. אפשר להשתמש באפשרות הזו רק אם הדפדוף באסימונים מופעל.
startTime

string (int64 format)

הזמן, באלפיות השנייה מאז תחילת התקופה של זמן מערכת, של הרכישה המבוטלת העתיקה ביותר שרוצים לראות בתגובה. הערך של הפרמטר הזה לא יכול להיות ישן יותר מ-30 יום, והוא לא מטופל אם מוגדר אסימון של חלוקה לדפים. ערך ברירת המחדל הוא השעה הנוכחית פחות 30 ימים. הערה: הסינון הזה חל על השעה שבה המערכת שלנו מזהה שהרשומה בוטלה, ולא על השעה בפועל שבה היא בוטלה שמוחזרת בתגובה.
endTime

string (int64 format)

השעה, במיליוניות השנייה מאז תחילת התקופה של זמן המערכת, של הרכישה המבוטלת החדשה ביותר שרוצים לראות בתגובה. הערך של הפרמטר הזה לא יכול להיות גדול מהשעה הנוכחית, והוא לא מטופל אם מוגדר אסימון של חלוקה לדפים. ערך ברירת המחדל הוא השעה הנוכחית. הערה: הסינון הזה מיושם על השעה שבה המערכת שלנו מזהה שהרשומה בוטלה, ולא על השעה בפועל שבה היא בוטלה שמוחזרת בתגובה.
type

integer

סוג הרכישות שבוטלו שרוצים לראות בתגובה. הערכים האפשריים הם: 0. בתגובה יוחזרו רק רכישות של מוצרים מתוך האפליקציה שבוטלו. זהו ערך ברירת המחדל. 1. התגובה תכלול גם רכישות מתוך האפליקציה וגם מינויים שבוטלו.

הערה: לפני שמבקשים לקבל נתונים על רכישות של מינויים שבוטלו, צריך להתחיל להשתמש ב-orderId בתגובה, שמזהה באופן ייחודי מינויים ורכישות חד-פעמיות. אחרת, תקבלו כמה הזמנות של מינויים עם אותו PurchaseToken, כי להזמנות של חידוש מינויים יש את אותו PurchaseToken.
includeQuantityBasedPartialRefund

boolean

זה שינוי אופציונלי. האם לכלול רכישות שבוטלו של החזרים כספיים חלקיים שמבוססים על כמות, שחלים רק על רכישות בכמות גדולה. אם הערך הוא true, יכול להיות שיוחזר דיווח על רכישות נוספות שבוטלו עם הערך voidedQuantity שמציין את כמות ההחזר הכספי של החזר כספי חלקי שמבוסס על כמות. ערך ברירת המחדל הוא false.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תגובה של ממשק ה-API voidedpurchases.list.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
שדות
pageInfo

object (PageInfo)

מידע כללי על חלוקה לדפים.
tokenPagination

object (TokenPagination)

פרטי חלוקה לדפים של חלוקת הטוקנים לדפים.
voidedPurchases[]

object (VoidedPurchase)

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/androidpublisher

PageSelection

הסוג של פרמטר הבקשה pageSelection שמגדיר אילו תוצאות וכמה תוצאות הפונקציה voidedpurchases.list צריכה להחזיר.

ייצוג ב-JSON 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
שדות
maxResults

integer (uint32 format)

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

integer (uint32 format)

מגדיר את האינדקס של הרכיב הראשון שיש להחזיר. אפשר להשתמש באפשרות הזו רק אם הוספת דפים לאינדקס מופעלת.
token

string

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