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 الذي يتم إعداده من هذا الخط. التنسيق = منتجات/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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

endTime
(deprecated)

string (Timestamp format)

النتائج فقط. الوقت الذي سيتوقف فيه عرض السطر (غير شامل).

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

reservationExpirationTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لانتهاء صلاحية الحجز. يحتاج المشتري إلى إجراء الحجز قبل انتهاء صلاحية الحجز وإلا سيتم اعتباره مُلغى.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

targeting

object (Targeting)

النتائج فقط. استهداف السطر.

createTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لإنشاء السطر

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

النتائج فقط. آخر تعديل للطابع الزمني للسطر

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

LineState

حالة الخط.

عمليات التعداد
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

حجز سطر حالي.