REST Resource: customBiddingAlgorithms

संसाधन: Custom BiddingAlgorithm

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

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

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
फ़ील्ड
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 की मदद से उसे हासिल किया जा रहा हो.
यूनियन फ़ील्ड owner. DV360 की उस इकाई की पहचान करता है जिसके पास कस्टम बिडिंग वाले एल्गोरिदम का मालिकाना हक है. यह कोई पार्टनर या विज्ञापन देने वाला हो सकता है. owner इनमें से सिर्फ़ एक हो सकती है:
partnerId

string (int64 format)

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

string (int64 format)

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

CustomBiddingAlgorithmType

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

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED इस वर्शन में, एल्गोरिदम के टाइप की जानकारी नहीं दी गई है या न ही इसकी जानकारी है.
SCRIPT_BASED ऐसा एल्गोरिदम जिसे ग्राहक की अपलोड की गई, कस्टम बिडिंग वाली स्क्रिप्ट फ़ाइलों से जनरेट किया गया है.
ADS_DATA_HUB_BASED Ads Data Hub प्रॉडक्ट का इस्तेमाल करके बनाया गया एल्गोरिदम.
GOAL_BUILDER_BASED DV3 यूज़र इंटरफ़ेस (यूआई) में लक्ष्य बिल्डर का इस्तेमाल करके बनाया गया एल्गोरिदम.

CustomBiddingModelDetails

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

जेएसओएन के काेड में दिखाना 
{
  "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 है.

SuspensionState

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

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

तरीके

create

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

get

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

list

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

patch

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

uploadScript

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