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

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