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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
फ़ील्ड
name

string

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

string

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

enum (Exchange)

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

string

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

string

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

यह UTF-8 कोड में होना चाहिए और इसका साइज़ ज़्यादा से ज़्यादा 240 बाइट होना चाहिए.
status

object (GuaranteedOrderStatus)

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

string (Timestamp format)

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

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
publisherName

string

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

यह UTF-8 कोड में होना चाहिए और इसका साइज़ ज़्यादा से ज़्यादा 240 बाइट होना चाहिए.
readAccessInherited

boolean

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

string (int64 format)

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

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

string (int64 format)

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

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

string (int64 format)

गारंटी वाले ऑर्डर को असाइन किए गए डिफ़ॉल्ट कैंपेन का आईडी.

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

ज़रूरी है.

वह पार्टनर या विज्ञापन देने वाला व्यक्ति या कंपनी जिसके पास गारंटी वाले ऑर्डर के लिए, रीड/राइट ऐक्सेस है. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
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

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