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 यह तीसरे पक्ष की डेटा साइंस सेवा देने वाली कंपनी है. DV3 के पार्टनर/विज्ञापन देने वाले लोग या कंपनियां, इसके साथ पार्टनरशिप कर सकती हैं.
ADELAIDE तीसरे पक्ष की अटेंशन मेज़रमेंट सेवा देने वाली कंपनी, जिसके साथ DV3 पार्टनर/विज्ञापन देने वाले लोग या कंपनियां साझेदारी कर सकती हैं.

तरीके

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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