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 )

فقط خروجی اطلاعات آگهی دهنده

Order State

وضعیت دستور.

Enums
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

 یک سفارش موجود را به روز می کند.