REST Resource: orders.lines

משאב: קו

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

ייצוג JSON 
{
  "name": string,
  "product": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "lineState": enum (LineState),
  "rejection": {
    object (Rejection)
  },
  "startTime": string,
  "endTime": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "lineTerms": {
    object (LineTerms)
  },
  "pendingReservationExpirationTime": string,
  "reservationExpirationTime": string,
  "targeting": {
    object (Targeting)
  },
  "createTime": string,
  "updateTime": string
}
שדות
name

string

פלט בלבד. שם משאב השורה בפורמט: orders/{order_id}/lines/{id}.
product

string

פלט בלבד. השם של Product הקו הזה מגדיר. פורמט = products/123
externalId

string

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

string

פלט בלבד. השם המוצג של הקו.
description

string

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

enum (LineState)

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

בית העסק יכול להשתמש בשיטות המותאמות אישית הבאות: Reserve, Book ו-Reject כדי להגדיר אחת מהאפשרויות הבאות:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

כל שאר מצבי השורה מוגדרים על ידי הקונה.
rejection

object (Rejection)

זה שינוי אופציונלי. פרטי הדחייה של הקו.
startTime
(deprecated)

string (Timestamp format)

פלט בלבד. מתי הקו יוצג (כולל).

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

string (Timestamp format)

פלט בלבד. מתי תיפסק הצגת הקו (לא כולל).

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

object (Date)

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

object (Date)

פלט בלבד. התאריך שבו תופסק הצגת הקו (כולל). אזור זמן זהה לזה של יחידת המודעות.
budget

object (Money)

פלט בלבד. התקציב של הקו.
lineTerms

object (LineTerms)

פלט בלבד. התנאים המובטחים של המפיץ בשורה הזו.
pendingReservationExpirationTime

string (Timestamp format)

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

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

string (Timestamp format)

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

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

object (Targeting)

פלט בלבד. הטירגוט של הקו.
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".

LineState

מצב של קו.

טיפוסים בני מנייה (enum)
LINE_STATE_UNSPECIFIED ערך ברירת המחדל כאשר מצב השורה לא צוין או שאינו ידוע בגרסה הזו.
LINE_STATE_PENDING_RESERVATION הקונה יצר את השורה והיא מבקשת את המוצרים להזמין אותם ולעדכן אותם בפרטים לגבי המחיר והזמינות.
LINE_STATE_RESERVED המפיץ שריין את השורה. המצב הזה אפשרי רק אם המדינה הקודמת ממתינה להזמנה.
LINE_STATE_PENDING_BOOKING הקונה אישר את ההזמנה ומבקש להזמין את התור.
LINE_STATE_BOOKED המוכר הזמין את התור. האפשרות הזו זמינה רק אם המדינה הקודמת ממתינה להזמנה. בשלב הזה, לא צפויות דחיות.
LINE_STATE_REJECTED_BY_SELLER השורה נדחתה על ידי בית העסק. המצב הזה אפשרי רק אם המדינה הקודמת ממתינה להזמנה.
LINE_STATE_CANCELLED_BY_BUYER הקונה ביטל את השורה.
LINE_STATE_PENDING_RESERVATION_EXPIRED התוקף של השורה פג בזמן ההמתנה להזמנה.
LINE_STATE_RESERVED_EXPIRED תוקף השורה פג בזמן שמור, בהמתנה לתגובת הקונה.

שיטות

book

 הזמנת שורה קיימת.

get

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

list

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

patch

 עדכון של שורה קיימת.

reject

 דחיית קו קיים.

reserve

 שומר קו קיים.