REST Resource: customBiddingAlgorithms

संसाधन: Custom BiddingAlgorithm

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

JSON के काेड में दिखाना 
{
  "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 यूज़र इंटरफ़ेस (यूआई) में लक्ष्य बिल्डर की मदद से बनाया गया एल्गोरिदम.
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 वाली स्थिति में स्विच हो जाएगा. साथ ही, विज्ञापन दिखाने वाला मॉडल फिर से तैयार करने में समय लगेगा.

तरीके

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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