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 برای چرخه حیات یک Line ببینید.

فروشنده می‌تواند از روش‌های سفارشی زیر استفاده کند: 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

حالت یک خط

Enums
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

 یک خط موجود را رزرو می کند.