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

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

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