REST Resource: availabilityOrders

משאב: AvailabilityOrder

הזמנת זמינות היא אוסף של AvailabilityLines. הקונה יוצר את הזמנת הזמינות. אתר המכירה מעדכן את סטטוס הזמינות בהתאם לתגובה.

תהליך העבודה הוא:

  • הקונה יוצר הזמנת זמינות ושורות זמינות ומגדיר את המצב כ'בהמתנה'. אסור לבצע שינויים נוספים בהזמנה או בשורה של הקונה.
  • בית העסק פועל בכל קווי הזמינות על ידי השלמת תנאי הזמינות או סימון כ'נדחה'. אפשר לבצע פעולות של השלמת או דחייה רק כשההזמנה והשורות בהמתנה.
  • בית העסק משתמש בפעולה מותאמת אישית אחת (complete) כדי לסמן שבקשת הזמינות נשלחה. אי אפשר לבצע שינויים נוספים בהזמנת הזמינות או בשורות הצאצא אחרי השלמת התהליך.
ייצוג JSON 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "pendingExpirationTime": string,
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
שדות
name

string

פלט בלבד. שם המשאב של הזמנת הזמינות, בפורמט: availabilityOrders/{id}.
description

string

פלט בלבד. שדה נוסף בפורמט חופשי לתיאור הזמנת הזמינות.
state

enum (State)

פלט בלבד. המצב של הזמנת הזמינות הזו. בדף AvailabilityOrder.State אפשר לראות את מחזור החיים של AvailabilityOrder.

בית העסק יכול להשתמש בשיטה המותאמת אישית Complete כדי להגדיר את STATE_COMPLETED.
pendingExpirationTime

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

פלט בלבד. פרטי המפרסם.

מדינה

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

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל כאשר מצב הזמנת הזמינות לא צוין או שאינו ידוע בגרסה הזו.
STATE_PENDING הזמינות בהמתנה כשהקונה סיפק את ההגדרות של בקשת הזמינות.
STATE_COMPLETED מצב הזמינות הושלם כשבית העסק סיפק את תגובת הזמינות לכל השורות.
STATE_CANCELLED מצב הזמינות בוטל כאשר הקונה שלח את בקשת הביטול לפני שבית העסק סיפק את תגובת הזמינות לכל השורות.
STATE_EXPIRED מצב זמינות שפג תוקפו כאשר פג תוקף ההזמנה לפני שבית העסק השלים אותה.

שיטות

complete

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

get

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

list

 בתיבת הדו שיח הזו רשומים הזמנות הזמינות.