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

تُحدِّد الرمز المميّز للصفحة المُراد عرضها، ويكون عادةً مأخوذًا من TokenPagination. لا يمكن استخدام هذا الإجراء إلا إذا كان تقسيم الرموز المميّزة مفعّلاً.
startTime

string (int64 format)

الوقت، بالمللي ثانية منذ بداية الحقبة، لأقدم عملية شراء تم إلغاؤها تريد الاطّلاع عليها في الردّ. لا يمكن أن تكون قيمة هذه المَعلمة أقدم من 30 يومًا، ويتم تجاهلها في حال ضبط رمز مميّز لصفحة الفهرسة. القيمة التلقائية هي الوقت الحالي مطروحًا منه 30 يومًا. ملاحظة: يتم تطبيق هذا الفلتر على الوقت الذي ترى فيه أنظمتنا أنّ السجلّ مُلغى، وليس الوقت الفعلي الذي تم فيه إلغاء السجلّ والمعروض في الاستجابة.
endTime

string (int64 format)

الوقت، بالمللي ثانية منذ بداية الحقبة، لأحدث عملية شراء تم إلغاؤها تريد الاطّلاع عليها في الردّ. لا يمكن أن تكون قيمة هذه المَعلمة أكبر من الوقت الحالي ويتم تجاهلها في حال ضبط رمز مميّز لصفحة الفهرسة. القيمة التلقائية هي الوقت الحالي. ملاحظة: يتم تطبيق هذا الفلتر على الوقت الذي ترى فيه أنظمتنا أنّ السجلّ مُلغى، وليس الوقت الفعلي الذي تم فيه إلغاء السجلّ والمعروض في الاستجابة.
type

integer

نوع عمليات الشراء المُلغاة التي تريد الاطّلاع عليها في الردّ القيم المحتمَلة هي: 0. لن يتم عرض سوى عمليات شراء المنتجات داخل التطبيق التي تم إلغاؤها في الاستجابة. هذه هي القيمة الافتراضية. 1. سيتم عرض كلّ من عمليات الشراء المُلغاة داخل التطبيق وعمليات شراء الاشتراكات المُلغاة في الاستجابة.

ملاحظة: قبل طلب استلام عمليات شراء الاشتراكات المُلغاة، يجب التبديل إلى استخدام orderId في الاستجابة التي تحدّد بشكل فريد عمليات الشراء والاشتراكات لمرة واحدة. بخلاف ذلك، ستتلقّى طلبات اشتراك متعددة باستخدام رمز PurchaseToken نفسه، لأنّ طلبات تجديد الاشتراك تتشارك رمز PurchaseToken نفسه.
includeQuantityBasedPartialRefund

boolean

اختياريّ. ما إذا كان سيتم تضمين عمليات الشراء الملغاة التي تم ردّ جزء من الأموال المدفوعة فيها استنادًا إلى الكمية، والتي لا تنطبق إلا على عمليات الشراء بكميات متعدّدة. إذا كانت القيمة صحيحة، يمكن إرجاع عمليات شراء ملغاة إضافية باستخدام قيمة voidedQuantity التي تشير إلى كمية الأموال التي تم ردّها في عملية ردّ جزء من الأموال استنادًا إلى الكمية. القيمة التلقائية هي false.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

استجابة واجهة برمجة التطبيقات voidedpurchases.list

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
الحقول
pageInfo

object (PageInfo)

معلومات عامة عن تقسيم الصفحات
tokenPagination

object (TokenPagination)

معلومات تقسيم الصفحات لقسمة الرموز المميّزة
voidedPurchases[]

object (VoidedPurchase)

عيّنة

في ما يلي مثال على طلب:

curl -X GET \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.some.thing/purchases/voidedpurchases?endTime=1678886400000&includeQuantityBasedPartialRefund=true&maxResults=10&startIndex=0&startTime=1676208000000&token=SAMPLE_PAGINATION_TOKEN&type=1'

في ما يلي مثال على ردّ:

{
  "pageInfo": {
    "resultPerPage": 10,
    "startIndex": 0,
    "totalResults": 25
  },
  "tokenPagination": {
    "nextPageToken": "c3RhdGVfZm9yX3BhZ2VfMg==",
    "previousPageToken": null
  },
  "voidedPurchases": [
    {
      "kind": "androidpublisher#voidedPurchase",
      "orderId": "GPA.3315-1234-5678-90123",
      "purchaseTimeMillis": "1678886400000",
      "purchaseToken": "aebkhenchpfeidbefgkcjmfi.AO-J1OykGjJh9r_V7_v0kI6bA4v88e5c44f4e0c4b4a8e0e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z",
      "voidedQuantity": 1,
      "voidedReason": 1,
      "voidedSource": 0,
      "voidedTimeMillis": "1678972800000"
    },
    {
      "kind": "androidpublisher#voidedPurchase",
      "orderId": "GPA.3377-9876-5432-10987.0",
      "purchaseTimeMillis": "1678713600000",
      "purchaseToken": "fkgdjdmfgmcmflekdgmdncj.AO-J1OyU6sXvB9LqRt3jD2wZ_pE8gXyF5hT3mN1zK0aP7bV4qL9cO6iR2sD0kM7oU1bL8jI3sF5tY9vU4wO1eP2g",
      "voidedQuantity": 1,
      "voidedReason": 7,
      "voidedSource": 2,
      "voidedTimeMillis": "1678800000000"
    }
  ]
}

نطاقات التفويض

يجب توفير نطاق 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. ولا يمكن استخدام هذا الإجراء إلّا إذا كان خيار تقسيم الرموز المميّزة مفعّلاً.