REST Resource: guaranteedOrders

संसाधन: GuaranteedOrder

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

गारंटी वाले ऑर्डर, गारंटी वाले इन्वेंट्री सोर्स की पैरंट इकाई हैं. गारंटी वाला इन्वेंट्री सोर्स बनाते समय, गारंटी के साथ दिया गया ऑर्डर आईडी, इन्वेंट्री सोर्स को असाइन किया जाना चाहिए.

JSON के काेड में दिखाना 
{
  "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)

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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

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

JSON के काेड में दिखाना 
{
  "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

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