REST Resource: customBiddingAlgorithms

संसाधन: CustomBiddingAlgorithm

कस्टम बिडिंग का एक एल्गोरिदम.

JSON के काेड में दिखाना 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],
  "thirdPartyOptimizationPartner": enum (ThirdPartyOptimizationPartnerType),

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

string

सिर्फ़ आउटपुट के लिए. कस्टम बिडिंग वाले एल्गोरिदम का संसाधन नाम.
customBiddingAlgorithmId

string (int64 format)

सिर्फ़ आउटपुट के लिए. कस्टम बिडिंग एल्गोरिदम का यूनीक आईडी. सिस्टम की ओर से असाइन किया जाता है.
displayName

string

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

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

enum (EntityStatus)

इस नीति से यह कंट्रोल किया जाता है कि कस्टम बिडिंग एल्गोरिदम को बिडिंग की रणनीति के तौर पर इस्तेमाल किया जा सकता है या नहीं.

इन वैल्यू का इस्तेमाल किया जा सकता है:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

ज़रूरी है. इम्यूटेबल. कस्टम बिडिंग वाले एल्गोरिदम का टाइप.
sharedAdvertiserIds[]

string (int64 format)

विज्ञापन देने वाले उन लोगों या कंपनियों के आईडी जिनके पास इस एल्गोरिदम का ऐक्सेस है. अगर advertiserId सेट है, तो इस फ़ील्ड में सिर्फ़ वही वैल्यू होगी.

अगर एल्गोरिदम owner कोई पार्टनर है और उसे विज्ञापन देने वाले व्यक्ति या कंपनी accessor का इस्तेमाल करके वापस पाया जा रहा है, तो इस फ़ील्ड को सेट नहीं किया जाएगा.
modelDetails[]

object (CustomBiddingModelDetails)

सिर्फ़ आउटपुट के लिए. विज्ञापन देने वाले हर उस व्यक्ति या कंपनी के लिए कस्टम बिडिंग मॉडल की जानकारी जिसके पास ऐक्सेस है.

अगर एल्गोरिदम owner पार्टनर है और उसे विज्ञापन देने वाले व्यक्ति या कंपनी accessor का इस्तेमाल करके वापस पाया जा रहा है, तो इस फ़ील्ड में सिर्फ़ क्वेरी किए गए विज्ञापन देने वाले व्यक्ति या कंपनी की जानकारी शामिल हो सकती है.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

ज़रूरी नहीं. इम्यूटेबल. यह कुकी, तीसरे पक्ष के ऑप्टिमाइज़ेशन पार्टनर को तय करती है. यह पार्टनर इस एल्गोरिदम को मैनेज करता है.
यह DV360 की उस इकाई की पहचान करता है जिसके पास कस्टम बिडिंग एल्गोरिदम का मालिकाना हक है. यह पार्टनर या विज्ञापन देने वाला व्यक्ति या कंपनी हो सकती है. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
partnerId

string (int64 format)

इम्यूटेबल. कस्टम बिडिंग एल्गोरिदम के मालिक पार्टनर का यूनीक आईडी.
advertiserId

string (int64 format)

इम्यूटेबल. विज्ञापन देने वाले उस व्यक्ति या कंपनी का यूनीक आईडी जिसके पास कस्टम बिडिंग एल्गोरिदम का मालिकाना हक है.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

CustomBiddingAlgorithmType

कस्टम बिडिंग वाले एल्गोरिदम के संभावित टाइप.

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED इस वर्शन में एल्गोरिदम का टाइप नहीं बताया गया है या इसकी जानकारी मौजूद नहीं है.
SCRIPT_BASED यह एल्गोरिदम, ग्राहक की ओर से अपलोड की गई कस्टम बिडिंग स्क्रिप्ट फ़ाइलों से जनरेट किया जाता है.
RULE_BASED

यह एल्गोरिदम, तय किए गए नियमों पर आधारित होता है. इन नियमों को एपीआई में AlgorithmRules ऑब्जेक्ट का इस्तेमाल करके तय किया जाता है.

यह एल्गोरिदम टाइप, सिर्फ़ उन ग्राहकों के लिए उपलब्ध है जिन्हें अनुमति मिली है. इस तरह के कूपन का इस्तेमाल करने की कोशिश करने वाले अन्य खरीदारों को गड़बड़ी का मैसेज मिलेगा.

CustomBiddingModelDetails

विज्ञापन देने वाले किसी एक ऐसे व्यक्ति या कंपनी के लिए कस्टम बिडिंग एल्गोरिदम मॉडल की जानकारी जिसे शेयर किया गया है.

JSON के काेड में दिखाना 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
फ़ील्ड
advertiserId

string (int64 format)

विज्ञापन देने वाले व्यक्ति या कंपनी का यूनीक आईडी.
readinessState

enum (ReadinessState)

कस्टम बिडिंग मॉडल के तैयार होने की स्थिति.
suspensionState

enum (SuspensionState)

सिर्फ़ आउटपुट के लिए. कस्टम बिडिंग मॉडल के निलंबन की स्थिति.

ReadinessState

मॉडल के तैयार होने की संभावित स्थितियां.

Enums
READINESS_STATE_UNSPECIFIED इस वर्शन में राज्य की जानकारी नहीं दी गई है या इसके बारे में पता नहीं है.
READINESS_STATE_ACTIVE मॉडल को ट्रेन किया जा चुका है और अब इसका इस्तेमाल किया जा सकता है.
READINESS_STATE_INSUFFICIENT_DATA विज्ञापन दिखाने वाले मॉडल को ट्रेनिंग देने के लिए, ज़रूरत के मुताबिक डेटा उपलब्ध नहीं है.
READINESS_STATE_TRAINING मॉडल को ट्रेनिंग दी जा रही है और वह सेवा देने के लिए तैयार नहीं है.
READINESS_STATE_NO_VALID_SCRIPT कस्टम बिडिंग की कोई ऐसी मान्य स्क्रिप्ट नहीं दी गई है जिससे मॉडल को ट्रेन किया जा सके. यह स्थिति सिर्फ़ उन एल्गोरिदम पर लागू होगी जिनका customBiddingAlgorithmType SCRIPT_BASED है.
READINESS_STATE_EVALUATION_FAILURE मान्य स्क्रिप्ट दी गई थी, लेकिन उसका आकलन नहीं किया जा सका. यह उन स्क्रिप्ट पर लागू होता है जिनका आकलन तय समय में नहीं किया जा सका.

SuspensionState

कस्टम बिडिंग मॉडल के निलंबन की संभावित स्थितियां.

Enums
SUSPENSION_STATE_UNSPECIFIED इस वर्शन में राज्य की जानकारी नहीं दी गई है या इसके बारे में पता नहीं है.
SUSPENSION_STATE_ENABLED मॉडल चालू है. इसका इस्तेमाल हाल ही में किया गया है, फ़िलहाल किया जा रहा है या आने वाले समय में किया जाएगा. यह एल्गोरिदम, विज्ञापन देने वाले इस व्यक्ति या कंपनी के लिए इंप्रेशन को स्कोर कर रहा है.
SUSPENSION_STATE_DORMANT इस मॉडल का इस्तेमाल हाल ही में नहीं किया गया है. मॉडल अब भी ENABLED के तौर पर काम करता है. हालांकि, अगर इसका इस्तेमाल नहीं किया जाता है, तो इसे निलंबित कर दिया जाएगा.
SUSPENSION_STATE_SUSPENDED मॉडल को इंप्रेशन स्कोर करने से निलंबित कर दिया गया है. इसलिए, यह विज्ञापन नहीं दिखा सकता. अगर इस विज्ञापन देने वाले व्यक्ति या कंपनी के लिए, एल्गोरिदम को किसी लाइन आइटम को असाइन किया जाता है या उसे अपडेट किया जाता है, तो वह ENABLED स्टेट पर वापस चला जाएगा. साथ ही, विज्ञापन दिखाने के मॉडल को फिर से तैयार करने में समय लगेगा.

ThirdPartyOptimizationPartnerType

तीसरे पक्ष के ऑप्टिमाइज़ेशन पार्टनर के संभावित टाइप.

Enums
UNKNOWN इस वर्शन में टाइप की वैल्यू मौजूद नहीं है या इसकी जानकारी नहीं है.
SCIBIDS डेटा साइंस की सेवाएं देने वाली तीसरे पक्ष की कंपनी. DV360 पार्टनर/विज्ञापन देने वाले लोग या कंपनियां इसके साथ पार्टनरशिप कर सकती हैं.
ADELAIDE तीसरे पक्ष की ऐसी कंपनी जो ध्यान मेज़र करने की सेवा देती है. DV360 के पार्टनर/विज्ञापन देने वाले लोग या कंपनियां इसके साथ साझेदारी कर सकती हैं.

तरीके

create

 कस्टम बिडिंग वाला नया एल्गोरिदम बनाता है.

get

 कस्टम बिडिंग वाला एल्गोरिदम मिलता है.

list

 इस फ़ंक्शन से, कस्टम बिडिंग वाले उन एल्गोरिदम की सूची मिलती है जिन्हें मौजूदा उपयोगकर्ता ऐक्सेस कर सकता है. साथ ही, बिडिंग की रणनीतियों में इस्तेमाल कर सकता है.

patch

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

uploadRules

 यह फ़ंक्शन, AlgorithmRules फ़ाइल के लिए नियमों का रेफ़रंस ऑब्जेक्ट बनाता है.

uploadScript

 यह फ़ंक्शन, स्क्रिप्ट फ़ाइल के लिए कस्टम बिडिंग स्क्रिप्ट रेफ़रंस ऑब्जेक्ट बनाता है.