Method: purchases.voidedpurchases.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
packageName

string

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

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

פרמטרים
pageSelection.maxResults

integer (uint32 format)

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

integer (uint32 format)

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

string

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

string (int64 format)

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

string (int64 format)

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

integer

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

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

boolean

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

גוף הבקשה

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

גוף התשובה

תגובה ל-API של canceledpurchases.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 שמגדיר אילו תוצאות וכמה תוצאות הפעולה canceledpurchases.list צריכה להחזיר.

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

integer (uint32 format)

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

integer (uint32 format)

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

string

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