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

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

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