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)

सिर्फ़ आउटपुट के लिए. ऑर्डर के लिए टाइमस्टैंप.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. ऑर्डर के लिए पिछली बार अपडेट किया गया टाइमस्टैंप.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

सिर्फ़ आउटपुट के लिए. विज्ञापन देने वाले की जानकारी.

OrderState

ऑर्डर की स्थिति.

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

 मौजूदा ऑर्डर को अपडेट करता है.