REST Resource: orders

משאב: הזמנה

מקור המידע Order כולל מידע מקיף על עסקה שבוצעה ב-Google Play. הוא כולל מגוון מאפיינים שמספקים פרטים על ההזמנה עצמה, על המוצרים שנרכשו ועל היסטוריית האירועים שקשורים להזמנה.

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

הנה כמה תרחישי שימוש ב-API הזה:

  • אחזור נתוני הזמנות בזמן אמת – אפשר לאחזר פרטים ומטא-נתונים של הזמנות מיד אחרי הרכישה באמצעות מזהה הזמנה.

  • סנכרון עדכוני הזמנות – סנכרון תקופתי של עדכוני הזמנות כדי לשמור על רשומה עדכנית של פרטי ההזמנות.

הערה:

  • הקריאות ל-Orders API נספרות במכסה שלכם ב-Play Developer API, שהיא 200, 000 ביום כברירת מחדל. יכול להיות שהמכסה הזו לא תספיק לכם לסנכרון של היסטוריית הזמנות נרחבת.

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

ייצוג ב-JSON 
{   "lineItems": [     {       object (LineItem)     }   ],   "orderId": string,   "purchaseToken": string,   "state": enum (State),   "createTime": string,   "lastEventTime": string,   "buyerAddress": {     object (BuyerAddress)   },   "total": {     object (Money)   },   "tax": {     object (Money)   },   "orderDetails": {     object (OrderDetails)   },   "orderHistory": {     object (OrderHistory)   },   "developerRevenueInBuyerCurrency": {     object (Money)   },   "pointsDetails": {     object (PointsDetails)   } }
שדות
lineItems[]

object (LineItem)

הפריטים הנפרדים שמרכיבים את ההזמנה הזו.
orderId

string

מזהה ההזמנה.
purchaseToken

string

הטוקן שסופק למכשיר של המשתמש כשנרכש המינוי או הפריט.
state

enum (State)

המצב של ההזמנה.
createTime

string (Timestamp format)

המועד שבו ההזמנה נוצרה.

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

string (Timestamp format)

השעה של האירוע האחרון שהתרחש בהזמנה.

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

object (BuyerAddress)

פרטי הכתובת של הלקוח, לשימוש בחישוב מס. כש-Google היא המוכר הרשום של ההזמנה, מוצגת רק המדינה.
total

object (Money)

הסכום הסופי שמשלם הלקוח, כולל הנחות ומיסים.
tax

object (Money)

המס הכולל ששולם כחלק מההזמנה הזו.
orderDetails

object (OrderDetails)

מידע מפורט על ההזמנה בזמן היצירה.
orderHistory

object (OrderHistory)

פרטים על אירועים ששינו את ההזמנה.
developerRevenueInBuyerCurrency

object (Money)

ההכנסה שלך מההזמנה הזו במטבע של הקונה, כולל ניכויים של החזרים כספיים חלקיים, מיסים ועמלות. ‫Google מנכה מכל מכירה עמלות סטנדרטיות על עסקאות ותשלומים לצדדים שלישיים, כולל מע"מ באזורים מסוימים.
pointsDetails

object (PointsDetails)

נקודות Play שמומשו בהזמנה, כולל פרטי המבצע, שיעור ההנחה וערכי הנקודות.

מדינה

המצב של ההזמנה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין מצב. הערך הזה לא נמצא בשימוש.
PENDING ההזמנה נוצרה והיא ממתינה לעיבוד.
PROCESSED ההזמנה עובדה בהצלחה.
CANCELED ההזמנה בוטלה לפני העיבוד.
PENDING_REFUND הבקשה להחזר כספי נמצאת בהמתנה לעיבוד.
PARTIALLY_REFUNDED בוצע החזר כספי על חלק מסכום ההזמנה.
REFUNDED הסכום המלא של ההזמנה הוחזר.

BuyerAddress

פרטי הכתובת של הלקוח, לשימוש בחישוב מס.

ייצוג ב-JSON 
{   "buyerState": string,   "buyerCountry": string,   "buyerPostcode": string }
שדות
buyerState

string

חלוקה מנהלית ברמה העליונה של המדינה שמופיעה בכתובת של הקונה. אם Google היא המוכרת הרשמית של ההזמנה, המידע הזה לא נכלל.
buyerCountry

string

קוד מדינה בן שתי אותיות לפי תקן ISO-3166-1 Alpha-2 (קודי מדינה של האו"ם).
buyerPostcode

string

המיקוד של הכתובת. אם Google היא המוכרת הרשמית של ההזמנה, המידע הזה לא נכלל.

OrderDetails

מידע מפורט על ההזמנה בזמן היצירה.

ייצוג ב-JSON 
{   "taxInclusive": boolean }
שדות
taxInclusive

boolean

השדה מציין אם המחיר שמופיע כולל מס או לא.

LineItem

פרטים של פריט.

ייצוג ב-JSON 
{   "productTitle": string,   "productId": string,   "listingPrice": {     object (Money)   },   "total": {     object (Money)   },   "tax": {     object (Money)   },    // Union field details can be only one of the following:   "oneTimePurchaseDetails": {     object (OneTimePurchaseDetails)   },   "subscriptionDetails": {     object (SubscriptionDetails)   },   "paidAppDetails": {     object (PaidAppDetails)   }   // End of list of possible types for union field details. }
שדות
productTitle

string

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

string

מזהה המוצר שנרכש או המק"ט של המוצר באפליקציה (לדוגמה, monthly001 או com.some.thing.inapp1).
listingPrice

object (Money)

המחיר שבו הפריט מוצע בחנות Play. יכול להיות שהמחיר כולל מס או לא. לא כולל הנחות או מבצעים.
total

object (Money)

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

object (Money)

המס ששולם על הפריט הזה.

שדה איחוד details.

הערך details יכול להיות רק אחד מהערכים הבאים:
oneTimePurchaseDetails

object (OneTimePurchaseDetails)

פרטים על רכישה חד-פעמית.
subscriptionDetails

object (SubscriptionDetails)

פרטים על רכישת מינוי.
paidAppDetails

object (PaidAppDetails)

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

OneTimePurchaseDetails

פרטים על רכישה חד-פעמית.

ייצוג ב-JSON 
{   "quantity": integer,   "offerId": string,   "purchaseOptionId": string,   "rentalDetails": {     object (RentalDetails)   } }
שדות
quantity

integer

מספר הפריטים שנרכשו (ברכישות של פריטים בכמות גדולה).
offerId

string

מזהה המבצע של מבצע הרכישה החד-פעמית.
purchaseOptionId

string

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

object (RentalDetails)

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

RentalDetails

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

פרטים על רכישת השכרה.

SubscriptionDetails

פרטים על רכישת מינוי.

ייצוג ב-JSON 
{   "basePlanId": string,   "offerId": string,   "offerPhase": enum (OfferPhase),   "servicePeriodStartTime": string,   "servicePeriodEndTime": string }
שדות
basePlanId

string

מזהה המינוי הבסיסי.
offerId

string

מזהה המבצע של המבצע הנוכחי על המינוי.
offerPhase

enum (OfferPhase)

שלב התמחור לתקופת החיוב שממומנת על ידי ההזמנה הזו.
servicePeriodStartTime

string (Timestamp format)

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

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

string (Timestamp format)

סיום תקופת החיוב שממומנת על ידי ההזמנה הזו. זו תמונת מצב של שעת הסיום של תקופת החיוב או השירות בזמן עיבוד ההזמנה, והיא צריכה לשמש רק לצורכי הנהלת חשבונות. כדי לקבל את שעת הסיום הנוכחית של תקופת המינוי לשירות, משתמשים בשיטה purchases.subscriptionsv2.get.

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

OfferPhase

שלב התמחור לתקופת הזכאות שמומנה על ידי ההזמנה הזו.

טיפוסים בני מנייה (enum)
OFFER_PHASE_UNSPECIFIED לא צוין שלב במבצע. הערך הזה לא נמצא בשימוש.
BASE ההזמנה מממנת תקופה במחיר בסיסי.
INTRODUCTORY ההזמנה מממנת תקופת מחיר היכרות.
FREE_TRIAL ההזמנה מממנת תקופת ניסיון בחינם.

PaidAppDetails

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

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

OrderHistory

פרטים על אירועים ששינו את ההזמנה.

ייצוג ב-JSON 
{   "partialRefundEvents": [     {       object (PartialRefundEvent)     }   ],   "processedEvent": {     object (ProcessedEvent)   },   "cancellationEvent": {     object (CancellationEvent)   },   "refundEvent": {     object (RefundEvent)   } }
שדות
partialRefundEvents[]

object (PartialRefundEvent)

פרטים של אירועי החזר כספי חלקי בהזמנה הזו.
processedEvent

object (ProcessedEvent)

פרטים על המועד שבו ההזמנה עובדה.
cancellationEvent

object (CancellationEvent)

פרטים על המועד שבו ההזמנה בוטלה.
refundEvent

object (RefundEvent)

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

ProcessedEvent

פרטים על המועד שבו ההזמנה עובדה.

ייצוג ב-JSON 
{   "eventTime": string }
שדות
eventTime

string (Timestamp format)

המועד שבו ההזמנה עובדה.

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

CancellationEvent

פרטים על המועד שבו ההזמנה בוטלה.

ייצוג ב-JSON 
{   "eventTime": string }
שדות
eventTime

string (Timestamp format)

המועד שבו ההזמנה בוטלה.

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

RefundEvent

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

ייצוג ב-JSON 
{   "eventTime": string,   "refundDetails": {     object (RefundDetails)   },   "refundReason": enum (RefundReason) }
שדות
eventTime

string (Timestamp format)

המועד שבו בוצע החזר כספי מלא על ההזמנה.

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

object (RefundDetails)

פרטים לגבי ההחזר הכספי המלא.
refundReason

enum (RefundReason)

הסיבה להחזר הכספי על ההזמנה.

RefundDetails

פרטים לגבי החזר כספי חלקי או מלא.

ייצוג ב-JSON 
{   "total": {     object (Money)   },   "tax": {     object (Money)   } }
שדות
total

object (Money)

הסכום הכולל שניתן בהחזר כספי, כולל מס.
tax

object (Money)

סכום המס שהוחזר.

RefundReason

הסיבה להחזר הכספי על ההזמנה.

טיפוסים בני מנייה (enum)
REFUND_REASON_UNSPECIFIED orders.refund reason unspecified. הערך הזה לא נמצא בשימוש.
OTHER בוצע החזר כספי על ההזמנה מסיבה אחרת שלא מופיעה כאן.
CHARGEBACK ההזמנה חויבה מחדש.

PartialRefundEvent

פרטים של אירועי החזר כספי חלקיים בהזמנה הזו.

ייצוג ב-JSON 
{   "createTime": string,   "processTime": string,   "state": enum (State),   "refundDetails": {     object (RefundDetails)   } }
שדות
createTime

string (Timestamp format)

השעה שבה נוצר ההחזר הכספי החלקי.

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

string (Timestamp format)

השעה שבה בוצע העיבוד של ההחזר הכספי החלקי.

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

enum (State)

המצב של ההחזר הכספי החלקי.
refundDetails

object (RefundDetails)

פרטים על ההחזר הכספי החלקי.

מדינה

המצב של ההחזר הכספי החלקי.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין מצב. הערך הזה לא נמצא בשימוש.
PENDING ההחזר הכספי החלקי נוצר, אבל עדיין לא עבר עיבוד.
PROCESSED_SUCCESSFULLY ההחזר הכספי החלקי בוצע בהצלחה.

PointsDetails

פרטים שקשורים לנקודות Play שמומשו בהזמנה.

ייצוג ב-JSON 
{   "pointsOfferId": string,   "pointsCouponValue": {     object (Money)   },   "pointsDiscountRateMicros": string,   "pointsSpent": string }
שדות
pointsOfferId

string

מזהה ייחודי למבצע של נקודות Play שבו נעשה שימוש בהזמנה הזו.
pointsCouponValue

object (Money)

הערך הכספי של שובר של נקודות Play. זו ההנחה שניתנת בשובר, ויכול להיות שהיא לא הסכום הכולל. הערך מוגדר רק כשמשתמשים בשוברים של נקודות Play. לדוגמה, אם שובר של 100 נקודות שווה 2$, הערך הזה יהיה 2$.
pointsDiscountRateMicros

string (int64 format)

שיעור ההנחה שניתנת במסגרת המבצע לצבירת Play Points. לדוגמה, אם שובר של 100 נקודות שווה ל-2$, הערך הוא 500,000. הערך של 2 $הוא 200 נקודות, אבל מספר הנקודות בפועל שנדרש הוא 100, כלומר 50% מהערך הזה. 50% במיקרו הם 500,000. בין 0 ל-1,000,000.
pointsSpent

string (int64 format)

מספר נקודות Play שמומשו בהזמנה הזו. לדוגמה, אם שובר של 100 נקודות שווה ל-2$, הערך הוא 100. אם השובר מצורף למבצע בסיסי, זהו סך הנקודות שהוצאו על שניהם.

Methods

batchget

 קבלת פרטי הזמנה לרשימה של הזמנות.

get

 קבלת פרטי הזמנה של הזמנה יחידה.

refund

 החזר כספי למשתמש על הזמנה של מינוי או רכישה מתוך האפליקציה.