REST Resource: guaranteedOrders

संसाधन: GuaranteedOrder

ऑर्डर की गारंटी.

गारंटी वाले ऑर्डर, गारंटी वाले इन्वेंट्री सोर्स की पैरंट इकाई होते हैं. गारंटी वाला इन्वेंट्री सोर्स बनाते समय, इन्वेंट्री सोर्स को 'किराया रिफ़ंड की गारंटी' वाला ऑर्डर आईडी असाइन करना ज़रूरी है.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. गारंटी वाले ऑर्डर का संसाधन नाम.
legacyGuaranteedOrderId

string

सिर्फ़ आउटपुट के लिए. गारंटी वाले ऑर्डर का लेगसी आईडी. इसे ओरिजनल एक्सचेंज की ओर से असाइन किया जाता है. किसी एक एक्सचेंज में लेगसी आईडी यूनीक होता है. हालांकि, यह ज़रूरी नहीं है कि यह गारंटी वाले सभी ऑर्डर के लिए यूनीक हो. इस आईडी का इस्तेमाल एसडीएफ़ और यूज़र इंटरफ़ेस (यूआई) में किया जाता है.
exchange

enum (Exchange)

ज़रूरी है. इम्यूटेबल. वह एक्सचेंज जहां गारंटी वाला ऑर्डर शुरू हुआ.
guaranteedOrderId

string

सिर्फ़ आउटपुट के लिए. गारंटी वाले ऑर्डर का यूनीक आइडेंटिफ़ायर. गारंटी वाले ऑर्डर आईडी का फ़ॉर्मैट {exchange}-{legacyGuaranteedOrderId} होता है.
displayName

string

ज़रूरी है. गारंटी वाले ऑर्डर का डिसप्ले नेम.

इसे UTF-8 कोड में बदला गया होना चाहिए. साथ ही, इसका साइज़ 240 बाइट से ज़्यादा नहीं होना चाहिए.
status

object (GuaranteedOrderStatus)

गारंटी वाले ऑर्डर की स्थिति की सेटिंग.
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब गारंटी वाले ऑर्डर को आखिरी बार अपडेट किया गया था. सिस्टम ने असाइन किया है.

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

string

ज़रूरी है. गारंटी वाले ऑर्डर के पब्लिशर का नाम.

इसे UTF-8 कोड में बदला गया होना चाहिए. साथ ही, इसका साइज़ 240 बाइट से ज़्यादा नहीं होना चाहिए.
readAccessInherited

boolean

readWritePartnerId के सभी विज्ञापन देने वालों के पास, गारंटी वाले ऑर्डर को पढ़ने का ऐक्सेस है या नहीं. सिर्फ़ तब लागू होता है, जब readWritePartnerId सेट हो. सही होने पर, readAdvertiserIds को बदल देता है.
readAdvertiserIds[]

string (int64 format)

गारंटी वाले ऑर्डर के लिए, विज्ञापन देने वाले उन लोगों या कंपनियों के आईडी जिनके पास पढ़ने का ऐक्सेस है.

अगर यह फ़ील्ड सेट है, तो इसमें विज्ञापन देने वाला वह व्यक्ति शामिल नहीं होना चाहिए जिसे readWriteAdvertiserId को असाइन किया गया है. इस फ़ील्ड में मौजूद, विज्ञापन देने वाली सभी कंपनियां readWritePartnerId या readWriteAdvertiserId के पार्टनर से जुड़ी होनी चाहिए.
defaultAdvertiserId

string (int64 format)

सिर्फ़ आउटपुट के लिए. गारंटी वाले ऑर्डर के लिए, विज्ञापन देने वाले डिफ़ॉल्ट व्यक्ति का आईडी.

डिफ़ॉल्ट तौर पर, विज्ञापन देने वाला व्यक्ति या कंपनी readWriteAdvertiserId होती है. इसके अलावा, अगर इस नीति को सेट नहीं किया जाता है, तो readAdvertiserIds की सूची में सबसे पहले विज्ञापन देने वाला ऐसा व्यक्ति होगा जिसे विज्ञापन देने वाला डिफ़ॉल्ट व्यक्ति माना जाएगा. वरना, कोई डिफ़ॉल्ट विज्ञापनदाता नहीं है.
defaultCampaignId

string (int64 format)

डिफ़ॉल्ट कैंपेन का आईडी, जिसे 'किराया रिफ़ंड की गारंटी' के लिए असाइन किया गया है.

डिफ़ॉल्ट कैंपेन, विज्ञापन देने वाली डिफ़ॉल्ट कंपनी का होना चाहिए.

यूनियन फ़ील्ड read_write_accessor. ज़रूरी है.

गारंटी वाले ऑर्डर के लिए, पार्टनर या विज्ञापन देने वाले के पास पढ़ने/लिखने का ऐक्सेस होना चाहिए. read_write_accessor इनमें से सिर्फ़ एक हो सकती है:
readWritePartnerId

string (int64 format)

गारंटी वाले ऑर्डर के लिए, पढ़ने/लिखने का ऐक्सेस वाला पार्टनर.
readWriteAdvertiserId

string (int64 format)

गारंटी वाले ऑर्डर के लिए, विज्ञापन देने वाले व्यक्ति या कंपनी के पास पढ़ने/लिखने का ऐक्सेस होना चाहिए. यह गारंटी वाले ऑर्डर के लिए, विज्ञापन देने वाली डिफ़ॉल्ट कंपनी भी है.

GuaranteedOrderStatus

गारंटी वाले ऑर्डर की स्थिति की सेटिंग.

जेएसओएन के काेड में दिखाना 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
फ़ील्ड
entityStatus

enum (EntityStatus)

गारंटी वाला ऑर्डर लागू होगा या नहीं.

स्वीकार की जाने वाली वैल्यू ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, और ENTITY_STATUS_PAUSED हैं. डिफ़ॉल्ट वैल्यू ENTITY_STATUS_ACTIVE है.
entityPauseReason

string

गारंटी वाले इस ऑर्डर को रोकने के लिए उपयोगकर्ता की ओर से बताई गई वजह.

इसे UTF-8 कोड में बदला जाना चाहिए. साथ ही, इसकी लंबाई 100 बाइट से ज़्यादा नहीं होनी चाहिए.

सिर्फ़ तब लागू होता है, जब entityStatus को ENTITY_STATUS_PAUSED पर सेट किया गया हो.
configStatus

enum (GuaranteedOrderConfigStatus)

सिर्फ़ आउटपुट के लिए. गारंटी वाले ऑर्डर के कॉन्फ़िगरेशन की स्थिति.

स्वीकार की जाने वाली वैल्यू PENDING और COMPLETED हैं.

गारंटी वाले ऑर्डर को पेश करने से पहले कॉन्फ़िगर करना ज़रूरी है. इसमें ज़रूरी फ़ील्ड भरें, क्रिएटिव चुनें, और कोई डिफ़ॉल्ट कैंपेन चुनें. फ़िलहाल, कॉन्फ़िगरेशन से जुड़ी कार्रवाई सिर्फ़ यूज़र इंटरफ़ेस (यूआई) से की जा सकती है.

GuaranteedOrderConfigStatus

गारंटी वाले ऑर्डर के लिए कॉन्फ़िगरेशन की संभावित स्थितियां.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED इस वर्शन में, समीक्षा की स्थिति की जानकारी नहीं है या इसकी जानकारी नहीं है.
PENDING गारंटी वाले ऑर्डर की शुरुआती स्थिति. इस स्थिति में गारंटी वाले ऑर्डर को पेश करने से पहले, कॉन्फ़िगर करना ज़रूरी है.
COMPLETED खरीदार के गारंटी वाले ऑर्डर को कॉन्फ़िगर करने के बाद की स्थिति.

तरीके

create

 गारंटी वाला नया ऑर्डर बनाता है.

editGuaranteedOrderReadAccessors

 गारंटी वाले ऑर्डर में मौजूद बदलाव, विज्ञापन देने वाले लोगों या कंपनियों को ध्यान में रखकर तैयार किए जाते हैं.

get

 ऑर्डर की गारंटी मिलती है.

list

 गारंटी वाले ऑर्डर की सूची बनाता है, जिन्हें मौजूदा उपयोगकर्ता ऐक्सेस कर सकता है.

patch

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