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

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