REST Resource: orders

משאב: הזמנה

הזמנה היא אוסף של Lines שמציין מתי ואיפה להציג מודעות.

ייצוג JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
שדות
name

string

פלט בלבד. שם משאב ההזמנה, בפורמט הבא: Orders/{id}`.
externalId

string

זה שינוי אופציונלי. מזהה שמשמש למיפוי הישות הזו למקורות חיצוניים.
displayName

string

פלט בלבד. השם המוצג של ההזמנה.

חייב להיות בקידוד UTF-8 ובגודל מקסימלי של 240 בייטים.
description

string

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

enum (OrderState)

פלט בלבד. מייצג את המצב המחושב של הצו על סמך מצב הקווים שלו.
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)

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

OrderState

מצב הצו.

טיפוסים בני מנייה (enum)
ORDER_STATE_UNSPECIFIED ערך ברירת המחדל כאשר מצב ההזמנה לא צוין או שאינו ידוע בגרסה הזו.
ORDER_STATE_PENDING_RESERVATION

ההזמנה כוללת:

  • שורה אחת או יותר במצב הזמנה בהמתנה.
  • אפס שורות או יותר במצב שמור.
  • בכל שאר המדינות, ללא שורות בכלל.
ORDER_STATE_RESERVED

ההזמנה כוללת:

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

ההזמנה כוללת:

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

ההזמנה כוללת:

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

ההזמנה כוללת:

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

ההזמנה כוללת:

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

ההזמנה כוללת:

  • פג התוקף של שורה אחת או יותר בהזמנה בהמתנה.
  • בכל שאר המדינות, ללא שורות בכלל.
ORDER_STATE_RESERVED_EXPIRED

ההזמנה כוללת:

  • פג התוקף של שורה אחת או יותר בשירותים השמורים.
  • בכל שאר המדינות, ללא שורות בכלל.

שיטות

get

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

list

 מציגה הזמנות.

patch

 עדכון הזמנה קיימת.